CommunicationIdentityClient class
Clientklasse voor interactie met Gebruikerstokenbeheer van Azure Communication Services.
Constructors
| Communication |
Initialiseert een nieuw exemplaar van de CommunicationIdentity-klasse. |
| Communication |
Initialiseert een nieuw exemplaar van de CommunicationIdentity-klasse met behulp van een Azure KeyCredential. |
| Communication |
Initialiseert een nieuw exemplaar van de CommunicationIdentity-klasse met behulp van een TokenCredential. |
Methoden
| create |
Hiermee maakt u één gebruiker. |
| create |
Hiermee maakt u één gebruiker en een token tegelijk. |
| delete |
Hiermee activeert u de intrekkings gebeurtenis voor de gebruiker en verwijdert u alle bijbehorende gegevens. |
| get |
Hiermee maakt u een token van een gebruiker met een bereik. |
| get |
Hiermee wordt een Azure AD-toegangstoken van een Teams-gebruiker uitgewisseld voor een nieuw communicatieidentiteitstoegangstoken met een overeenkomende verlooptijd. |
| revoke |
Hiermee worden alle gegevens en tokens ingetrokken die voor een gebruiker zijn gemaakt. |
Constructordetails
CommunicationIdentityClient(string, CommunicationIdentityClientOptions)
Initialiseert een nieuw exemplaar van de CommunicationIdentity-klasse.
new CommunicationIdentityClient(connectionString: string, options?: CommunicationIdentityClientOptions)Parameters
- connectionString
-
string
Verbindingsreeks om verbinding te maken met een Azure Communication Service-resource. Voorbeeld: "endpoint=https://contoso.eastus.communications.azure.net/; accesskey=secret";
Facultatief. Opties voor het configureren van de HTTP-pijplijn.
CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)
Initialiseert een nieuw exemplaar van de CommunicationIdentity-klasse met behulp van een Azure KeyCredential.
new CommunicationIdentityClient(endpoint: string, credential: KeyCredential, options?: CommunicationIdentityClientOptions)Parameters
- endpoint
-
string
Het eindpunt van de service (bijvoorbeeld: https://contoso.eastus.communications.azure.net).
- credential
- KeyCredential
Een object dat wordt gebruikt voor het verifiëren van aanvragen voor de service. Gebruik azureKeyCredential of @azure/identity om een referentie te maken.
Facultatief. Opties voor het configureren van de HTTP-pijplijn.
CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)
Initialiseert een nieuw exemplaar van de CommunicationIdentity-klasse met behulp van een TokenCredential.
new CommunicationIdentityClient(endpoint: string, credential: TokenCredential, options?: CommunicationIdentityClientOptions)Parameters
- endpoint
-
string
Het eindpunt van de service (bijvoorbeeld: https://contoso.eastus.communications.azure.net)
- credential
- TokenCredential
TokenCredential die wordt gebruikt voor het verifiëren van aanvragen voor de service.
Facultatief. Opties voor het configureren van de HTTP-pijplijn.
Methodedetails
createUser(OperationOptions)
Hiermee maakt u één gebruiker.
function createUser(options?: OperationOptions): Promise<CommunicationUserIdentifier>Parameters
- options
- OperationOptions
Aanvullende opties voor de aanvraag.
Retouren
Promise<CommunicationUserIdentifier>
createUserAndToken(TokenScope[], CreateUserAndTokenOptions)
Hiermee maakt u één gebruiker en een token tegelijk.
function createUserAndToken(scopes: TokenScope[], options?: CreateUserAndTokenOptions): Promise<CommunicationUserToken>Parameters
- scopes
Bereiken die moeten worden opgenomen in het token.
- options
- CreateUserAndTokenOptions
Aanvullende opties voor de aanvraag.
Retouren
Promise<CommunicationUserToken>
deleteUser(CommunicationUserIdentifier, OperationOptions)
Hiermee activeert u de intrekkings gebeurtenis voor de gebruiker en verwijdert u alle bijbehorende gegevens.
function deleteUser(user: CommunicationUserIdentifier, options?: OperationOptions): Promise<void>Parameters
De gebruiker die wordt verwijderd.
- options
- OperationOptions
Aanvullende opties voor de aanvraag.
Retouren
Promise<void>
getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)
Hiermee maakt u een token van een gebruiker met een bereik.
function getToken(user: CommunicationUserIdentifier, scopes: TokenScope[], options?: GetTokenOptions): Promise<CommunicationAccessToken>Parameters
De gebruiker waarvan de tokens worden uitgegeven.
- scopes
Bereiken die moeten worden opgenomen in het token.
- options
- GetTokenOptions
Aanvullende opties voor de aanvraag.
Retouren
Promise<CommunicationAccessToken>
getTokenForTeamsUser(GetTokenForTeamsUserOptions)
Hiermee wordt een Azure AD-toegangstoken van een Teams-gebruiker uitgewisseld voor een nieuw communicatieidentiteitstoegangstoken met een overeenkomende verlooptijd.
function getTokenForTeamsUser(options: GetTokenForTeamsUserOptions): Promise<CommunicationAccessToken>Parameters
- options
- GetTokenForTeamsUserOptions
Opties die worden gebruikt voor het uitwisselen van een Azure AD-toegangstoken van een Teams-gebruiker voor een nieuw toegangstoken voor communicatie-identiteit.
Retouren
Promise<CommunicationAccessToken>
revokeTokens(CommunicationUserIdentifier, OperationOptions)
Hiermee worden alle gegevens en tokens ingetrokken die voor een gebruiker zijn gemaakt.
function revokeTokens(user: CommunicationUserIdentifier, options?: OperationOptions): Promise<void>Parameters
De gebruiker waarvan de tokens worden ingetrokken.
- options
- OperationOptions
Aanvullende opties voor de aanvraag.
Retouren
Promise<void>