Last updated: 2021-06-08 16:17:30

    1. API Description

    Domain name for API request:

    This API is used to query SAML identity provider details.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: GetSAMLProvider.
    Version Yes String Common parameter. The value used for this API: 2019-01-16.
    Region No String Common parameter. This parameter is not required for this API.
    Name Yes String SAML identity provider name

    3. Output Parameters

    Parameter Name Type Description
    Name String SAML identity provider name
    Description String SAML identity provider description
    CreateTime Timestamp Time SAML identity provider created
    ModifyTime Timestamp Time SAML identity provider last modified
    SAMLMetadata String SAML identity provider metadata document
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying IdP details

    This example shows you how to query the details of an IdP.

    Input Example

    &<Common request parameters>

    Output Example

    "Response": {
      "Name": "okta",
      "Description": "okta",
      "CreateTime": "2018-09-17 17:18:03",
      "ModifyTime": "2018-09-17 17:18:03",
      "SAMLMetadata": "U0FNTE1ldGFkYXRh"

    5. Developer Resources


    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    ResourceNotFound.IdentityNotExist Identity provider does not exist.
    ResourceNotFound.NotFound Resource does not exist.