:doc:`SSOAdmin <../../sso-admin>` / Client / describe_application_assignment

*******************************
describe_application_assignment
*******************************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/DescribeApplicationAssignment>`_  


  **Request Syntax**
  ::

    response = client.describe_application_assignment(
        ApplicationArn='string',
        PrincipalId='string',
        PrincipalType='USER'|'GROUP'
    )
    
  :type ApplicationArn: string
  :param ApplicationArn: **[REQUIRED]** 

    Specifies the ARN of the application. For more information about ARNs, see `Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces </general/latest/gr/aws-arns-and-namespaces.html>`__ in the *Amazon Web Services General Reference*.

    

  
  :type PrincipalId: string
  :param 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 <https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html>`__.

    

  
  :type PrincipalType: string
  :param PrincipalType: **[REQUIRED]** 

    The entity type for which the assignment will be created.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

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

    

    - *(dict) --* 
      

      - **PrincipalType** *(string) --* 

        The entity type for which the assignment will be created.

        
      

      - **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 <https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html>`__.

        
      

      - **ApplicationArn** *(string) --* 

        Specifies the ARN of the application. For more information about ARNs, see `Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces </general/latest/gr/aws-arns-and-namespaces.html>`__ in the *Amazon Web Services General Reference*.

        
  
  **Exceptions**
  
  *   :py:class:`SSOAdmin.Client.exceptions.ThrottlingException`

  
  *   :py:class:`SSOAdmin.Client.exceptions.InternalServerException`

  
  *   :py:class:`SSOAdmin.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`SSOAdmin.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`SSOAdmin.Client.exceptions.ValidationException`

  