Help Center/ Identity and Access Management_Identity and Access Management (New Edition)/ API Reference/ API/ IAM/ Managing Account Functions/ Enabling or Disabling the Asymmetric Signature for an Account
Updated on 2026-07-22 GMT+08:00
View PDF
Share

Enabling or Disabling the Asymmetric Signature for an Account

Function

This API is used to enable or disable the asymmetric signature for an account.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

iam::setAsymmetricSignatureSwitchV5

Write

-

-

-

-

URI

PUT /v5/asymmetric-signature-switch

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

asymmetric_signature

Yes

AsymmetricSignature object

Definition:

Whether to enable the asymmetric signature function for an account.

Constraints:

N/A

Range:

N/A

Default Value:

N/A
Table 2 AsymmetricSignature

Parameter

Mandatory

Type

Description

asymmetric_signature_switch

Yes

Boolean

Definition:

Asymmetric signature switch.

Constraints:

N/A

Range:

The value can be true or false.

Default Value:

N/A

Response Parameters

Status code: 204

Successful

Status code: 403

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Definition :

Error code. For details, see Error Code.

Range:

The format is PAP5.XXXX, for example, PAP5.0012.

error_msg

String

Definition :

Error message. For details, see Error Message.

Range:

N/A.

request_id

String

Definition:

Unique identifier of an API request, which is used to locate API calling exceptions.

Range:

N/A

encoded_authorization_message

String

Definition :

Encrypted details returned when the authentication fails, which are used to locate authentication problems. The STS5 decryption API can be used for decryption. For details, see API link.

Range:

N/A.

Example Requests

Enabling the asymmetric signature for an account

PUT https://{endpoint}/v5/asymmetric-signature-switch

{
  "asymmetric_signature" : {
    "asymmetric_signature_switch" : true
  }
}

Example Responses

None

Status Codes

Status Code

Description

204

Successful

403

Forbidden

Error Codes

See Error Codes.