CommunicationIdentityClient class

Pacote:

@azure/communication-identity

Classe de cliente para interagir com o Gerenciamento de Token de Usuário dos Serviços de Comunicação do Azure.

Construtores

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)	Inicializa uma nova instância da classe CommunicationIdentity.
CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)	Inicializa uma nova instância da classe CommunicationIdentity usando uma KeyCredential do Azure.
CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)	Inicializa uma nova instância da classe CommunicationIdentity usando um TokenCredential.

Métodos

createUser(OperationOptions)	Cria um único usuário.
createUserAndToken(TokenScope[], CreateUserAndTokenOptions)	Cria um único usuário e um token simultaneamente.
deleteUser(CommunicationUserIdentifier, OperationOptions)	Aciona o evento de revogação para o usuário e exclui todos os seus dados.
getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)	Cria um token de usuário com escopo.
getTokenForTeamsUser(GetTokenForTeamsUserOptions)	Troca um token de acesso do Azure AD de um usuário do Teams por um novo token de acesso da Identidade de Comunicação com um tempo de expiração correspondente.
revokeTokens(CommunicationUserIdentifier, OperationOptions)	Revoga todos os dados e tokens criados para um usuário.

Detalhes do Construtor

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)

Inicializa uma nova instância da classe CommunicationIdentity.

new CommunicationIdentityClient(connectionString: string, options?: CommunicationIdentityClientOptions)

Parâmetros

connectionString

string

Cadeia de conexão para se conectar a um recurso do Serviço de Comunicação do Azure. Exemplo: "endpoint=https://contoso.eastus.communications.azure.net/; accesskey=secret";

options

CommunicationIdentityClientOptions

Opcional. Opções para configurar o pipeline HTTP.

CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)

Inicializa uma nova instância da classe CommunicationIdentity usando uma KeyCredential do Azure.

new CommunicationIdentityClient(endpoint: string, credential: KeyCredential, options?: CommunicationIdentityClientOptions)

Parâmetros

endpoint

string

O ponto de extremidade do serviço (por exemplo: https://contoso.eastus.communications.azure.net).

credential

KeyCredential

Um objeto que é usado para autenticar solicitações para o serviço. Use o AzureKeyCredential ou @azure/identity para criar uma credencial.

options

CommunicationIdentityClientOptions

Opcional. Opções para configurar o pipeline HTTP.

CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)

Inicializa uma nova instância da classe CommunicationIdentity usando um TokenCredential.

new CommunicationIdentityClient(endpoint: string, credential: TokenCredential, options?: CommunicationIdentityClientOptions)

Parâmetros

endpoint

string

O ponto de extremidade do serviço (por exemplo: https://contoso.eastus.communications.azure.net)

credential

TokenCredential

TokenCredential que é usado para autenticar solicitações para o serviço.

options

CommunicationIdentityClientOptions

Opcional. Opções para configurar o pipeline HTTP.

Detalhes de Método

createUser(OperationOptions)

Cria um único usuário.

function createUser(options?: OperationOptions): Promise<CommunicationUserIdentifier>

Parâmetros

options

OperationOptions

Opções adicionais para o pedido.

Devoluções

Promise<CommunicationUserIdentifier>

createUserAndToken(TokenScope[], CreateUserAndTokenOptions)

Cria um único usuário e um token simultaneamente.

function createUserAndToken(scopes: TokenScope[], options?: CreateUserAndTokenOptions): Promise<CommunicationUserToken>

Parâmetros

scopes

TokenScope[]

Escopos a serem incluídos no token.

options

CreateUserAndTokenOptions

Opções adicionais para o pedido.

Devoluções

Promise<CommunicationUserToken>

deleteUser(CommunicationUserIdentifier, OperationOptions)

Aciona o evento de revogação para o usuário e exclui todos os seus dados.

function deleteUser(user: CommunicationUserIdentifier, options?: OperationOptions): Promise<void>

Parâmetros

user

CommunicationUserIdentifier

O usuário que está sendo excluído.

options

OperationOptions

Opções adicionais para o pedido.

Devoluções

Promise<void>

getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)

Cria um token de usuário com escopo.

function getToken(user: CommunicationUserIdentifier, scopes: TokenScope[], options?: GetTokenOptions): Promise<CommunicationAccessToken>

Parâmetros

user

CommunicationUserIdentifier

O usuário cujos tokens estão sendo emitidos.

scopes

TokenScope[]

Escopos a serem incluídos no token.

options

GetTokenOptions

Opções adicionais para o pedido.

Devoluções

Promise<CommunicationAccessToken>

getTokenForTeamsUser(GetTokenForTeamsUserOptions)

Troca um token de acesso do Azure AD de um usuário do Teams por um novo token de acesso da Identidade de Comunicação com um tempo de expiração correspondente.

function getTokenForTeamsUser(options: GetTokenForTeamsUserOptions): Promise<CommunicationAccessToken>

Parâmetros

options

GetTokenForTeamsUserOptions

Opções usadas para trocar um token de acesso do Azure AD de um usuário do Teams por um novo token de acesso da Identidade de Comunicação.

Devoluções

Promise<CommunicationAccessToken>

revokeTokens(CommunicationUserIdentifier, OperationOptions)

Revoga todos os dados e tokens criados para um usuário.

function revokeTokens(user: CommunicationUserIdentifier, options?: OperationOptions): Promise<void>

Parâmetros

user

CommunicationUserIdentifier

O usuário cujos tokens estão sendo revogados.

options

OperationOptions

Opções adicionais para o pedido.

Devoluções

Promise<void>