To send a CloudSSO API request, you must send an HTTPS GET or HTTPS POST request to the CloudSSO endpoint. You must add the request parameters that correspond to the API operation being called. After you call the API, the system returns a response. The request and response are encoded in UTF-8.

Request structure

CloudSSO API operations use the RPC protocol. You can call CloudSSO API operations by sending HTTPS GET or HTTPS POST requests.

The request syntax is as follows:
https://Endpoint/?Action=xx&Parameters
where:
  • Endpoint

    The endpoint of the CloudSSO API is cloudsso.<RegionID>.aliyuncs.com.

    The IDs of supported region are cn-shanghai and us-west-1.

  • Action

    The name of the operation being performed. For example, to query information about a CloudSSO directory, you must set Action to GetDirectory.

  • Parameters

    The request parameters for the operation. Separate multiple parameters with ampersands (&).

    Request parameters include both common parameters and operation-specific parameters. Common parameters include information such as the API version number and authentication information. For more information, see Common parameters.

The following example demonstrates how to call the GetDirectory operation to query information about a CloudSSO directory.
Note API requests are presented in the following easy-to-read format in this document.
https://cloudsso.cn-shanghai.aliyuncs.com/?Action=GetDirectory
&SignatureVersion=1.0
&Format=JSON
&DirectoryId=d-00fc2p61****
&SignatureNonce=b9a72f1d-24ef-4ae1-9fb3-74693dd14d6a163653898054****
&Version=2021-05-15
&AccessKeyId=LTAI4GKg8NUNuWNpXufZ****
&Signature=5ysyiCp%2BM1VGs%2BMKDuHT2JGx****
&SignatureMethod=HMAC-SHA1
&Timestamp=2021-11-01T12:00:00Z