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

******************************
list_permission_groups_by_user
******************************



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

  

  Lists all the permission groups that are associated with a specific user.

  

  .. 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/ListPermissionGroupsByUser>`_  


  **Request Syntax**
  ::

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

    The unique identifier for the user.

    

  
  :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**

    
    ::

      {
          'permissionGroups': [
              {
                  'permissionGroupId': 'string',
                  'name': 'string',
                  'membershipStatus': 'ADDITION_IN_PROGRESS'|'ADDITION_SUCCESS'|'REMOVAL_IN_PROGRESS'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **permissionGroups** *(list) --* 

        A list of returned permission groups.

        
        

        - *(dict) --* 

          The structure of a permission group associated with a user.

          
          

          - **permissionGroupId** *(string) --* 

            The unique identifier for the permission group.

            
          

          - **name** *(string) --* 

            The name of the permission group.

            
          

          - **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`

  