Updated on 2026-09-23 GMT+08:00

Querying the List of Service-specific Credentials

Function

This API is used to query the list of service-specific credentials.

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:serviceSpecificCredentials:listV5

List

user *

-

-

-

URI

GET /v5/service-specific-credentials

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

user_id

No

String

Definition

IAM user ID.

Constraints

The user ID must exist and be valid.

Range

The value contains 1 to 64 characters and must comply with the regular expression ^[a-zA-Z0-9-]{1,64}$.

Default Value

N/A

service_name

No

String

Definition

Service name specified to show corresponding credentials.

Constraints

N/A

Range

The value contains 1 to 64 characters and must comply with the regular expression ^[a-zA-Z]{1,64}$.

Default Value

N/A

limit

No

Integer

Definition:

Number of records displayed per page.

Constraints:

N/A

Range:

The value ranges from 1 to 200.

Default Value:

The default value is 100.

marker

No

String

Definition

Pagination marker automatically generated by the service to mark the start position of this request. The value can be obtained from next_marker in the response body of the previous pagination request.

Constraints

N/A

Range

The value contains 4 to 400 characters, including only letters, digits, and the following special characters: +/=-_

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Language

No

String

Definition:

Language of the returned results.

Constraints:

N/A

Range:

Chinese ("zh-cn") or English ("en-us").

Default Value:

The default value is zh-cn.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

service_specific_credentials

Array of service_specific_credentials objects

Definition

List of service-specific credentials.

Range

N/A

page_info

page_info object

Definition

Pagination information.

Range

N/A

Table 4 service_specific_credentials

Parameter

Type

Description

created_at

String

Definition

Creation date and time, in the ISO 8601 format.

Range

N/A

service_name

String

Definition

Name of the associated service.

Range

The value contains 1 to 64 characters and must comply with the regular expression ^[a-zA-Z]{1,64}$.

credential_id

String

Definition

Credential ID.

Range

The value is fixed at 20 characters in the format of HSSC followed by 16 random characters. Only letters and digits are allowed.

status

String

Definition

Credential status.

Range

The value can be active, inactive, or expired.

user_id

String

Definition

ID of the IAM user associated with a service-specific credential.

Range

N/A

user_name

String

Definition

Name of the associated IAM user.

Range

N/A

expires_at

String

Definition

Expiration date and time. This parameter is returned only when credential_age_days is specified.

Range

N/A

credential_mask

String

Definition

Mask value of the credential.

Range

The value contains less than 32 characters and must comply with the regular expression ^[a-zA-Z0-9_-]+*{6}[a-zA-Z0-9_-]+$.

description

String

Definition

Credential description.

Range

The value contains 0 to 255 characters and must comply with the regular expression ^[^@#%&<>\$^*]*$.

Table 5 page_info

Parameter

Type

Description

next_marker

String

Definition

Start position marker for the next pagination invoking, which is automatically generated by the service.

Range

N/A

current_count

Integer

Definition

Number of records returned on this page.

Range

N/A

Status code: 400

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

Status code: 403

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

Status code: 404

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

Example Requests

None

Example Responses

Status code: 200

{
  "service_specific_credentials" : [ {
    "created_at" : "2026-07-28T11:34:57.812Z",
    "service_name" : "string",
    "credential_id" : "string",
    "status" : "string",
    "user_id" : "stringstringstringstringstringstringstringstringstringstringstri",
    "user_name" : "string",
    "expires_at" : "2026-07-28T11:34:57.812Z",
    "credential_mask" : "string******string",
    "description" : "string"
  } ],
  "page_info" : {
    "next_marker" : "string",
    "current_count" : 1
  }
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Abnormal request body.

403

No operation permissions.

404

IAM user not found or the service does not support service-specific credentials.

Error Codes

See Error Codes.