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 2025-11-06 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 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

Whether the asymmetric signature is enabled for an account.
Table 2 AsymmetricSignature

Parameter

Mandatory

Type

Description

asymmetric_signature_switch

Yes

Boolean

Asymmetric signature switch.

Response Parameters

Status code: 204

Successful

Status code: 403

Table 3 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

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.