Updated on 2026-10-16 GMT+08:00

Modifying a Trust Agency

Function

This API is used to modify a trust agency.

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:agencies:updateV5	Write	agency *	g:ResourceTag/<tag-key>	-	-

URI

PUT /v5/agencies/{agency_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
agency_id	Yes	String	Definition Trust agency ID. For details about how to obtain the value, see the API for querying the agency list (ListAgenciesV5) or check the Agencies page on the IAM console. Constraints N/A Range The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
max_session_duration	No	Integer	Definition: Maximum session duration of a trust agency, in seconds. Constraints: N/A Range: The value ranges from 3,600 to 43,200. Default Value: The default value is 3600.
description	No	String	Definition Description of a trust agency. Constraints N/A Range The value contains 0 to 1,000 characters. Default Value The default value is an empty string.

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

Status code: 409

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

Example Requests

Modifying a trust agency

PUT https://{endpoint}/v5/agencies/{agency_id}

{
  "max_session_duration" : 3600,
  "description" : "description"
}

Example Responses

None

Status Codes

Status Code	Description
200	Successful
400	Bad request
403	Forbidden
404	Not found
409	Conflict

Error Codes

See Error Codes.

Parent topic: Managing Agencies and Trust Agencies