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

Updating a Service-specific Credential

Function

This API is used to update the status or description of a service-specific credential.

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:updateV5	Write	user *	g:ResourceTag/<tag-key> iam:ResourceIsRootUser	-	-
iam:serviceSpecificCredentials:updateV5	Write	-	iam:ServiceSpecificCredentialServiceName	-	-

URI

PUT /v5/users/{user_id}/service-specific-credentials/{credential_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
user_id	Yes	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
credential_id	Yes	String	Definition ID of a service-specific credential. Constraints N/A Range The value is fixed at 20 characters in the format of HSSC followed by 16 random characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
status	No	String	Definition Credential status. You cannot manually set the status to expired. (The system automatically sets the status to expired when a credential expires.) Specify either status or description. Constraints N/A Range The value can be active or inactive. Default Value N/A
description	No	String	Definition Description of the credential to be set. Specify either status or description. Constraints N/A Range The value contains 0 to 255 characters and must comply with the regular expression ^[^@#%&<>\$^]$. Default Value N/A

Response Parameters

Status code: 200

None

Status code: 400

**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

Status code: 403

**Table 4** 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 5** 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

Updating a service-specific credential

PUT https://{endpoint}/users/{user_id}/service-specific-credentials/{credential_id}

{
  "status" : "active",
  "description" : "string",
  "user_name" : "string"
}

Example Responses

None

Status Codes

Status Code	Description
200	Request succeeded.
400	Abnormal request body.
403	No operation permissions.
404	IAM user or credential not found.

Error Codes

See Error Codes.

Parent topic: Service-specific Credential Management