You can call this operation to query the single sign-on (SSO) status of Active Directory (AD) directories.

Description

This operation is supported only on AD directories, not on RAM directories.

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 GetDirectorySsoStatus

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

DirectoryId String Yes cn-hangzhou+dir-h95efs1mbukd9****

The ID of the AD directory.

RegionId String Yes cn-hangzhou

The region ID of the AD directory.

Response parameters

Parameter Type Example Description
RequestId String 883BA65B-015A-4CE2-9075-B706CC34CD0F

The ID of the request.

SsoStatus Boolean false

Indicates whether SSO is enabled. Valid values:

  • true: SSO is enabled.
  • false: SSO is disabled.

Examples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=GetDirectorySsoStatus
&DirectoryId=cn-hangzhou+dir-h95efs1mbukd9****
&RegionId=cn-hangzhou&
<Common request parameters>

Sample success responses

XML format

<GetDirectorySsoStatusResponse>
      <RequestId>883BA65B-015A-4CE2-9075-B706CC34CD0F</RequestId>
      <SsoStatus>false</SsoStatus>
</GetDirectorySsoStatusResponse>

JSON format

{
    "RequestId": "883BA65B-015A-4CE2-9075-B706CC34CD0F",
    "SsoStatus": false
}

Error codes

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