SSOAdmin / Client / describe_application_assignment

describe_application_assignment#

SSOAdmin.Client.describe_application_assignment(**kwargs)#

Retrieves a direct assignment of a user or group to an application. If the user doesn’t have a direct assignment to the application, the user may still have access to the application through a group. Therefore, don’t use this API to test access to an application for a user. Instead use ListApplicationAssignmentsForPrincipal.

See also: AWS API Documentation

Request Syntax

response = client.describe_application_assignment(
    ApplicationArn='string',
    PrincipalId='string',
    PrincipalType='USER'|'GROUP'
)
Parameters:

  • ApplicationArn (string) –

    [REQUIRED]

    Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • PrincipalId (string) –

    [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 (string) –

    [REQUIRED]

    The entity type for which the assignment will be created.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationArn': 'string',
    'PrincipalId': 'string',
    'PrincipalType': 'USER'|'GROUP'
}

Response Structure

  • (dict) –

    • ApplicationArn (string) –

      Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    • PrincipalId (string) –

      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 (string) –

      The entity type for which the assignment will be created.

Exceptions