Azure Communication Identity Package client library for Python¶
Azure Communication Identity client package is intended to be used to setup the basics for opening a way to use Azure Communication Service offerings. This package helps to create identities user tokens to be used by other client packages such as chat, calling, sms.
Getting started¶
Prerequisites¶
Python 2.7, or 3.5 or later is required to use this package.
You must have an Azure subscription
A deployed Communication Services resource. You can use the Azure Portal or the Azure PowerShell to set it up. ### Install the package Install the Azure Communication Identity client library for Python with pip:
pip install azure-communication-identity
Key concepts¶
CommunicationIdentityClient provides operations for:
Create/delete identities to be used in Azure Communication Services. Those identities can be used to make use of Azure Communication offerings and can be scoped to have limited abilities through token scopes.
Create/revoke scoped user access tokens to access services such as chat, calling, sms. Tokens are issued for a valid Azure Communication identity and can be revoked at any time.
Initializing Identity Client¶
# You can find your endpoint and access token from your resource in the Azure Portal
import os
from azure.communication.identity import CommunicationIdentityClient
from azure.identity import DefaultAzureCredential
connection_str = os.getenv('AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING')
endpoint = os.getenv('AZURE_COMMUNICATION_SERVICE_ENDPOINT')
# To use Azure Active Directory Authentication (DefaultAzureCredential) make sure to have
# AZURE_TENANT_ID, AZURE_CLIENT_ID and AZURE_CLIENT_SECRET as env variables.
identity_client_managed_identity = CommunicationIdentityClient(endpoint, DefaultAzureCredential())
#You can also authenticate using your connection string
identity_client = CommunicationIdentityClient.from_connection_string(connection_str)
Examples¶
The following section provides several code snippets covering some of the most common Azure Communication Services tasks, including:
Creating a new user¶
Use the create_user method to create a new user.
user = identity_client.create_user()
print("User created with id:" + user.identifier)
Alternatively, use the create_user_with_token method to create a new user and issue a token for it.For this option, a list of CommunicationTokenScope must be defined (see “Issuing an access token” for more information)
user, tokenresponse = identity_client.create_user_with_token(scopes=[CommunicationTokenScope.CHAT])
print("User id:" + user.identifier)
print("Token issued with value: " + tokenresponse.token)
Issuing or Refreshing an access token for a user¶
Use the issue_token method to issue or refresh a scoped access token for the user. Pass in the user object as a parameter, and a list of CommunicationTokenScope. Scope options are:
CHAT(Chat)VOIP(VoIP)
tokenresponse = identity_client.issue_token(user, scopes=[CommunicationTokenScope.CHAT])
print("Token issued with value: " + tokenresponse.token)
Revoking a user’s access tokens¶
Use revoke_tokens to revoke all access tokens for a user. Pass in the user object as a parameter
identity_client.revoke_tokens(user)
Deleting a user¶
Use the delete_user method to delete a user. Pass in the user object as a parameter
identity_client.delete_user(user)
Troubleshooting¶
The Azure Communication Service Identity client will raise exceptions defined in Azure Core.
Next steps¶
Please take a look at the samples directory for detailed examples of how to use this library to manage identities and tokens.
If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project
Contributing¶
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Developer Documentation