Communication Identity - Issue Access Token

Service:

Communication

API Version:

2023-10-01

Utfärda en ny token för en identitet.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Kommunikationsresursen, till exempel https://my-resource.communication.azure.com
id	path	True	string	Identifierare för den identitet som token ska utfärdas för.
api-version	query	True	string	Version av API som ska anropas.

Begärandetext

Name	Obligatorisk	Typ	Description
scopes	True	CommunicationIdentityTokenScope[]	Lista över omfång som är kopplade till token.
expiresInMinutes		integer	Valfri anpassad giltighetsperiod för token inom [60 1440] minuters intervall. Om det inte anges används standardvärdet 1 440 minuter (24 timmar).

Svar

Name	Typ	Description
200 OK	CommunicationIdentityAccessToken	Klart
Other Status Codes	CommunicationErrorResponse	Fel

Exempel

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.

Sample Request

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
}

Sample Response

Status code:

200

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

Definitioner

Name	Description
CommunicationError	Kommunikationstjänstens fel.
CommunicationErrorResponse	Kommunikationstjänstens fel.
CommunicationIdentityAccessToken	En åtkomsttoken.
CommunicationIdentityAccessTokenRequest
CommunicationIdentityTokenScope	Lista över omfång för en åtkomsttoken.

CommunicationError

Kommunikationstjänstens fel.

Name	Typ	Description
code	string	Felkoden.
details	CommunicationError[]	Mer information om specifika fel som ledde till det här felet.
innererror	CommunicationError	Det inre felet om det finns något.
message	string	Felmeddelandet.
target	string	Felmålet.

CommunicationErrorResponse

Kommunikationstjänstens fel.

Name	Typ	Description
error	CommunicationError	Kommunikationstjänstens fel.

CommunicationIdentityAccessToken

En åtkomsttoken.

Name	Typ	Description
expiresOn	string	Förfallotiden för token.
token	string	Den åtkomsttoken som utfärdats för identiteten.

CommunicationIdentityAccessTokenRequest

Name	Typ	Standardvärde	Description
expiresInMinutes	integer	1440	Valfri anpassad giltighetsperiod för token inom [60 1440] minuters intervall. Om det inte anges används standardvärdet 1 440 minuter (24 timmar).
scopes	CommunicationIdentityTokenScope[]		Lista över omfång som är kopplade till token.

CommunicationIdentityTokenScope

Lista över omfång för en åtkomsttoken.

Name	Typ	Description
chat	string	Använd detta för fullständig åtkomst till chatt-API:er.
chat.join	string	Åtkomst till chatt-API:er men utan behörighet att skapa, ta bort eller uppdatera chatttrådar.
chat.join.limited	string	En mer begränsad version av chat.join som inte tillåter att deltagare läggs till eller avlägsnas. Använd det här omfånget när tokenbäraren inte är helt betrodd, till exempel i gästscenarier.
voip	string	Använd detta för fullständig åtkomst till anropande API:er.
voip.join	string	Åtkomst till anropande API:er men utan behörighet att starta nya anrop.