Api Tokens - Create

Service:

IoT Central

API Version:

2022-07-31

Cree un nuevo token de API en la aplicación que se usará en la API pública de IoT Central. El valor del token se devolverá en la respuesta y no se devolverá de nuevo en las solicitudes posteriores.

PUT https://{subdomain}.{baseDomain}/api/apiTokens/{tokenId}?api-version=2022-07-31

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
baseDomain	path	True	string	Dominio base para todas las solicitudes de servicio de Azure IoT Central.
subdomain	path	True	string	Subdominio de aplicación.
tokenId	path	True	string	Identificador único del token de API.
api-version	query	True	string	Versión de la API a la que se llama.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
roles	True	RoleAssignment[]	Lista de asignaciones de roles que especifican los permisos para acceder a la aplicación.
expiry		string	Fecha con formato de cadena que representa la hora en que expira el token.

Respuestas

Nombre	Tipo	Description
200 OK	ApiToken	Correcto
Other Status Codes	Error	Respuesta de error recibida del servicio IoT Central. Headers x-ms-error-code: string

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Create API token

Sample Request

HTTP

PUT https://appsubdomain.azureiotcentral.com/api/apiTokens/testtoken?api-version=2022-07-31

{
  "roles": [
    {
      "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ]
}

Sample Response

Status code:

200

{
  "id": "testtoken",
  "roles": [
    {
      "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ],
  "expiry": "2020-10-18T18:30:40.227Z",
  "token": "SharedAccessSignature sr=..."
}

Definiciones

Nombre	Description
ApiToken	Definición del token de acceso de API.
Error	Definición de error de respuesta.
ErrorDetails	Información detallada del error.
RoleAssignment	Definición de asignación de roles.

ApiToken

Definición del token de acceso de API.

Nombre	Tipo	Description
expiry	string	Fecha con formato de cadena que representa la hora en que expira el token.
id	string	Identificador único del token de API.
roles	RoleAssignment[]	Lista de asignaciones de roles que especifican los permisos para acceder a la aplicación.
token	string	Valor del token de API.

Error

Definición de error de respuesta.

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error para la solicitud actual.

ErrorDetails

Información detallada del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Detalles del mensaje de error.
requestId	string	Id. de correlación para la solicitud actual.
time	string	Hora en que se produjo un error en la solicitud de error.

RoleAssignment

Definición de asignación de roles.

Nombre	Tipo	Description
organization	string	Identificador de la organización para esta asignación de roles.
role	string	Identificador del rol para esta asignación de roles.