ListMicrosoftTeamsUserIdentities
A list all Microsoft Teams user identities with a mapped role.
Request Syntax
POST /list-ms-teams-user-identities HTTP/1.1
Content-type: application/json
{
"ChatConfigurationArn": "string",
"MaxResults": number,
"NextToken": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ChatConfigurationArn
-
The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.
Type: String
Length Constraints: Minimum length of 19. Maximum length of 1169.
Pattern:
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}Required: No
- 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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- 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: String
Length Constraints: Minimum length of 1. Maximum length of 1276.
Pattern:
[a-zA-Z0-9=\/+_.\-,#:\\"{}]{4,1276}Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"TeamsUserIdentities": [
{
"AwsUserIdentity": "string",
"ChatConfigurationArn": "string",
"IamRoleArn": "string",
"TeamId": "string",
"TeamsChannelId": "string",
"TeamsTenantId": "string",
"UserId": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- 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: String
Length Constraints: Minimum length of 1. Maximum length of 1276.
Pattern:
[a-zA-Z0-9=\/+_.\-,#:\\"{}]{4,1276} - TeamsUserIdentities
-
User level permissions associated to a channel configuration.
Type: Array of TeamsUserIdentity objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterException
-
Your request input doesn't meet the constraints required by Amazon Q Developer.
HTTP Status Code: 400
- InvalidRequestException
-
Your request input doesn't meet the constraints required by Amazon Q Developer.
HTTP Status Code: 400
- ListMicrosoftTeamsUserIdentitiesException
-
We can’t process your request right now because of a server issue. Try again later.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
