Help Center/ Identity and Access Management_Identity and Access Management (New Edition)/ API Reference/ API/ IAM/ Managing Account Functions/ Obtaining the Asymmetric Signature Switch Status of an Account
Updated on 2025-11-06 GMT+08:00
View PDF
Share

Obtaining the Asymmetric Signature Switch Status of an Account

Function

This API is used to obtain the asymmetric signature switch status of 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::getAsymmetricSignatureSwitchV5

Read

-

-

-

-

URI

GET /v5/asymmetric-signature-switch

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

asymmetric_signature

AsymmetricSignatureWithDomainId object

Asymmetric signature switch of an account.
Table 2 AsymmetricSignatureWithDomainId

Parameter

Type

Description

domain_id

String

Account ID.

asymmetric_signature_switch

Boolean

Asymmetric signature switch.

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

Obtaining the asymmetric signature switch status of an account

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

Example Responses

Status code: 200

Successful

{
  "asymmetric_signature" : {
    "asymmetric_signature_switch" : true,
    "domain_id" : "xxxxx"
  }
}

Status Codes

Status Code

Description

200

Successful

403

Forbidden

Error Codes

See Error Codes.