All Products
Search
Document Center

Resource Access Management:GetSAMLProvider

Last Updated:May 08, 2024

Queries the information about an identity provider (IdP) for role-based single sign-on (SSO).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ram:GetSAMLProviderRead
  • SAMLProvider
    acs:ram::{#accountId}:saml-provider/{#SAMLProviderName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SAMLProviderNamestringYes

The name of the IdP.

test-provider

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

BAADB995-0C7A-476D-B293-7E94568EEDFB
SAMLProviderobject

The information about the IdP.

Descriptionstring

The description.

This is a provider.
UpdateDatestring

The update time.

2020-10-22T02:51:20Z
SAMLProviderNamestring

The name of the IdP.

test-provider
CreateDatestring

The creation time.

2020-10-22T02:37:05Z
EncodedSAMLMetadataDocumentstring

The metadata file, which is Base64 encoded.

PD94bWwgdmVy****
Arnstring

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

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

Examples

Sample success responses

JSONformat

{
  "RequestId": "BAADB995-0C7A-476D-B293-7E94568EEDFB",
  "SAMLProvider": {
    "Description": "This is a provider.",
    "UpdateDate": "2020-10-22T02:51:20Z",
    "SAMLProviderName": "test-provider",
    "CreateDate": "2020-10-22T02:37:05Z",
    "EncodedSAMLMetadataDocument": "PD94bWwgdmVy****",
    "Arn": "acs:ram::177242285274****:saml-provider/test-provider"
  }
}

Error codes

For a list of error codes, visit the Service error codes.