Communication Identity - Issue Access Token

Service:

Communication

Version d'API:

2023-10-01

Émettez un nouveau jeton pour une identité.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	Ressource de communication, par exemple https://my-resource.communication.azure.com
id	path	True	string	Identificateur de l’identité pour laquelle émettre le jeton.
api-version	query	True	string	Version de l’API à appeler.

Corps de la demande

Nom	Obligatoire	Type	Description
scopes	True	CommunicationIdentityTokenScope[]	Liste des étendues attachées au jeton.
expiresInMinutes		integer	Période de validité personnalisée facultative du jeton dans la plage de [60 1440] minutes. Si elle n’est pas fournie, la valeur par défaut de 1440 minutes (24 heures) est utilisée.

Réponses

Nom	Type	Description
200 OK	CommunicationIdentityAccessToken	Succès
Other Status Codes	CommunicationErrorResponse	Erreur

Exemples

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.

Exemple de requête

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
}

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
CommunicationError	Erreur Communication Services.
CommunicationErrorResponse	Erreur Communication Services.
CommunicationIdentityAccessToken	Jeton d’accès.
CommunicationIdentityAccessTokenRequest
CommunicationIdentityTokenScope	Liste des étendues d’un jeton d’accès.

CommunicationError

Erreur Communication Services.

Nom	Type	Description
code	string	Code d’erreur.
details	CommunicationError[]	Plus d’informations sur les erreurs spécifiques qui ont conduit à cette erreur.
innererror	CommunicationError	Erreur interne le cas échéant.
message	string	Message d’erreur.
target	string	Cible d’erreur.

CommunicationErrorResponse

Erreur Communication Services.

Nom	Type	Description
error	CommunicationError	Erreur Communication Services.

CommunicationIdentityAccessToken

Jeton d’accès.

Nom	Type	Description
expiresOn	string	Heure d’expiration du jeton.
token	string	Jeton d’accès émis pour l’identité.

CommunicationIdentityAccessTokenRequest

Nom	Type	Valeur par défaut	Description
expiresInMinutes	integer	1440	Période de validité personnalisée facultative du jeton dans la plage de [60 1440] minutes. Si elle n’est pas fournie, la valeur par défaut de 1440 minutes (24 heures) est utilisée.
scopes	CommunicationIdentityTokenScope[]		Liste des étendues attachées au jeton.

CommunicationIdentityTokenScope

Liste des étendues d’un jeton d’accès.

Nom	Type	Description
chat	string	Utilisez cette option pour un accès complet aux API de conversation.
chat.join	string	Accès aux API de conversation, mais sans l’autorisation de créer, supprimer ou mettre à jour des threads de conversation.
chat.join.limited	string	Version plus limitée de chat.join qui ne permet pas d’ajouter ou de supprimer des participants. Utilisez cette étendue lorsque le porteur de jeton n’est pas entièrement approuvé, par exemple dans les scénarios invités.
voip	string	Utilisez cette option pour un accès complet aux API appelantes.
voip.join	string	Accès aux API d’appel, mais sans l’autorisation de démarrer de nouveaux appels.