Product Introduction

Overview

Concepts

Purchase Guide

Operation Guide

Console Overview

Organization Settings

Department Management

Member Account Management

Member Finance Management

Member Access Management

Resource Management

Member Audit

Identity Center Management

API Documentation

History

Introduction

API Category

Making API Requests

Organization Settings APIs

Department and Member Management APIs

ListOrganizationIdentity

Unified Member Login APIs

Organization Service Management APIs

Organization Management Policy APIs

Resource Sharing APIs

Identity Center Management APIs

Identity Center User Management APIs

Identity Center User Group Management APIs

Identity Center Management SCIM Synchronization APIs

Identity Center Single Sign-On Management APIs

Identity Center Permission Configuration Management APIs

Identity Center Multi-Account Authorization Management APIs

Identity Center Sub-User Synchronization Management APIs

Data Types

Error Codes

TCO API 2018-12-25

Related Agreement

Statement of Tencent Cloud Customers’ Tencent Cloud Organization

FAQs

Concept

Basic

Operation

Glossary

UpdateSCIMCredentialStatus

PDF

Focus Mode

Font Size

Last updated: 2026-03-20 00:29:13

1. API Description

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

This API is used to enable or disable 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: UpdateSCIMCredentialStatus.
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.
CredentialId	Yes	String	SCIM key ID, which starts with the scimcred- prefix, followed by 12 random digits/lowercase letters.
NewStatus	Yes	String	SCIM key status. Enabled: enabled. Disabled: disabled.

3. Output Parameters

Parameter Name	Type	Description
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 Modifying SCIM Key Status

This example shows you how to modify SCIM key status.

Input Example

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

{
    "ZoneId": "z-vft38p2hq8tq",
    "CredentialId": "scimcred-un1tgbnt0s9j",
    "NewStatus": "Disabled"
}

Output Example

{
    "Response": {
        "RequestId": "d0b5fffc-c7b9-4513-a080-8dfcf72c6e56"
    }
}

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.IdentityCenterNotOpen	The CIC service is not enabled.
FailedOperation.ZoneIdNotExist	The user zoneId of the CIC service does not exist.
InvalidParameter.ScimCredentialNotFound	SCIM key does not exist.
InvalidParameter.UserScimCredentialStatusError	SCIM key status error

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Tencent Cloud Organization