Help Center/Identity and Access Management/API Reference/API/Agency Management/Modifying an Agency
Updated on 2025-12-27 GMT+08:00
View PDF

Modifying an Agency

Function

This API is provided for the administrator to modify an agency.

The API can be called using both the global endpoint and region-specific endpoints.

Authorization Information

Each account is authorized to call all APIs, but its IAM users must obtain the required permissions. For details, see Permissions and Supported Actions.

URI

PUT /v3.0/OS-AGENCY/agencies/{agency_id}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

agency_id

Yes

String

Agency ID. For details about how to obtain the agency ID, see Obtaining Account, IAM User, Group, Project, Region, and Agency Information.

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Fill application/json;charset=utf8 in this field.

X-Auth-Token

Yes

String

Access token issued to a user to bear its identity and permissions.

For details about the permissions required by the token, see Actions.

Table 3 Parameters in the request body

Parameter

Mandatory

Type

Description

agency

Yes

object

Agency information.

Table 4 agency

Parameter

Mandatory

Type

Description

trust_domain_id

No

String

ID of the delegated account. If both trust_domain_id and trust_domain_name are specified, trust_domain_name takes precedence. At least one of these four parameters must be specified for the agency.

trust_domain_name

No

String

Name of the delegated account. If both trust_domain_id and trust_domain_name are specified, trust_domain_name takes precedence. At least one of these four parameters must be specified for the agency.

description

No

String

Description of the agency, which must contain less than or equal to 255 characters. At least one of these four parameters must be specified for the agency.

duration

No

object

Validity period of the agency. Unit: day. At least one of these four parameters must be specified for the agency.

Options:

  • FOREVER: The agency has unlimited validity.
  • ONEDAY: The agency is valid for one day.
  • Specific days: The agency has limited validity of, for example, 20 days.

Response Parameters

Table 5 Parameters in the response body

Parameter

Type

Description

agency

object

Agency information.

Table 6 agency

Parameter

Type

Description

create_time

String

Time when the agency was created.

NOTE:

The value is a UTC time in the YYYY-MM-DDTHH:mm:ss.ssssss format, for example, 2023-06-28T08:56:33.710000.

description

String

Description of the agency.

domain_id

String

ID of the delegating account.

duration

String

Validity period of the agency. Unit: hour.

  • FOREVER/null: The agency has unlimited validity.
  • 24: The agency is valid for 24 hours.
  • XXX: The agency has limited validity of, for example, 480 hours.

expire_time

String

Agency expiration time. null indicates that the agency has unlimited validity.

NOTE:

The value is a UTC time in the YYYY-MM-DDTHH:mm:ss.ssssss format, for example, 2023-06-28T08:56:33.710000.

id

String

Agency ID.

name

String

Agency name.

trust_domain_id

String

ID of the delegated account.

Example Request

Request for changing the validity period of an agency to one day.

PUT https://iam.myhuaweicloud.eu/v3.0/OS-AGENCY/agencies/{agency_id}
{
    "agency": {
        "trust_domain_id": "b2cd82a33fb043dc9304bf72...",
        "trust_domain_name": "IAMDomainB",
        "description": "IAMDescription",
        "duration": "ONEDAY"
    }
}

Example Response

Status code: 200

The agency is modified successfully.

{
    "agency": {
        "description": "IAMDescription",
        "trust_domain_id": "b2cd82a33fb043dc9304bf72a0...",
        "id": "0760a9e2a60026664f1fc0031f9f205e",
        "duration": 24,
        "create_time": "2020-01-04T03:37:16.000000",
        "expire_time": "2020-01-21T13:06:11.241588",
        "domain_id": "d78cbac186b744899480f25...",
        "name": "IAMAgency"
    }
}

Status Codes

Status Code

Description

200

The agency is modified successfully.

400

Invalid parameters.

401

Authentication failed.

403

Access denied.

404

The requested resource cannot be found.

500

Internal server error.

Error Codes

None

Parent topic:Agency Management