Freigeben über


Communication Identity - Issue Access Token

Stellen Sie ein neues Token für eine Identität aus.

POST {endpoint}/identities/{id}/:issueAccessToken?api-version=2023-10-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string

Die Kommunikationsressource, z. B. https://my-resource.communication.azure.com

id
path True

string

Bezeichner der Identität, für die das Token auszustellen ist.

api-version
query True

string

Version der aufgerufenen API.

Anforderungstext

Name Erforderlich Typ Beschreibung
scopes True

CommunicationIdentityTokenScope[]

Liste der Bereiche, die dem Token angefügt sind.

expiresInMinutes

integer

Optionaler benutzerdefinierter Gültigkeitszeitraum des Tokens innerhalb eines [60.1440] Minutenbereichs. Wenn nicht angegeben, wird der Standardwert von 1440 Minuten (24 Stunden) verwendet.

Antworten

Name Typ Beschreibung
200 OK

CommunicationIdentityAccessToken

Erfolg

Other Status Codes

CommunicationErrorResponse

Fehler

Beispiele

Issue an access token. Optionally specify a custom expiration time within the [60-1440] minutes range. In case an expiration time is not specified, the default value of 1440 minutes (24 hours) will be used.

Beispielanforderung

POST https://my-resource.communication.azure.com/identities/8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081/:issueAccessToken?api-version=2023-10-01

{
  "scopes": [
    "chat",
    "voip",
    "chat.join",
    "chat.join.limited",
    "voip.join"
  ],
  "expiresInMinutes": 60
}

Beispiel für eine Antwort

{
  "token": "token",
  "expiresOn": "2023-10-10T21:39:39.3244584+00:00"
}

Definitionen

Name Beschreibung
CommunicationError

Der Communication Services-Fehler.

CommunicationErrorResponse

Der Communication Services-Fehler.

CommunicationIdentityAccessToken

Ein Zugriffstoken.

CommunicationIdentityAccessTokenRequest
CommunicationIdentityTokenScope

Liste der Bereiche für ein Zugriffstoken.

CommunicationError

Der Communication Services-Fehler.

Name Typ Beschreibung
code

string

Der Fehlercode.

details

CommunicationError[]

Weitere Details zu bestimmten Fehlern, die zu diesem Fehler geführt haben.

innererror

CommunicationError

Der innere Fehler, falls vorhanden.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

CommunicationErrorResponse

Der Communication Services-Fehler.

Name Typ Beschreibung
error

CommunicationError

Der Communication Services-Fehler.

CommunicationIdentityAccessToken

Ein Zugriffstoken.

Name Typ Beschreibung
expiresOn

string

Der Ablaufzeitpunkt des Tokens.

token

string

Das für die Identität ausgestellte Zugriffstoken.

CommunicationIdentityAccessTokenRequest

Name Typ Standardwert Beschreibung
expiresInMinutes

integer

1440

Optionaler benutzerdefinierter Gültigkeitszeitraum des Tokens innerhalb eines [60.1440] Minutenbereichs. Wenn nicht angegeben, wird der Standardwert von 1440 Minuten (24 Stunden) verwendet.

scopes

CommunicationIdentityTokenScope[]

Liste der Bereiche, die dem Token angefügt sind.

CommunicationIdentityTokenScope

Liste der Bereiche für ein Zugriffstoken.

Name Typ Beschreibung
chat

string

Verwenden Sie dies für den vollzugriff auf Chat-APIs.

chat.join

string

Zugriff auf Chat-APIs, jedoch ohne die Autorisierung zum Erstellen, Löschen oder Aktualisieren von Chatthreads.

chat.join.limited

string

Eine eingeschränktere Version von chat.join, die das Hinzufügen oder Entfernen von Teilnehmern nicht zulässt. Verwenden Sie diesen Bereich, wenn der Tokenträger nicht vollständig vertrauenswürdig ist, z. B. in Gastszenarien.

voip

string

Verwenden Sie dies für den vollständigen Zugriff auf aufrufende APIs.

voip.join

string

Zugriff auf aufrufende APIs, aber ohne die Autorisierung, neue Aufrufe zu starten.