:doc:`FinSpaceData <../../finspace-data>` / Client / list_users_by_permission_group

******************************
list_users_by_permission_group
******************************



.. py:method:: FinSpaceData.Client.list_users_by_permission_group(**kwargs)

  

  Lists details of all the users in a specific permission group.

  

  .. danger::

        This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsersByPermissionGroup>`_  


  **Request Syntax**
  ::

    response = client.list_users_by_permission_group(
        permissionGroupId='string',
        nextToken='string',
        maxResults=123
    )
    
  :type permissionGroupId: string
  :param permissionGroupId: **[REQUIRED]** 

    The unique identifier for the permission group.

    

  
  :type nextToken: string
  :param nextToken: 

    A token that indicates where a results page should begin.

    

  
  :type maxResults: integer
  :param maxResults: **[REQUIRED]** 

    The maximum number of results per page.

    

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

    
    ::

      {
          'users': [
              {
                  'userId': 'string',
                  'status': 'CREATING'|'ENABLED'|'DISABLED',
                  'firstName': 'string',
                  'lastName': 'string',
                  'emailAddress': 'string',
                  'type': 'SUPER_USER'|'APP_USER',
                  'apiAccess': 'ENABLED'|'DISABLED',
                  'apiAccessPrincipalArn': 'string',
                  'membershipStatus': 'ADDITION_IN_PROGRESS'|'ADDITION_SUCCESS'|'REMOVAL_IN_PROGRESS'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **users** *(list) --* 

        Lists details of all users in a specific permission group.

        
        

        - *(dict) --* 

          The structure of a user associated with a permission group.

          
          

          - **userId** *(string) --* 

            The unique identifier for the user.

            
          

          - **status** *(string) --* 

            The current status of the user.

             

            
            * ``CREATING`` – The user creation is in progress.
             
            * ``ENABLED`` – The user is created and is currently active.
             
            * ``DISABLED`` – The user is currently inactive.
            

            
          

          - **firstName** *(string) --* 

            The first name of the user.

            
          

          - **lastName** *(string) --* 

            The last name of the user.

            
          

          - **emailAddress** *(string) --* 

            The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.

            
          

          - **type** *(string) --* 

            Indicates the type of user.

             

            
            * ``SUPER_USER`` – A user with permission to all the functionality and data in FinSpace.
             
            * ``APP_USER`` – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
            

            
          

          - **apiAccess** *(string) --* 

            Indicates whether the user can access FinSpace API operations.

             

            
            * ``ENABLED`` – The user has permissions to use the API operations.
             
            * ``DISABLED`` – The user does not have permissions to use any API operations.
            

            
          

          - **apiAccessPrincipalArn** *(string) --* 

            The IAM ARN identifier that is attached to FinSpace API calls.

            
          

          - **membershipStatus** *(string) --* 

            Indicates the status of the user within a permission group.

             

            
            * ``ADDITION_IN_PROGRESS`` – The user is currently being added to the permission group.
             
            * ``ADDITION_SUCCESS`` – The user is successfully added to the permission group.
             
            * ``REMOVAL_IN_PROGRESS`` – The user is currently being removed from the permission group.
            

            
      
    
      

      - **nextToken** *(string) --* 

        A token that indicates where a results page should begin.

        
  
  **Exceptions**
  
  *   :py:class:`FinSpaceData.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`FinSpaceData.Client.exceptions.ThrottlingException`

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

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

  