Creating a Custom Policy for Agencies

Function

This API is provided for the administrator to create 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.

Debugging

You can debug this API in API Explorer.

URI

POST /v3.0/OS-ROLE/roles

Request Parameters

**Table 1** 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 2** Parameters in the request body
Parameter	Mandatory	Type	Description
role	Yes	Object	Custom policy information.

**Table 3** role
Parameter	Mandatory	Type	Description
display_name	Yes	String	Display name of the custom policy. The value contains 1 to 128 characters.
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 4** 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.

**Table 5** role.policy.Statement
Parameter	Mandatory	Type	Description
Action	Yes	Array of strings	Specific operation permissions on a resource. For details about supported actions, see "Permissions and Supported Actions" in the API Reference of cloud services. 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	No	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 6** 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 7** Parameters in the response body
Parameter	Type	Description
role	Object	Custom policy information.

**Table 8** 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 a custom policy in Chinese. This parameter is returned in the response only when description_cn is specified in the request.
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. NOTE: The value is a Unix timestamp in millisecond, for example, 1687913793000.
created_time	String	Time when the custom policy was created. NOTE: The value is a Unix timestamp in millisecond, for example, 1687913793000.

**Table 9** role.links
Parameter	Type	Description
self	String	Resource link.

**Table 10** 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.

**Table 11** role.policy.Statement
Parameter	Type	Description
Action	Array of strings	Specific operation permissions on a resource. For details about supported actions, see "Permissions and Supported Actions" in the API Reference of cloud services. 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. This parameter is returned only when it is specified in the request. 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 12** 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

Request to create a custom policy with display_name set to IAMAgencyPolicy and uri set to /iam/agencies/07805acaba800fdd4fbdc00b8f888c7c for an agency. The policy applies to global services.

POST https://iam.myhuaweicloud.com/v3.0/OS-ROLE/roles

{
    "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: 201

The custom policy for agencies is created successfully.

{
    "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": "d78cbac186b744899480f25bd02...",
        "type": "AX",
        "id": "f67224e84dc849ab954ce29fb4f47f8e",
        "name": "custom_d78cbac186b744899480f25bd022f468_0"
    }
}