List SAML IdP Certificates in CloudSSO - CloudSSO - Alibaba Cloud - CloudSSO

Operation description

The following example queries the SAML signing certificates in the directory d-00fc2p61****. The response shows that the directory contains one SAML signing certificate.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cloudsso:ListExternalSAMLIdPCertificates

list

*Directory

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	400979BC-92EC-58B9-B47C-6913BD56A6FD
TotalCounts	integer	The total number of entries returned.	1
SAMLIdPCertificates	array<object>	The SAML signing certificates.
	object	The SAML signing certificate.
SerialNumber	string	The serial number of the certificate.	159289587****
Issuer	string	The issuer of the certificate.	1.2.840.113549.1.9.1=#160d696e666f406f6b74612e63****,CN=dev-xxxxxx,OU=SSOProvider,O=Okta,L=San Francisco,ST=California,C=US
Version	integer	The version of the certificate.	3
CertificateId	string	The ID of the certificate.	idp-c-00dt9gnl7fmjaw9c****
PublicKey	string	The Base64-encoded public key certificate in PEM format.	MIIBIjANBgkqhkiG****
SignatureAlgorithm	string	The signature algorithm of the certificate.	SHA256withRSA
NotAfter	string	The time when the certificate expires.	2030-06-23T07:04:37Z
NotBefore	string	The time when the certificate was created.	2020-06-23T07:03:37Z
Subject	string	The subject of the certificate.	1.2.840.113549.1.9.1=#160d696e666f406f6b74612e63****,CN=dev-xxxxxx,OU=SSOProvider,O=Okta,L=San Francisco,ST=California,C=US
X509Certificate	string	The X.509 certificate in the PEM format.	MIIDpDCCAoygAwIBAgIG****

Examples

Success response

JSON format

{
  "RequestId": "400979BC-92EC-58B9-B47C-6913BD56A6FD",
  "TotalCounts": 1,
  "SAMLIdPCertificates": [
    {
      "SerialNumber": "159289587****",
      "Issuer": "1.2.840.113549.1.9.1=#160d696e666f406f6b74612e63****,CN=dev-xxxxxx,OU=SSOProvider,O=Okta,L=San Francisco,ST=California,C=US",
      "Version": 3,
      "CertificateId": "idp-c-00dt9gnl7fmjaw9c****",
      "PublicKey": "MIIBIjANBgkqhkiG****",
      "SignatureAlgorithm": "SHA256withRSA",
      "NotAfter": "2030-06-23T07:04:37Z",
      "NotBefore": "2020-06-23T07:03:37Z",
      "Subject": "1.2.840.113549.1.9.1=#160d696e666f406f6b74612e63****,CN=dev-xxxxxx,OU=SSOProvider,O=Okta,L=San Francisco,ST=California,C=US",
      "X509Certificate": "MIIDpDCCAoygAwIBAgIG****"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.