Listing External Identity Provider Certificates
Function
This API is used to list external identity provider certificates. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.
URI
GET /v1/identity-stores/{identity_store_id}/external-idp/{idp_id}/certificate
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
identity_store_id |
Yes |
String |
Globally unique ID of an identity source. |
idp_id |
Yes |
String |
Globally unique ID of an external identity provider. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Security-Token |
No |
String |
Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
idp_certificates |
Array of IdpCertificate objects |
List of external identity provider certificates. |
Parameter |
Type |
Description |
---|---|---|
certificate_id |
String |
Globally unique ID of a certificate. |
issuer_name |
String |
Issuer of an identity provider. |
not_after |
Number |
Certificate validity period. |
not_before |
Number |
Certificate validity period. |
public_key |
String |
Certificate public key. |
serial_number |
Number |
Certificate SN. |
serial_number_string |
String |
Certificate SN text. |
signature_algorithm_name |
String |
Signature algorithm. |
subject_name |
String |
Subject. |
version |
Number |
Version. |
x509_Certificate_in_pem |
String |
X.509 certificate. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
request_id |
String |
Unique ID of a request. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
request_id |
String |
Unique ID of a request. |
encoded_authorization_message |
String |
Encrypted error message. |
Example Request
Listing external identity provider certificates
GET https://{hostname}/v1/identity-stores/{identity_store_id}/external-idp/{idp_id}/certificate
Example Response
Status code: 200
Successful
{ "idp_certificates" : [ { "certificate_id" : "47e2272e-7dc9-4dd0-880b-9exxxxxx", "issuer_name" : "CN=Microsoft Azure Federated SSO Certificate", "not_after" : 1799587006000, "not_before" : 1704892606000, "public_key" : "your public key", "serial_number" : 1.0778418080746175E38, "serial_number_string" : "107784180807461748442456173960326386288", "signature_algorithm_name" : "SHA256withRSA", "subject_name" : "CN=Microsoft Azure Federated SSO Certificate", "version" : 3, "x509_Certificate_in_pem" : "X509 Certificate" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Successful. |
400 |
Bad request. |
403 |
Forbidden. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot