Queries information about a Security Assertion Markup Language (SAML) service provider (SP).

Usage notes

During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an identity provider (IdP).

This topic provides an example on how to query the information about the SP within the directory d-00fc2p61****.

Limits

You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

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 GetDirectorySAMLServiceProviderInfo

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

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String 4632107D-BCE1-5A96-B30B-182EE0709625

The ID of the request.

SAMLServiceProvider Object

The information about the SP.

EntityId String https://signin-cn-shanghai.alibabacloudsso.com/saml/sp/d-00fc2p61****

The entity ID of the SP.

DirectoryId String d-00fc2p61****

The ID of the directory.

EncodedMetadataDocument String PD94bWwgdmVyc2lv****

The metadata file of the SP. The value of this parameter is Base64-encoded.

AcsUrl String https://signin-cn-shanghai.alibabacloudsso.com/saml/acs/51d298a9-2a3f-4e23-97c7-7ad1cfa9****

The Assertion Consumer Service (ACS) URL of the SP.

Examples

Sample requests

https://[Endpoint]/?Action=GetDirectorySAMLServiceProviderInfo
&DirectoryId=d-00fc2p61****
&<Common request parameters>

Sample success responses

XML format

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

<GetDirectorySAMLServiceProviderInfoResponse>
    <RequestId>4632107D-BCE1-5A96-B30B-182EE0709625</RequestId>
    <SAMLServiceProvider>
        <EntityId>https://signin-cn-shanghai.alibabacloudsso.com/saml/sp/d-00fc2p61****</EntityId>
        <DirectoryId>d-00fc2p61****</DirectoryId>
        <EncodedMetadataDocument>PD94bWwgdmVyc2lv****</EncodedMetadataDocument>
        <AcsUrl>https://signin-cn-shanghai.alibabacloudsso.com/saml/acs/51d298a9-2a3f-4e23-97c7-7ad1cfa9****</AcsUrl>
    </SAMLServiceProvider>
</GetDirectorySAMLServiceProviderInfoResponse>

JSON format

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

{
  "RequestId" : "4632107D-BCE1-5A96-B30B-182EE0709625",
  "SAMLServiceProvider" : {
    "EntityId" : "https://signin-cn-shanghai.alibabacloudsso.com/saml/sp/d-00fc2p61****",
    "DirectoryId" : "d-00fc2p61****",
    "EncodedMetadataDocument" : "PD94bWwgdmVyc2lv****",
    "AcsUrl" : "https://signin-cn-shanghai.alibabacloudsso.com/saml/acs/51d298a9-2a3f-4e23-97c7-7ad1cfa9****"
  }
}

Error codes

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