Help Center/ Data Encryption Workshop/ API Reference/ APIs/ Secret Management APIs/ Secret Detection Management/ Obtaining the Tenant Secret Detection Configuration
Updated on 2025-10-16 GMT+08:00
View PDF
Share

Obtaining the Tenant Secret Detection Configuration

Function

This API is used to obtain the secret detection configuration of a tenant. It is used only in the secret vault scenario.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/secrets/checker/config

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

checking_secret_strength

Boolean

Whether secret strength detection is enabled.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Response body of the tenant secret detection configuration.

400

Invalid request parameter.

500

Internal server error.

Error Codes

See Error Codes.

Parent Topic: Secret Detection Management