Skip to content

Create Account Assignment

ssoadmin_create_account_assignment R Documentation

Assigns access to a principal for a specified Amazon Web Services account using a specified permission set

Description

Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.

The term principal here refers to a user or group that is defined in IAM Identity Center.

As part of a successful create_account_assignment call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role created in IAM Identity Center. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you must call provision_permission_set to make these updates.

After a successful response, call describe_account_assignment_creation_status to describe the status of an assignment creation request.

Usage

ssoadmin_create_account_assignment(InstanceArn, PermissionSetArn,
  PrincipalId, PrincipalType, TargetId, TargetType)

Arguments

InstanceArn

[required] The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

PermissionSetArn

[required] The ARN of the permission set that the admin wants to grant the principal access to.

PrincipalId

[required] An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

PrincipalType

[required] The entity type for which the assignment will be created.

TargetId

[required] TargetID is an Amazon Web Services account identifier, (For example, 123456789012).

TargetType

[required] The entity type for which the assignment will be created.

Value

A list with the following syntax: 

list(
  AccountAssignmentCreationStatus = list(
    CreatedDate = as.POSIXct(
      "2015-01-01"
    ),
    FailureReason = "string",
    PermissionSetArn = "string",
    PrincipalId = "string",
    PrincipalType = "USER"|"GROUP",
    RequestId = "string",
    Status = "IN_PROGRESS"|"FAILED"|"SUCCEEDED",
    TargetId = "string",
    TargetType = "AWS_ACCOUNT"
  )
)

Request syntax

svc$create_account_assignment(
  InstanceArn = "string",
  PermissionSetArn = "string",
  PrincipalId = "string",
  PrincipalType = "USER"|"GROUP",
  TargetId = "string",
  TargetType = "AWS_ACCOUNT"
)