Communication Identity - Issue Access Token

Service:

Communication

API-versie:

2023-10-01

Geef een nieuw token voor een identiteit.

POST {endpoint}/identities/{id}/:issueAccessToken?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
id	path	True	string	Id van de identiteit waarvoor token moet worden opgegeven.
api-version	query	True	string	De versie van de API die moet worden aangeroepen.

Aanvraagbody

Name	Vereist	Type	Description
scopes	True	CommunicationIdentityTokenScope[]	Lijst met bereiken die zijn gekoppeld aan het token.
expiresInMinutes		integer (int32) minimum: 60 maximum: 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.

Antwoorden

Name	Type	Description
200 OK	CommunicationIdentityAccessToken	Succes
Other Status Codes	CommunicationErrorResponse	Fout

Voorbeelden

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.

Voorbeeldaanvraag

HTTP

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
}

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
CommunicationError	De Communication Services-fout.
CommunicationErrorResponse	De Communication Services-fout.
CommunicationIdentityAccessToken	Een toegangstoken.
CommunicationIdentityAccessTokenRequest
CommunicationIdentityTokenScope	Lijst met bereiken voor een toegangstoken.

CommunicationError

Object

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

Object

De Communication Services-fout.

Name	Type	Description
error	CommunicationError	De Communication Services-fout.

CommunicationIdentityAccessToken

Object

Een toegangstoken.

Name	Type	Description
expiresOn	string (date-time)	De verlooptijd van het token.
token	string	Het toegangstoken dat is uitgegeven voor de identiteit.

CommunicationIdentityAccessTokenRequest

Object

Name	Type	Default value	Description
expiresInMinutes	integer (int32) minimum: 60 maximum: 1440	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.
scopes	CommunicationIdentityTokenScope[]		Lijst met bereiken die zijn gekoppeld aan het token.

CommunicationIdentityTokenScope

Inventarisatie

Lijst met bereiken voor een toegangstoken.

Waarde	Description
chat	Gebruik dit voor volledige toegang tot Chat-API's.
chat.join	Toegang tot chat-API's, maar zonder de autorisatie om chatthreads te maken, te verwijderen of bij te werken.
chat.join.limited	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	Gebruik dit voor volledige toegang tot aanroepende API's.
voip.join	Toegang tot aanroepende API's, maar zonder de autorisatie om nieuwe aanroepen te starten.