:doc:`Chatbot <../../chatbot>` / Client / describe_slack_user_identities

******************************
describe_slack_user_identities
******************************



.. py:method:: Chatbot.Client.describe_slack_user_identities(**kwargs)

  

  Lists all Slack user identities with a mapped role.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/DescribeSlackUserIdentities>`_  


  **Request Syntax**
  ::

    response = client.describe_slack_user_identities(
        ChatConfigurationArn='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type ChatConfigurationArn: string
  :param ChatConfigurationArn: 

    The Amazon Resource Name (ARN) of the SlackChannelConfiguration associated with the user identities to describe.

    

  
  :type NextToken: string
  :param NextToken: 

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    

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

    
    ::

      {
          'SlackUserIdentities': [
              {
                  'IamRoleArn': 'string',
                  'ChatConfigurationArn': 'string',
                  'SlackTeamId': 'string',
                  'SlackUserId': 'string',
                  'AwsUserIdentity': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **SlackUserIdentities** *(list) --* 

        A list of Slack User Identities.

        
        

        - *(dict) --* 

          Identifes a user level permission for a channel configuration.

          
          

          - **IamRoleArn** *(string) --* 

            A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

             

            For more information, see `IAM policies for AWS Chatbot <https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html>`__ in the *AWS Chatbot Administrator Guide*.

            
          

          - **ChatConfigurationArn** *(string) --* 

            The Amazon Resource Name (ARN) of the SlackChannelConfiguration associated with the user identity to delete.

            
          

          - **SlackTeamId** *(string) --* 

            The ID of the Slack workspace authorized with AWS Chatbot.

            
          

          - **SlackUserId** *(string) --* 

            The ID of the user in Slack

            
          

          - **AwsUserIdentity** *(string) --* 

            The AWS user identity ARN used to associate a Slack user ID with an IAM Role.

            
      
    
      

      - **NextToken** *(string) --* 

        An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

        
  
  **Exceptions**
  
  *   :py:class:`Chatbot.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`Chatbot.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Chatbot.Client.exceptions.DescribeSlackUserIdentitiesException`

  