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

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateSAMLProvider

The operation that you want to perform. Set the value to UpdateSAMLProvider.

SAMLProviderName String Yes test-provider

The name of the IdP whose information you want to modify.

NewDescription String No This is a new provider.

The new description.

Note You must specify at least one of the NewDescription and NewEncodedSAMLMetadataDocument parameters.
NewEncodedSAMLMetadataDocument String No PD94bWwgdmVy****

The new metadata file.

Note You must specify at least one of the NewDescription and NewEncodedSAMLMetadataDocument parameters.

Response parameters

Parameter Type Example Description
RequestId String E5EDDFD2-3654-4F9F-9780-4AE7D81823EF

The ID of the request.

SAMLProvider Object

The information about the IdP.

UpdateDate String 2020-10-22T02:51:20Z

The point in time at which the information about the IdP was modified. The time is displayed in UTC.

Description String This is a new provider.

The description of the IdP.

SAMLProviderName String test-provider

The name of the IdP.

CreateDate String 2020-10-22T02:37:05Z

The point in time at which the IdP was created. The time is displayed in UTC.

Arn String acs:ram::177242285274****:saml-provider/test-provider

The Alibaba Cloud Resource Name (ARN) of the IdP.

Examples

Sample requests

https://[Endpoint]/?Action=UpdateSAMLProvider
&SAMLProviderName=test-provider
&NewDescription=This is a new provider.
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.