az communication user-identity

Preview
Reference

Note

This reference is part of the communication extension for the Azure CLI (version 2.59.0 or higher). The extension will automatically install the first time you run an az communication user-identity command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage user identities and their tokens for a Communication Service resource.

Commands

Name	Description	Type	Status
az communication user-identity issue-access-token	Issues a new access token with the specified scopes for a given User Identity. If no User Identity is specified, creates a new User Identity as well.	Extension	Preview and Deprecated
az communication user-identity token	Commands to manage user tokens for a Communication Service resource.	Extension	Preview
az communication user-identity token get-for-teams-user	Exchanges an Azure Active Directory (Azure AD) access token of a Teams user for a new ACS Identity access token with a matching expiration time.	Extension	Preview
az communication user-identity token issue	Issues a new access token with the specified scopes for a given User Identity. If no User Identity is specified, creates a new User Identity as well.	Extension	Preview
az communication user-identity token revoke	Revokes all access tokens for the specific ACS Identity.	Extension	Preview
az communication user-identity user	Commands to manage user identities for a Communication Service resource.	Extension	Preview
az communication user-identity user create	Creates a new ACS Identity.	Extension	Preview
az communication user-identity user delete	Deletes an existing ACS Identity, revokes all tokens for that ACS Identity and deletes all associated data.	Extension	Preview

az communication user-identity issue-access-token

Preview Deprecated

Command group 'communication user-identity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command has been deprecated and will be removed in a future release. Use 'token issue' instead.

Issues a new access token with the specified scopes for a given User Identity. If no User Identity is specified, creates a new User Identity as well.

az communication user-identity issue-access-token --scope
                                                  [--connection-string]
                                                  [--userid]

Examples

Issue access token

az communication user-identity issue-access-token --scope chat

Issue access token with multiple scopes and user

az communication user-identity issue-access-token --scope chat voip --userid "8:acs:xxxxxx"

Required Parameters

--scope -s

List of scopes for an access token ex: chat/voip.

Optional Parameters

--connection-string

Communication connection string. Environment variable: AZURE_COMMUNICATION_CONNECTION_STRING.

--userid -u

ACS identifier.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Share via