UpdateSAMLProvider - Resource Access Management - Alibaba Cloud Documentation Center

Modifies information about an identity provider (IdP) for role-based SSO.

Operation description

This topic provides an example on how to change the description of an IdP named test-provider to This is a new provider.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ram:UpdateSAMLProvider	Write	SAMLProvider acs:ram::{#accountId}:saml-provider/{#SAMLProviderName}	none	none

Request parameters

Parameter	Type	Required	Description	Example
SAMLProviderName	string	Yes	The name of the IdP whose information you want to modify.	test-provider
NewDescription	string	No	The new description. Note You must specify at least one of the `NewDescription` and `NewEncodedSAMLMetadataDocument` parameters.	This is a new provider.
NewEncodedSAMLMetadataDocument	string	No	The new metadata file. Note You must specify at least one of the `NewDescription` and `NewEncodedSAMLMetadataDocument` parameters.	PD94bWwgdmVy****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	E5EDDFD2-3654-4F9F-9780-4AE7D81823EF
SAMLProvider	object	The information about the IdP.
UpdateDate	string	The point in time at which the information about the IdP was modified. The time is displayed in UTC.	2020-10-22T02:51:20Z
Description	string	The description of the IdP.	This is a new provider.
SAMLProviderName	string	The name of the IdP.	test-provider
CreateDate	string	The point in time at which the IdP was created. The time is displayed in UTC.	2020-10-22T02:37:05Z
Arn	string	The Alibaba Cloud Resource Name (ARN) of the IdP.	acs:ram::177242285274****:saml-provider/test-provider

Examples

Sample success responses

JSONformat

{
  "RequestId": "E5EDDFD2-3654-4F9F-9780-4AE7D81823EF",
  "SAMLProvider": {
    "UpdateDate": "2020-10-22T02:51:20Z",
    "Description": "This is a new provider.",
    "SAMLProviderName": "test-provider",
    "CreateDate": "2020-10-22T02:37:05Z",
    "Arn": "acs:ram::177242285274****:saml-provider/test-provider"
  }
}

Error codes

For a list of error codes, visit the Service error codes.