Communication Identity - Create

Referentie

Service:: Communication

API-versie:: 2023-10-01

Maak een nieuwe identiteit en eventueel een toegangstoken.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	De communicatieresource, bijvoorbeeld https://my-resource.communication.azure.com
api-version	query	True	string	De versie van de API die moet worden aangeroepen.

Aanvraagbody

Name	Type	Description
createTokenWithScopes	CommunicationIdentityTokenScope[]	Maak ook een toegangstoken voor de gemaakte identiteit.
expiresInMinutes	integer	Optionele aangepaste geldigheidsperiode van het token binnen het bereik van [60.1440] minuten. Indien niet opgegeven, wordt de standaardwaarde van 1440 minuten (24 uur) gebruikt.

Antwoorden

Name	Type	Description
201 Created	CommunicationIdentityAccessTokenResult	Gemaakt: retourneert de gemaakte identiteit.
Other Status Codes	CommunicationErrorResponse	Fout

Voorbeelden

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.

Voorbeeldaanvraag

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
}

Voorbeeldrespons

Statuscode:: 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"
  }
}

Definities

Name	Description
CommunicationError	De Communication Services-fout.
CommunicationErrorResponse	De Communication Services-fout.
CommunicationIdentity	Een communicatie-identiteit.
CommunicationIdentityAccessToken	Een toegangstoken.
CommunicationIdentityAccessTokenResult	Een communicatie-identiteit met toegangstoken.
CommunicationIdentityCreateRequest
CommunicationIdentityTokenScope	Lijst met bereiken voor een toegangstoken.

CommunicationError

De Communication Services-fout.

Name	Type	Description
code	string	De foutcode.
details	CommunicationError[]	Meer informatie over specifieke fouten die tot deze fout hebben geleid.
innererror	CommunicationError	De interne fout indien aanwezig.
message	string	Het foutbericht.
target	string	Het foutdoel.

CommunicationErrorResponse

De Communication Services-fout.

Name	Type	Description
error	CommunicationError	De Communication Services-fout.

CommunicationIdentity

Een communicatie-identiteit.

Name	Type	Description
id	string	Id van de identiteit.

CommunicationIdentityAccessToken

Een toegangstoken.

Name	Type	Description
expiresOn	string	De verlooptijd van het token.
token	string	Het toegangstoken dat is uitgegeven voor de identiteit.

CommunicationIdentityAccessTokenResult

Een communicatie-identiteit met toegangstoken.

Name	Type	Description
accessToken	CommunicationIdentityAccessToken	Een toegangstoken.
identity	CommunicationIdentity	Een communicatie-identiteit.

CommunicationIdentityCreateRequest

Name	Type	Default value	Description
createTokenWithScopes	CommunicationIdentityTokenScope[]		Maak ook een toegangstoken voor de gemaakte identiteit.
expiresInMinutes	integer	1440	Optionele aangepaste geldigheidsperiode van het token binnen het bereik van [60.1440] minuten. Indien niet opgegeven, wordt de standaardwaarde van 1440 minuten (24 uur) gebruikt.

CommunicationIdentityTokenScope

Lijst met bereiken voor een toegangstoken.

Name	Type	Description
chat	string	Gebruik dit voor volledige toegang tot Chat-API's.
chat.join	string	Toegang tot chat-API's, maar zonder de autorisatie om chatthreads te maken, te verwijderen of bij te werken.
chat.join.limited	string	Een beperktere versie van chat.join waarmee deelnemers niet kunnen worden toegevoegd of verwijderd. Gebruik dit bereik wanneer de tokenbeer niet volledig wordt vertrouwd, bijvoorbeeld in gastscenario's.
voip	string	Gebruik dit voor volledige toegang tot aanroepende API's.
voip.join	string	Toegang tot aanroepende API's, maar zonder de autorisatie om nieuwe aanroepen te starten.

Delen via