Help Center/ Identity and Access Management_Identity and Access Management (New Edition)/ API Reference/ API/ IAM/ Managing Agencies and Trust Agencies/ Modifying a Trust Agency
Updated on 2025-11-06 GMT+08:00
View PDF
Share

Modifying a Trust Agency

Function

This API is used to modify a trust agency.

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

Trust agency ID. The value must contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

max_session_duration

No

Integer

Maximum session duration of a trust agency. The value ranges from 3,600 to 43,200. The default value is 3,600 seconds.

description

No

String

Description of a trust agency.

Maximum: 1000

Response Parameters

Status code: 200

Successful

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

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

Status code: 404

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Request ID.

Status code: 409

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Request ID.

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.