Communication Identity - Create

Referenz

Service:: Communication

API Version:: 2023-10-01

Erstellen Sie eine neue Identität und optional ein Zugriffstoken.

POST {endpoint}/identities?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
api-version	query	True	string	Version der aufzurufenden API.

Anforderungstext

Name	Typ	Beschreibung
createTokenWithScopes	CommunicationIdentityTokenScope[]	Erstellen Sie außerdem ein Zugriffstoken für die erstellte Identität.
expiresInMinutes	integer	Optionaler benutzerdefinierter Gültigkeitszeitraum des Tokens innerhalb des Bereichs [60,1440] Minuten. Wenn nicht angegeben, wird der Standardwert 1440 Minuten (24 Stunden) verwendet.

Antworten

Name	Typ	Beschreibung
201 Created	CommunicationIdentityAccessTokenResult	Erstellt: Gibt die erstellte Identität zurück.
Other Status Codes	CommunicationErrorResponse	Fehler

Beispiele

Create an Identity and optionally an access token with custom expiration time within the [60-1440] minutes range. If expiration time is not specified, the default value of 1440 minutes (24 hours) will be used.

Sample Request

HTTP

POST https://my-resource.communication.azure.com/identities?api-version=2023-10-01

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

Sample Response

Status code:: 201

{
  "identity": {
    "id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081"
  },
  "accessToken": {
    "token": "token",
    "expiresOn": "2023-10-10T21:39:39.3244584+00:00"
  }
}

Definitionen

Name	Beschreibung
CommunicationError	Der Communication Services-Fehler.
CommunicationErrorResponse	Der Communication Services-Fehler.
CommunicationIdentity	Eine Kommunikationsidentität.
CommunicationIdentityAccessToken	Ein Zugriffstoken.
CommunicationIdentityAccessTokenResult	Eine Kommunikationsidentität mit Zugriffstoken.
CommunicationIdentityCreateRequest
CommunicationIdentityTokenScope	Liste der Bereiche für ein Zugriffstoken.

CommunicationError

Der Communication Services-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	CommunicationError[]	Weitere Informationen 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.

CommunicationIdentity

Eine Kommunikationsidentität.

Name	Typ	Beschreibung
id	string	Bezeichner der Identität.

CommunicationIdentityAccessToken

Ein Zugriffstoken.

Name	Typ	Beschreibung
expiresOn	string	Der Ablaufzeitpunkt des Tokens.
token	string	Das für die Identität ausgestellte Zugriffstoken.

CommunicationIdentityAccessTokenResult

Eine Kommunikationsidentität mit Zugriffstoken.

Name	Typ	Beschreibung
accessToken	CommunicationIdentityAccessToken	Ein Zugriffstoken.
identity	CommunicationIdentity	Eine Kommunikationsidentität.

CommunicationIdentityCreateRequest

Name	Typ	Standardwert	Beschreibung
createTokenWithScopes	CommunicationIdentityTokenScope[]		Erstellen Sie außerdem ein Zugriffstoken für die erstellte Identität.
expiresInMinutes	integer	1440	Optionaler benutzerdefinierter Gültigkeitszeitraum des Tokens innerhalb des Bereichs [60,1440] Minuten. Wenn nicht angegeben, wird der Standardwert 1440 Minuten (24 Stunden) verwendet.

CommunicationIdentityTokenScope

Liste der Bereiche für ein Zugriffstoken.

Name	Typ	Beschreibung
chat	string	Verwenden Sie dies für vollzugriff auf Chat-APIs.
chat.join	string	Zugriff auf Chat-APIs, aber 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 Token-Bearer nicht vollständig vertrauenswürdig ist, z. B. in Gastszenarien.
voip	string	Verwenden Sie dies für den Vollzugriff auf aufrufende APIs.
voip.join	string	Zugriff auf Aufrufen von APIs, jedoch ohne die Autorisierung zum Starten neuer Aufrufe.

Freigeben über