Updated on 2023-03-14 GMT+08:00

Modifying a Custom Policy for Agencies

Function

This API is provided for the administrator to modify a custom policy for agencies.

The API can be called using both the global endpoint and region-specific endpoints. For IAM endpoints, see Regions and Endpoints.

URI

PATCH /v3.0/OS-ROLE/roles/{role_id}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

role_id

Yes

String

Custom policy ID. For details about how to obtain a custom policy ID, see Custom Policy ID.

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

role

Yes

Object

Custom policy information.

Table 4 role

Parameter

Mandatory

Type

Description

display_name

Yes

String

Display name of the custom policy.

type

Yes

String

Display mode.

NOTE:
  • AX: the global service project
  • XA: region-specific projects
  • Set the display mode of a custom policy to either AX or XA.

description

Yes

String

Description of the custom policy.

description_cn

No

String

Description of the custom policy in Chinese.

policy

Yes

Object

Content of the custom policy.

Table 5 role.policy

Parameter

Mandatory

Type

Description

Version

Yes

String

Policy version. When creating a custom policy, set this parameter to 1.1.

NOTE:
  • 1.0: System-defined role. Only a limited number of service-level roles are provided for authorization.
  • 1.1: Policy. A policy defines the permissions required to perform operations on a specific cloud resource under certain conditions.

Statement

Yes

Array of objects

Statement of the policy. A policy can contain a maximum of eight statements.

Table 6 role.policy.Statement

Parameter

Mandatory

Type

Description

Action

Yes

Array of strings

An action item is a specific operation permission on a resource.

NOTE:
  • In the case of a custom policy for agencies, this parameter should be set to "Action": ["iam:agencies:assume"].

Set this parameter to iam:agencies:assume.

Effect

Yes

String

Effect of the permission. The value can be Allow or Deny. If both Allow and Deny statements are found in a policy, the authentication starts from the Deny statements.

Options:

  • Allow
  • Deny

Resource

Yes

Object

Resources to be managed. After an account establishes multiple trust relationships between itself and your account, you can authorize IAM users in different user groups to manage resources of the delegating party. Each IAM user can only switch to the agencies they have been authorized to access. For example:

"Resource": {"uri": ["/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c"]}
Table 7 role.policy.Statement.Resource

Parameter

Mandatory

Type

Description

uri

Yes

Array of strings

URI of a delegated resource, which can contain a maximum of 128 characters. Format: /iam/agencies/delegation ID. For example:

"uri": ["/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c"]

Response Parameters

Table 8 Parameters in the response body

Parameter

Type

Description

role

Object

Custom policy information.

Table 9 role

Parameter

Type

Description

catalog

String

Service catalog.

display_name

String

Display name of the custom policy.

description

String

Description of the custom policy.

links

Object

Resource link of the custom policy.

policy

Object

Content of the custom policy.

description_cn

String

Description of the custom policy in Chinese.

domain_id

String

Account ID.

type

String

Display mode.

NOTE:
  • AX: the global service project
  • XA: region-specific projects
  • Set the display mode of a custom policy to either AX or XA.

id

String

Custom policy ID.

name

String

Name of the custom policy.

updated_time

String

Time when the custom policy was last updated.

created_time

String

Time when the custom policy was created.

references

String

Number of references.

Table 11 role.policy

Parameter

Type

Description

Version

String

Policy version.

NOTE:
  • 1.0: System-defined role. Only a limited number of service-level roles are provided for authorization.
  • 1.1: Policy. A policy defines the permissions required to perform operations on a specific cloud resource under certain conditions.

Statement

Array of objects

Statement of the policy. A policy can contain a maximum of eight statements.

Table 12 role.policy.Statement

Parameter

Type

Description

Action

Array of strings

An action item is a specific operation permission on a resource.

NOTE:
  • In the case of a custom policy for agencies, this parameter should be set to "Action": ["iam:agencies:assume"].

Effect

String

Effect of the permission. The value can be Allow or Deny. If both Allow and Deny statements are found in a policy, the authentication starts from the Deny statements.

Options:

  • Allow
  • Deny

Resource

Object

Resources to be managed. After an account establishes multiple trust relationships between itself and your account, you can authorize IAM users in different user groups to manage resources of the delegating party. Each IAM user can only switch to the agencies they have been authorized to access. For example:

"Resource": {"uri": ["/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c"]}
Table 13 role.policy.Statement.Resource

Parameter

Type

Description

uri

Array of strings

URI of a delegated resource, which can contain a maximum of 128 characters. Format: /iam/agencies/delegation ID. For example:

"uri": ["/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c"]

Example Request

PATCH https://iam.myhuaweicloud.com/v3.0/OS-ROLE/roles/{role_id}
{
    "role": {
        "display_name": "IAMAgencyPolicy",
        "type": "AX",
        "description": "IAMDescription",
        "description_cn": "Description in Chinese",
        "policy": {
            "Version": "1.1",
            "Statement": [
                {
                    "Effect": "Allow",
                    "Action": [
                        "iam:agencies:assume"
                    ],
                    "Resource": {
                        "uri": [
                            "/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c"
                        ]
                    }
                }
            ]
        }
    }
}

Example Response

Status code: 200

The request is successful.

{
    "role": {
        "catalog": "CUSTOMED",
        "display_name": "IAMAgencyPolicy",
        "description": "IAMDescription",
        "links": {
            "self": "https://iam.myhuaweicloud.com/v3/roles/f67224e84dc849ab954ce29fb4f47f8e"
        },
        "policy": {
            "Version": "1.1",
            "Statement": [
                {
                    "Action": [
                        "iam:agencies:assume"
                    ],
                    "Resource": {
                        "uri": [
                            "/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c"
                        ]
                    },
                    "Effect": "Allow"
                }
            ]
        },
        "description_cn": "Description in Chinese",
        "domain_id": "d78cbac186b744899480f25b...",
        "type": "AX",
        "id": "f67224e84dc849ab954ce29fb4f47f8e",
        "name": "custom_d78cbac186b744899480f25bd022f468_0"
    }
}

Status Codes

Status Code

Description

200

The request is successful.

400

Invalid parameters.

401

Authentication failed.

403

Access denied.

500

Internal server error.

Error Codes

None