Skip to content

List Application Assignments For Principal

ssoadmin_list_application_assignments_for_principal R Documentation

Lists the applications to which a specified principal is assigned

Description

Lists the applications to which a specified principal is assigned. You must provide a filter when calling this action from a member account against your organization instance of IAM Identity Center. A filter is not required when called from the management account against an organization instance of IAM Identity Center, or from a member account against an account instance of IAM Identity Center in the same account.

Usage

ssoadmin_list_application_assignments_for_principal(InstanceArn,
  PrincipalId, PrincipalType, Filter, NextToken, MaxResults)

Arguments

InstanceArn

[required] Specifies the instance of IAM Identity Center that contains principal and applications.

PrincipalId

[required] Specifies the unique identifier of the principal for which you want to retrieve its assignments.

PrincipalType

[required] Specifies the type of the principal for which you want to retrieve its assignments.

Filter

Filters the output to include only assignments associated with the application that has the specified ARN.

NextToken

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

MaxResults

Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Value

A list with the following syntax:

list(
  ApplicationAssignments = list(
    list(
      ApplicationArn = "string",
      PrincipalId = "string",
      PrincipalType = "USER"|"GROUP"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_application_assignments_for_principal(
  InstanceArn = "string",
  PrincipalId = "string",
  PrincipalType = "USER"|"GROUP",
  Filter = list(
    ApplicationArn = "string"
  ),
  NextToken = "string",
  MaxResults = 123
)