Communication Identity - Create

Referencia

Servicio:: Communication

Versión de la API:: 2023-10-01

Cree una nueva identidad y, opcionalmente, un token de acceso.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Recurso de comunicación, por ejemplo, https://my-resource.communication.azure.com
api-version	query	True	string	Versión de la API que se va a invocar.

Cuerpo de la solicitud

Nombre	Tipo	Description
createTokenWithScopes	CommunicationIdentityTokenScope[]	Cree también el token de acceso para la identidad creada.
expiresInMinutes	integer	Período de validez personalizado opcional del token dentro del intervalo de [60 1440]. Si no se proporciona, se usará el valor predeterminado de 1440 minutos (24 horas).

Respuestas

Nombre	Tipo	Description
201 Created	CommunicationIdentityAccessTokenResult	Creado: devuelve la identidad creada.
Other Status Codes	CommunicationErrorResponse	Error

Ejemplos

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.

Solicitud de ejemplo

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
}

Respuesta de muestra

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

Definiciones

Nombre	Description
CommunicationError	Error de Communication Services.
CommunicationErrorResponse	Error de Communication Services.
CommunicationIdentity	Una identidad de comunicación.
CommunicationIdentityAccessToken	Un token de acceso.
CommunicationIdentityAccessTokenResult	Una identidad de comunicación con token de acceso.
CommunicationIdentityCreateRequest
CommunicationIdentityTokenScope	Lista de ámbitos de un token de acceso.

CommunicationError

Error de Communication Services.

Nombre	Tipo	Description
code	string	Código de error.
details	CommunicationError[]	Más detalles sobre los errores específicos que llevaron a este error.
innererror	CommunicationError	Error interno si existe.
message	string	Mensaje de error.
target	string	Destino del error.

CommunicationErrorResponse

Error de Communication Services.

Nombre	Tipo	Description
error	CommunicationError	Error de Communication Services.

CommunicationIdentity

Una identidad de comunicación.

Nombre	Tipo	Description
id	string	Identificador de la identidad.

CommunicationIdentityAccessToken

Un token de acceso.

Nombre	Tipo	Description
expiresOn	string	Hora de expiración del token.
token	string	Token de acceso emitido para la identidad.

CommunicationIdentityAccessTokenResult

Una identidad de comunicación con token de acceso.

Nombre	Tipo	Description
accessToken	CommunicationIdentityAccessToken	Un token de acceso.
identity	CommunicationIdentity	Una identidad de comunicación.

CommunicationIdentityCreateRequest

Nombre	Tipo	Valor predeterminado	Description
createTokenWithScopes	CommunicationIdentityTokenScope[]		Cree también el token de acceso para la identidad creada.
expiresInMinutes	integer	1440	Período de validez personalizado opcional del token dentro del intervalo de [60 1440]. Si no se proporciona, se usará el valor predeterminado de 1440 minutos (24 horas).

CommunicationIdentityTokenScope

Lista de ámbitos de un token de acceso.

Nombre	Tipo	Description
chat	string	Úselo para obtener acceso completo a las API de chat.
chat.join	string	Acceso a las API de chat, pero sin la autorización para crear, eliminar o actualizar subprocesos de chat.
chat.join.limited	string	Una versión más limitada de chat.join que no permite agregar ni quitar participantes. Use este ámbito cuando el portador de tokens no sea de plena confianza, por ejemplo, en escenarios invitados.
voip	string	Úselo para obtener acceso completo a las API de llamada.
voip.join	string	Acceso a las API de llamada, pero sin la autorización para iniciar nuevas llamadas.

Compartir a través de