CreateSCIMCredential

フォーカスモード

フォントサイズ

最終更新日: 2026-03-20 00:29:15

1. API Description

Domain name for API request: organization.intl.tencentcloudapi.com.

This API is used to create a SCIM key.

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 Params. The value used for this API: CreateSCIMCredential.
Version	Yes	String	Common Params. The value used for this API: 2021-03-31.
Region	No	String	Common Params. This parameter is not required.
ZoneId	Yes	String	Space ID, which starts with the z- prefix, followed by 12 random digits/lowercase letters.
ExpireDuration	No	Integer	Expiration time (in seconds), with a minimum value of 1 hour and a maximum value of 99 years. if not provided, it expires in 1 year by default.

3. Output Parameters

Parameter Name	Type	Description
ZoneId	String	Space ID, which starts with the z- prefix, followed by 12 random digits/lowercase letters.
CredentialId	String	SCIM key ID, which starts with the scimcred- prefix, followed by 12 random digits/lowercase letters.
CredentialType	String	SCIM key type.
CreateTime	String	Creation time of a SCIM key.
ExpireTime	String	Expiration time of a SCIM key.
CredentialStatus	String	SCIM key status. Enabled: enabled. Disabled: disabled.
CredentialSecret	String	SCIM key.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating a SCIM Key

This example shows you how to create a SCIM key.

Input Example

POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSCIMCredential
<Common request parameters>

{
    "ZoneId": "z-vft38p2hq8tq"
}

Output Example

{
    "Response": {
        "CreateTime": "2024-05-31 15:04:53",
        "CredentialId": "scimcred-un1tgbnt0s9j",
        "CredentialSecret": "YlBKbEhkYXI2cy9xOEFjSyj**************PJlcOtCKFiNoHOc5EZox3ZKEVqo2CUA=",
        "CredentialStatus": "Enabled",
        "CredentialType": "BearerToken",
        "ExpireTime": "2025-05-31 15:04:53",
        "RequestId": "b835edd6-8ac0-4e79-9b78-917d3faff9ed",
        "ZoneId": "z-vft38p2hq8tq"
    }
}

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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
FailedOperation.DBOperationError	SQL execution error.
FailedOperation.ScimCredentialGenerateError	Failed to generate the SCIM key.
LimitExceeded.ScimCredentialLimitExceeded	The number of SCIM keys exceeds the limit.

ヘルプとサポート

この記事はお役に立ちましたか？

営業担当者にお問い合わせいただくかチケットを提出してサポートを求めることができます。

フィードバック

tencent cloud

Tencent Cloud Organization