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.
Request Syntax
{
"Filter": {
"ApplicationArn": "string"
},
"InstanceArn": "string",
"MaxResults": number,
"NextToken": "string",
"PrincipalId": "string",
"PrincipalType": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Filter
-
Filters the output to include only assignments associated with the application that has the specified ARN.
Type: ListApplicationAssignmentsFilter object
Required: No
- InstanceArn
-
Specifies the instance of IAM Identity Center that contains principal and applications.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 1224.
Pattern:
arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}Required: Yes
- MaxResults
-
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the
NextTokenresponse element is returned with a value (not null). Include the specified value as theNextTokenrequest 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 checkNextTokenafter every operation to ensure that you receive all of the results.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
Specifies that you want to receive the next page of results. Valid only if you received a
NextTokenresponse 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'sNextTokenresponse to request the next page of results.Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
[-a-zA-Z0-9+=/_]*Required: No
- PrincipalId
-
Specifies the unique identifier of the principal for which you want to retrieve its assignments.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 47.
Pattern:
([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}Required: Yes
- PrincipalType
-
Specifies the type of the principal for which you want to retrieve its assignments.
Type: String
Valid Values:
USER | GROUPRequired: Yes
Response Syntax
{
"ApplicationAssignments": [
{
"ApplicationArn": "string",
"PrincipalId": "string",
"PrincipalType": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ApplicationAssignments
-
An array list of the application assignments for the specified principal.
Type: Array of ApplicationAssignmentForPrincipal objects
- NextToken
-
If present, this value indicates that more output is available than is included in the current response. Use this value in the
NextTokenrequest parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextTokenresponse element comes back asnull. This indicates that this is the last page of results.Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
[-a-zA-Z0-9+=/_]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 400
- InternalServerException
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
HTTP Status Code: 500
- ResourceNotFoundException
-
Indicates that a requested resource is not found.
HTTP Status Code: 400
- ThrottlingException
-
Indicates that the principal has crossed the throttling limits of the API operations.
HTTP Status Code: 400
- ValidationException
-
The request failed because it contains a syntax error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
