microsoft_teams_user_identities

Creates, updates, deletes, gets or lists a microsoft_teams_user_identities resource.

Overview

Name	microsoft_teams_user_identities
Type	Resource
Id	aws.chatbot.microsoft_teams_user_identities

Fields

The following fields are returned by SELECT queries:

list_microsoft_teams_user_identities

Name	Datatype	Description
aws_user_identity	string	The AWS user identity ARN used to associate a Microsoft Teams user Identity with an IAM Role. (pattern: <code>arn:aws:(iam|sts)::[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}</code>)
chat_configuration_arn	string	The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. (pattern: <code>arn:aws:(wheatley|chatbot):[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}</code>)
iam_role_arn	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. (pattern: <code>arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}</code>)
team_id	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. (pattern: <code>[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}</code>)
teams_channel_id	string	The ID of the Microsoft Teams channel. (pattern: <code>([a-zA-Z0-9-=+/.,])*%3[aA]([a-zA-Z0-9-=+/.,])%40([a-zA-Z0-9-_=+/.,])</code>)
teams_tenant_id	string	The ID of the Microsoft Teams tenant. (pattern: <code>[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}</code>)
user_id	string	The Microsoft Teams user ID. (pattern: <code>[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_microsoft_teams_user_identities	select	region		A list all Microsoft Teams user identities with a mapped role.
delete_microsoft_teams_user_identity	delete	region		Identifes a user level permission for a channel configuration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_microsoft_teams_user_identities

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

SELECT
aws_user_identity,
chat_configuration_arn,
iam_role_arn,
team_id,
teams_channel_id,
teams_tenant_id,
user_id
FROM aws.chatbot.microsoft_teams_user_identities
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_microsoft_teams_user_identity

Identifes a user level permission for a channel configuration.

DELETE FROM aws.chatbot.microsoft_teams_user_identities
WHERE region = '{{ region }}' --required
;