GetDirectorySAMLServiceProviderInfo - CloudSSO - Alibaba Cloud Documentation Center

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

Operation description

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****.

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
cloudsso:GetDirectorySAMLServiceProviderInfo	Read	Directory acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The ID of the directory.	d-00fc2p61****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	4632107D-BCE1-5A96-B30B-182EE0709625
SAMLServiceProvider	object	The information about the SP.
EntityId	string	The entity ID of the SP.	https://signin-cn-shanghai.alibabacloudsso.com/saml/sp/d-00fc2p61****
DirectoryId	string	The ID of the directory.	d-00fc2p61****
EncodedMetadataDocument	string	The metadata file of the SP. The value of this parameter is Base64-encoded.	PD94bWwgdmVyc2lv****
AcsUrl	string	The Assertion Consumer Service (ACS) URL of the SP.	https://signin-cn-shanghai.alibabacloudsso.com/saml/acs/51d298a9-2a3f-4e23-97c7-7ad1cfa9****

Examples

Sample success responses

JSONformat

{
  "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 Service error codes.

Change history

Change time

Summary of changes

Operation

2023-11-21

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.