CommunicationIdentityClient.GetToken Method

Definition

Namespace:

Azure.Communication.Identity

Assembly:

Azure.Communication.Identity.dll

Package:

Azure.Communication.Identity v1.3.1

Overloads

GetToken(CommunicationUserIdentifier, IEnumerable<CommunicationTokenScope>, CancellationToken)	Gets a Communication Identity access token for a CommunicationUserIdentifier.
GetToken(CommunicationUserIdentifier, IEnumerable<CommunicationTokenScope>, TimeSpan, CancellationToken)	Gets a Communication Identity access token for a CommunicationUserIdentifier.

GetToken(CommunicationUserIdentifier, IEnumerable<CommunicationTokenScope>, CancellationToken)

Source:

CommunicationIdentityClient.cs

Gets a Communication Identity access token for a CommunicationUserIdentifier.

public virtual Azure.Response<Azure.Core.AccessToken> GetToken (Azure.Communication.CommunicationUserIdentifier communicationUser, System.Collections.Generic.IEnumerable<Azure.Communication.Identity.CommunicationTokenScope> scopes, System.Threading.CancellationToken cancellationToken = default);

abstract member GetToken : Azure.Communication.CommunicationUserIdentifier * seq<Azure.Communication.Identity.CommunicationTokenScope> * System.Threading.CancellationToken -> Azure.Response<Azure.Core.AccessToken>
override this.GetToken : Azure.Communication.CommunicationUserIdentifier * seq<Azure.Communication.Identity.CommunicationTokenScope> * System.Threading.CancellationToken -> Azure.Response<Azure.Core.AccessToken>

Public Overridable Function GetToken (communicationUser As CommunicationUserIdentifier, scopes As IEnumerable(Of CommunicationTokenScope), Optional cancellationToken As CancellationToken = Nothing) As Response(Of AccessToken)

Parameters

communicationUser

CommunicationUserIdentifier

The CommunicationUserIdentifier for whom to get a Communication Identity access token.

scopes

IEnumerable<CommunicationTokenScope>

List of CommunicationTokenScope scopes for the token.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<AccessToken>

Exceptions

RequestFailedException

The server returned an error.

GetToken(CommunicationUserIdentifier, IEnumerable<CommunicationTokenScope>, TimeSpan, CancellationToken)

Source:

CommunicationIdentityClient.cs

Gets a Communication Identity access token for a CommunicationUserIdentifier.

public virtual Azure.Response<Azure.Core.AccessToken> GetToken (Azure.Communication.CommunicationUserIdentifier communicationUser, System.Collections.Generic.IEnumerable<Azure.Communication.Identity.CommunicationTokenScope> scopes, TimeSpan tokenExpiresIn, System.Threading.CancellationToken cancellationToken = default);

abstract member GetToken : Azure.Communication.CommunicationUserIdentifier * seq<Azure.Communication.Identity.CommunicationTokenScope> * TimeSpan * System.Threading.CancellationToken -> Azure.Response<Azure.Core.AccessToken>
override this.GetToken : Azure.Communication.CommunicationUserIdentifier * seq<Azure.Communication.Identity.CommunicationTokenScope> * TimeSpan * System.Threading.CancellationToken -> Azure.Response<Azure.Core.AccessToken>

Public Overridable Function GetToken (communicationUser As CommunicationUserIdentifier, scopes As IEnumerable(Of CommunicationTokenScope), tokenExpiresIn As TimeSpan, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AccessToken)

Parameters

communicationUser

CommunicationUserIdentifier

The CommunicationUserIdentifier for whom to get a Communication Identity access token.

scopes

IEnumerable<CommunicationTokenScope>

List of CommunicationTokenScope scopes for the token.

tokenExpiresIn

TimeSpan

Custom validity period of the token within [1,24] hours range.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<AccessToken>

Exceptions

RequestFailedException

The server returned an error.