Creating Account Assignments_Account Assignment Management_API_API Reference

Function

This API is used to assign access permissions to a principal for a specified account using a specified permission set. The principal can be either a user or a group in IAM Identity Center. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

POST /v1/instances/{instance_id}/account-assignments/create

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Globally unique ID of an IAM Identity Center instance.

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Maximum length: 2048

**Table 3** Parameters in the request body
Parameter	Mandatory	Type	Description
permission_set_id	Yes	String	Unique ID of a permission set.
principal_id	Yes	String	Unique ID of a principal (for example, a user or group) in IAM Identity Center.
principal_type	Yes	String	Principal type for which the assignment will be created. Enumerated value: USER GROUP
target_id	Yes	String	ID of the target principal.
target_type	Yes	String	Principal type for which the assignment will be created. Enumerated value: ACCOUNT

Response Parameters

Status code: 200

**Table 4** Parameters in the response body
Parameter	Type	Description
account_assignment_creation_status	Object	Status object for the account assignment creation operation.

**Table 5** account_assignment_creation_status
Parameter	Type	Description
created_date	Long	Creation date.
failure_reason	String	Failure cause.
permission_set_id	String	Unique ID of a permission set.
principal_id	String	Unique ID of a principal (for example, a user or group) in IAM Identity Center.
principal_type	String	Principal type of an operation. Enumerated value: USER GROUP
request_id	String	Unique ID of a request.
status	String	Authorization status of a permission set. Enumerated value: IN_PROGRESS FAILED SUCCEEDED
target_id	String	Unique ID of a target principal.
target_type	String	Principal type. Enumerated value: ACCOUNT

Status code: 400

**Table 6** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of a request.

Status code: 403

**Table 7** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of a request.
encoded_authorization_message	String	Encrypted error message.

Status code: 404

**Table 8** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of a request.

Example Request

Assigning access permissions to an IAM Identity Center user for a specified account using a specified permission set

POST https://{hostname}/v1/instances/{instance_id}/account-assignments/create

{
  "permission_set_id" : "848805579************03de60620a5",
  "principal_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
  "principal_type" : "USER",
  "target_id" : "5146d03d8aaaaaaaaaaaabbae60620a5",
  "target_type" : "ACCOUNT"
}

Example Response

Status code: 200

Successful

{
  "account_assignment_creation_status" : {
    "created_date" : 0,
    "failure_reason" : "string",
    "permission_set_id" : "string",
    "principal_id" : "string",
    "principal_type" : "USER",
    "request_id" : "string",
    "status" : "IN_PROGRESS",
    "target_id" : "string",
    "target_type" : "ACCOUNT"
  }
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Creating Account Assignments