CommunicationIdentityClient class

Paquete:

@azure/communication-identity

Clase de cliente para interactuar con la administración de tokens de usuario de Azure Communication Services.

Constructores

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)	Inicializa una nueva instancia de la clase CommunicationIdentity.
CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)	Inicializa una nueva instancia de la clase CommunicationIdentity mediante una instancia de Azure KeyCredential.
CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)	Inicializa una nueva instancia de la clase CommunicationIdentity mediante tokenCredential.

Métodos

createUser(OperationOptions)	Crea un único usuario.
createUserAndToken(TokenScope[], CreateUserAndTokenOptions)	Crea un único usuario y un token simultáneamente.
deleteUser(CommunicationUserIdentifier, OperationOptions)	Desencadena el evento de revocación para el usuario y elimina todos sus datos.
getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)	Crea un token de usuario con ámbito.
getTokenForTeamsUser(GetTokenForTeamsUserOptions)	Intercambia un token de acceso de Azure AD de un usuario de Teams para un nuevo token de acceso de Communication Identity con una fecha de expiración coincidente.
revokeTokens(CommunicationUserIdentifier, OperationOptions)	Revoca todos los datos y tokens creados para un usuario.

Detalles del constructor

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)

Inicializa una nueva instancia de la clase CommunicationIdentity.

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

Parámetros

connectionString

string

Cadena de conexión para conectarse a un recurso de Azure Communication Service. Ejemplo: "endpoint=https://contoso.eastus.communications.azure.net/; accesskey=secret";

options

CommunicationIdentityClientOptions

Opcional. Opciones para configurar la canalización HTTP.

CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)

Inicializa una nueva instancia de la clase CommunicationIdentity mediante una instancia de Azure KeyCredential.

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

Parámetros

endpoint

string

Punto de conexión del servicio (por ejemplo, https://contoso.eastus.communications.azure.net).

credential

KeyCredential

Objeto que se usa para autenticar solicitudes al servicio. Use AzureKeyCredential o @azure/identity para crear una credencial.

options

CommunicationIdentityClientOptions

Opcional. Opciones para configurar la canalización HTTP.

CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)

Inicializa una nueva instancia de la clase CommunicationIdentity mediante tokenCredential.

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

Parámetros

endpoint

string

Punto de conexión del servicio (por ejemplo: https://contoso.eastus.communications.azure.net)

credential

TokenCredential

TokenCredential que se usa para autenticar las solicitudes en el servicio.

options

CommunicationIdentityClientOptions

Opcional. Opciones para configurar la canalización HTTP.

Detalles del método

createUser(OperationOptions)

Crea un único usuario.

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

Parámetros

options

OperationOptions

Opciones adicionales para la solicitud.

Devoluciones

Promise<CommunicationUserIdentifier>

createUserAndToken(TokenScope[], CreateUserAndTokenOptions)

Crea un único usuario y un token simultáneamente.

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

Parámetros

scopes

TokenScope[]

Ámbitos que se van a incluir en el token.

options

CreateUserAndTokenOptions

Opciones adicionales para la solicitud.

Devoluciones

Promise<CommunicationUserToken>

deleteUser(CommunicationUserIdentifier, OperationOptions)

Desencadena el evento de revocación para el usuario y elimina todos sus datos.

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

Parámetros

user

CommunicationUserIdentifier

El usuario que se va a eliminar.

options

OperationOptions

Opciones adicionales para la solicitud.

Devoluciones

Promise<void>

getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)

Crea un token de usuario con ámbito.

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

Parámetros

user

CommunicationUserIdentifier

Usuario cuyos tokens se van a emitir.

scopes

TokenScope[]

Ámbitos que se van a incluir en el token.

options

GetTokenOptions

Opciones adicionales para la solicitud.

Devoluciones

Promise<CommunicationAccessToken>

getTokenForTeamsUser(GetTokenForTeamsUserOptions)

Intercambia un token de acceso de Azure AD de un usuario de Teams para un nuevo token de acceso de Communication Identity con una fecha de expiración coincidente.

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

Parámetros

options

GetTokenForTeamsUserOptions

Opciones que se usan para intercambiar un token de acceso de Azure AD de un usuario de Teams para un nuevo token de acceso de Communication Identity.

Devoluciones

Promise<CommunicationAccessToken>

revokeTokens(CommunicationUserIdentifier, OperationOptions)

Revoca todos los datos y tokens creados para un usuario.

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

Parámetros

user

CommunicationUserIdentifier

Usuario cuyos tokens se van a revocar.

options

OperationOptions

Opciones adicionales para la solicitud.

Devoluciones

Promise<void>