更新服务专属凭证 - UpdateServiceSpecificCredentialV5
功能介绍
该接口可以用于更新服务专属凭证的状态或描述。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
PUT /v5/users/{user_id}/service-specific-credentials/{credential_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| user_id | 是 | String | 参数解释: IAM用户ID。 约束限制: 用户ID需要真实存在且有效。 取值范围: 取值范围为[1,64],正则符合^[a-zA-Z0-9-]{1,64}$ 默认取值: 不涉及。 |
| credential_id | 是 | String | 参数解释: 服务专属凭证ID。 约束限制: 不涉及。 取值范围: 长度固定为20,格式为HSSC + 16位随机字符,只能包含大小写字母和数字。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| status | 否 | String | 参数解释: 凭证状态。不支持用户主动设置为 expired(expired 仅由系统在凭证过期时自动设置)。status和description至少指定一个。 约束限制: 不涉及。 取值范围: 可选值为active或inactive。 默认取值: 不涉及。 |
| description | 否 | String | 参数解释: 要设置的凭证描述。status和description至少指定一个。 约束限制: 不涉及。 取值范围: 取值范围为[0,255],正则校验为^[^@#%&<>\$^*]*$。 默认取值: 不涉及。 |
响应参数
状态码:200
无
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,请参见错误码。 取值范围: 格式为PAP5.XXXX,例如 PAP5.0012。 |
| error_msg | String | 参数解释: 错误信息,请参见错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: API 请求的唯一标识,用于排查接口调用异常。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,请参见错误码。 取值范围: 格式为PAP5.XXXX,例如PAP5.0012。 |
| error_msg | String | 参数解释: 错误信息,请参见错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: API请求的唯一标识,用于排查接口调用异常。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 认证失败时返回的加密详细信息,用于定位认证问题。 可以通过STS5解密接口进行解密,请参见接口链接。 取值范围: 不涉及。 |
状态码:404
请求示例
更新服务专属凭证
PUT https://{endpoint}/users/{user_id}/service-specific-credentials/{credential_id}
{
"status" : "active",
"description" : "string",
"user_name" : "string"
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 请求体异常。 |
| 403 | 没有操作权限。 |
| 404 | IAM 用户不存在或凭证不存在。 |
错误码
请参见错误码。