SAML Application API, gRPC: ApplicationService.Update
Updates the specified SAML application.
gRPC request
rpc Update (UpdateApplicationRequest) returns (operation.Operation)
UpdateApplicationRequest
{
"application_id": "string",
"update_mask": "google.protobuf.FieldMask",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"service_provider": {
"entity_id": "string",
"acs_urls": [
{
"url": "string",
"index": "google.protobuf.Int64Value"
}
],
"slo_urls": [
{
"url": "string",
"response_url": "string",
"protocol_binding": "ProtocolBinding"
}
]
},
"security_settings": {
"signature_mode": "SignatureMode",
"signature_certificate_id": "string"
},
"attribute_mapping": {
"name_id": {
"format": "Format",
"value": "string"
},
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"group_claims_settings": {
"group_distribution_type": "GroupDistributionType",
"group_attribute_name": "string"
}
}
Request to update an existing SAML application.
|
Field |
Description |
|
application_id |
string Required field. ID of the SAML application to update. The maximum string length in characters is 50. |
|
update_mask |
Field mask that specifies which fields of the application are going to be updated. |
|
name |
string New name for the SAML application. Value must match the regular expression |
|
description |
string New description for the SAML application. The maximum string length in characters is 256. |
|
labels |
object (map<string, string>) New resource labels as The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression |
|
service_provider |
New service provider configuration for the SAML application. |
|
security_settings |
New security settings for the SAML application. |
|
attribute_mapping |
New attribute mapping configuration for the SAML application. |
|
group_claims_settings |
New group claims settings for the SAML application. |
ServiceProvider
Service provider configuration for SAML applications.
|
Field |
Description |
|
entity_id |
string Required field. Service provider entity ID. The maximum string length in characters is 8000. |
|
acs_urls[] |
Assertion Consumer Service URLs. The number of elements must be in the range 1-100. |
|
slo_urls[] |
Single Logout Service URLs. The number of elements must be in the range 0-100. |
AssertionConsumerServiceURL
Assertion Consumer Service URL configuration.
|
Field |
Description |
|
url |
string Required field. The URL where SAML responses are sent. The maximum string length in characters is 8000. |
|
index |
Optional index for the assertion consumer service. |
SingleLogoutServiceURL
Single Logout Service URL configuration.
|
Field |
Description |
|
url |
string Required field. The URL where logout requests are sent. The maximum string length in characters is 8000. |
|
response_url |
string Optional separate URL for logout responses. The maximum string length in characters is 8000. |
|
protocol_binding |
enum ProtocolBinding Required field. Protocol binding supported by the logout endpoint.
|
SecuritySettings
Security settings for SAML applications.
|
Field |
Description |
|
signature_mode |
enum SignatureMode Signature mode for SAML messages.
|
|
signature_certificate_id |
string ID of the signature certificate to use. |
AttributeMappingSpec
Attribute mapping specification for SAML application.
|
Field |
Description |
|
name_id |
Required field. NameID configuration. |
|
attributes[] |
List of attribute mappings. The maximum number of elements is 50. |
NameIdSpec
NameID specification for SAML application.
|
Field |
Description |
|
format |
enum Format Required field. Format of the NameID.
|
|
value |
string Value of the NameID. The maximum string length in characters is 50. |
Attribute
Attribute mapping for SAML applications.
|
Field |
Description |
|
name |
string Required field. Name of the SAML attribute. The maximum string length in characters is 8000. |
|
value |
string Required field. Value of the SAML attribute. The maximum string length in characters is 50. |
GroupClaimsSettings
Group claims settings for SAML applications.
|
Field |
Description |
|
group_distribution_type |
enum GroupDistributionType Distribution type for group claims.
|
|
group_attribute_name |
string Name of the SAML attribute that contains group information. The maximum string length in characters is 8000. |
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": "google.protobuf.Any",
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": "google.protobuf.Any"
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |