Obtaining Tenant Settings

This API is used to obtain tenant settings.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

No identity policy-based permission required for calling this API.

GET https://{hostURL}/v4/tenant/setting

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
project_id	No	String	Definition You can call the API used to query project list to query the project list to obtain the unique 32-character UUID of the project. Constraints When the project_id parameter is transferred, the settings for the tenant who is the project owner are queried. Range A string that can contain 32 characters.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range A string that can contain 1 to 100,000 characters. Default Value N/A

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
default_encryption_enabled	Boolean	Definition Whether the default encryption function of the repository is enabled.
encryption_type	String	Definition Encryption type set by the tenant. Range KMS, normal, or null. If the value is KMS, KMS encryption is enabled.
permit_public	String	Definition Whether public access is allowed. Range allow: Allow. deny: Reject.

Status code: 401

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

GET https://{endpoint}/v4/tenant/setting

Status code: 200

{
  "default_encryption_enabled" : true,
  "encryption_type" : "KMS",
  "permit_public" : "allow"
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "DEV-23-50804",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Parent topic: Tenant

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.