GetSAMLProvider

Last updated: 2019-09-09 21:43:44

1. API Description

API domain name: cam.tencentcloudapi.com.

Query SAML identity provider details

Default API request rate limit: 20 requests/sec.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the name of this API: GetSAMLProvider
Version Yes String Common parameter; the version of this API: 2019-01-16
Region No String Common parameter; optional for this API.
Name Yes String SAML identity provider name

3. Output Parameters

Parameter name Type Description
Name String Name of the SAML identity provider
Description String Description of the SAML identity provider
CreateTime Timestamp Creation time of the SAML identity provider
ModifyTime Timestamp Last modified time of the SAML identity provider
SAMLMetadata String Metadata document of the SAML identity provider
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Sample

Sample 1. Querying SAML Identity Provider Details

Query identity provider details

Input Sample Code

https://cam.tencentcloudapi.com/?Action=GetSAMLProvider
&Name=okta
&<Common request parameter>

Output Sample Code

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

5. Developer Resources

API Explorer

This tool provides various capabilities such as online call, signature verification, SDK code generation, and quick API retrieval that significantly reduce the difficulty of using TencentCloud API.

SDK

TencentCloud API 3.0 integrates software development toolkits (SDKs) that support various programming languages to make it easier for you to call the APIs.

TCCLI

6. Error Codes

The following error codes are API business logic-related. For other error codes, see Common Error Codes.

Error Code Description
ResourceNotFound.IdentityNotExist The identity provider does not exist.
ResourceNotFound.NotFound The resource does not exist.