CommunicationIdentityClient class

Paket:

@azure/communication-identity

Klientklass för interaktion med Hantering av användartoken för Azure Communication Services.

Konstruktorer

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)	Initierar en ny instans av klassen CommunicationIdentity.
CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)	Initierar en ny instans av klassen CommunicationIdentity med hjälp av en Azure KeyCredential.
CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)	Initierar en ny instans av klassen CommunicationIdentity med hjälp av en TokenCredential.

Metoder

createUser(OperationOptions)	Skapar en enskild användare.
createUserAndToken(TokenScope[], CreateUserAndTokenOptions)	Skapar en enskild användare och en token samtidigt.
deleteUser(CommunicationUserIdentifier, OperationOptions)	Utlöser återkallningshändelse för användare och tar bort alla dess data.
getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)	Skapar en begränsad användartoken.
getTokenForTeamsUser(GetTokenForTeamsUserOptions)	Utbyter en Azure AD-åtkomsttoken för en Teams-användare för en ny åtkomsttoken för kommunikationsidentitet med matchande förfallotid.
revokeTokens(CommunicationUserIdentifier, OperationOptions)	Återkallar alla data och token som skapats för en användare.

Konstruktorinformation

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)

Initierar en ny instans av klassen CommunicationIdentity.

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

Parametrar

connectionString

string

Anslutningssträng för att ansluta till en Azure Communication Service-resurs. Exempel: "endpoint=https://contoso.eastus.communications.azure.net/; accesskey=secret";

options

CommunicationIdentityClientOptions

Valfri. Alternativ för att konfigurera HTTP-pipelinen.

CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)

Initierar en ny instans av klassen CommunicationIdentity med hjälp av en Azure KeyCredential.

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

Parametrar

endpoint

string

Tjänstens slutpunkt (till exempel https://contoso.eastus.communications.azure.net).

credential

KeyCredential

Ett objekt som används för att autentisera begäranden till tjänsten. Använd AzureKeyCredential eller @azure/identity för att skapa en autentiseringsuppgift.

options

CommunicationIdentityClientOptions

Valfri. Alternativ för att konfigurera HTTP-pipelinen.

CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)

Initierar en ny instans av klassen CommunicationIdentity med hjälp av en TokenCredential.

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

Parametrar

endpoint

string

Tjänstens slutpunkt (till exempel https://contoso.eastus.communications.azure.net)

credential

TokenCredential

TokenCredential som används för att autentisera begäranden till tjänsten.

options

CommunicationIdentityClientOptions

Valfri. Alternativ för att konfigurera HTTP-pipelinen.

Metodinformation

createUser(OperationOptions)

Skapar en enskild användare.

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

Parametrar

options

OperationOptions

Ytterligare alternativ för begäran.

Returer

Promise<CommunicationUserIdentifier>

createUserAndToken(TokenScope[], CreateUserAndTokenOptions)

Skapar en enskild användare och en token samtidigt.

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

Parametrar

scopes

TokenScope[]

Omfång som ska ingå i token.

options

CreateUserAndTokenOptions

Ytterligare alternativ för begäran.

Returer

Promise<CommunicationUserToken>

deleteUser(CommunicationUserIdentifier, OperationOptions)

Utlöser återkallningshändelse för användare och tar bort alla dess data.

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

Parametrar

user

CommunicationUserIdentifier

Användaren som tas bort.

options

OperationOptions

Ytterligare alternativ för begäran.

Returer

Promise<void>

getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)

Skapar en begränsad användartoken.

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

Parametrar

user

CommunicationUserIdentifier

Den användare vars token utfärdas.

scopes

TokenScope[]

Omfång som ska ingå i token.

options

GetTokenOptions

Ytterligare alternativ för begäran.

Returer

Promise<CommunicationAccessToken>

getTokenForTeamsUser(GetTokenForTeamsUserOptions)

Utbyter en Azure AD-åtkomsttoken för en Teams-användare för en ny åtkomsttoken för kommunikationsidentitet med matchande förfallotid.

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

Parametrar

options

GetTokenForTeamsUserOptions

Alternativ som används för att byta ut en Azure AD-åtkomsttoken för en Teams-användare mot en ny åtkomsttoken för kommunikationsidentitet.

Returer

Promise<CommunicationAccessToken>

revokeTokens(CommunicationUserIdentifier, OperationOptions)

Återkallar alla data och token som skapats för en användare.

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

Parametrar

user

CommunicationUserIdentifier

Den användare vars token återkallas.

options

OperationOptions

Ytterligare alternativ för begäran.

Returer

Promise<void>