Modifying the Token Policy of an Account

Function

This API is used to modify the token policy of an account. The token policy controls whether tokens can be obtained for IAM users, agencies, and federated users under the account. (Unscoped tokens obtained through federated authentication are not affected).

Authorization Information

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

URI

PUT /v5/token-policy

Request Parameters

**Table 1** Request body parameters
Parameter	Mandatory	Type	Description
token_enabled	No	Boolean	Whether obtaining tokens is allowed. The default value is true. Setting this parameter to false forbids token obtaining for IAM users, agencies, and federated users under the account. (Unscoped tokens obtained through federated authentication are not affected.)

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
token_policy	TokenPolicy object	Token policy of an account.

**Table 3** TokenPolicy
Parameter	Type	Description
token_enabled	Boolean	Whether obtaining tokens is allowed. The default value is true. Setting this parameter to false forbids token obtaining for IAM users, agencies, and federated users under the account. (Unscoped tokens obtained through federated authentication are not affected.)

Status code: 400

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

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.
encoded_authorization_message	String	Encrypted authentication failure information, which can be decrypted using the STS5 decryption API.

Example Requests

Modifying the token policy of an account

PUT https://{endpoint}/v5/token-policy

{
  "token_enabled" : true
}

Example Responses

Status code: 200

Request succeeded.

{
  "token_policy" : {
    "token_enabled" : true
  }
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Abnormal request body.
403	Insufficient permissions.

Error Codes

See Error Codes.

Parent topic: Configuring Security Settings

Previous topic: Querying the Token Policy of an Account

Next topic: Querying the Account Password Policy

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

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

Chatbot