Chatbot / Client / list_microsoft_teams_user_identities

list_microsoft_teams_user_identities#

Chatbot.Client.list_microsoft_teams_user_identities(**kwargs)#

A list all Microsoft Teams user identities with a mapped role.

See also: AWS API Documentation

Request Syntax

response = client.list_microsoft_teams_user_identities(
    ChatConfigurationArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • ChatConfigurationArn (string) – The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.

  • 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.

  • MaxResults (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'TeamsUserIdentities': [
        {
            'IamRoleArn': 'string',
            'ChatConfigurationArn': 'string',
            'TeamId': 'string',
            'UserId': 'string',
            'AwsUserIdentity': 'string',
            'TeamsChannelId': 'string',
            'TeamsTenantId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • TeamsUserIdentities (list) –

      User level permissions associated to a channel configuration.

      • (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 in the AWS Chatbot Administrator Guide.

        • ChatConfigurationArn (string) –

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

        • TeamId (string) –

          The ID of the Microsoft Teams authorized with AWS Chatbot.

          To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.

        • UserId (string) –

          The Microsoft Teams user ID.

        • AwsUserIdentity (string) –

          The AWS user identity ARN used to associate a Microsoft Teams user Identity with an IAM Role.

        • TeamsChannelId (string) –

          The ID of the Microsoft Teams channel.

        • TeamsTenantId (string) –

          The ID of the Microsoft Teams tenant.

    • 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

  • Chatbot.Client.exceptions.InvalidParameterException

  • Chatbot.Client.exceptions.InvalidRequestException

  • Chatbot.Client.exceptions.ListMicrosoftTeamsUserIdentitiesException