Skip to main content

Microsoft Azure Communication Identity Service Client Library for Python

Project description

Build Status

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

Install the package

Install the Azure Communication Identity client library for Python with pip:

pip install azure-communication-identity

Key concepts

CommunicationIdentityClient

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

More sample code

Please take a look at the samples directory for detailed examples of how to use this library to manage identities and tokens.

Provide Feedback

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

azure-communication-identity-1.0.0b4.zip (55.7 kB view details)

Uploaded Source

Built Distribution

azure_communication_identity-1.0.0b4-py2.py3-none-any.whl (33.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file azure-communication-identity-1.0.0b4.zip.

File metadata

  • Download URL: azure-communication-identity-1.0.0b4.zip
  • Upload date:
  • Size: 55.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.1 CPython/3.9.1

File hashes

Hashes for azure-communication-identity-1.0.0b4.zip
Algorithm Hash digest
SHA256 905a146462d8bc689ce2fe6cee71aaf92856a664f6cee323b700a09a5f980f48
MD5 0dd8ee2dc99927e1f31e381d4b5efdfc
BLAKE2b-256 7d7676a0d2605076a8ded7083f04ccfa5b009845936feadddf64d76dcf852322

See more details on using hashes here.

File details

Details for the file azure_communication_identity-1.0.0b4-py2.py3-none-any.whl.

File metadata

  • Download URL: azure_communication_identity-1.0.0b4-py2.py3-none-any.whl
  • Upload date:
  • Size: 33.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.1 CPython/3.9.1

File hashes

Hashes for azure_communication_identity-1.0.0b4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6cfc6acb5892b25e25653c0bd24fca53f629e58fc724e27dc302e61d720d0b35
MD5 6f73766cca2eac407d5246a20c913eba
BLAKE2b-256 3af523762cab7b9c25d099d88e8dcf5f0fb426545ff594c9e67fd9642a039e50

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page