Api Tokens - Create

Cree un nuevo token de API en la aplicación para usarlo 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

Name In Required Type 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

Name Required Type Description
roles True

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

Name Type Description
200 OK

Correcto

Other Status Codes

Respuesta de error recibida del servicio IoT Central.

Headers

  • x-ms-error-code: string

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

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

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

Create API token

Sample Request

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

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

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.

Name Type 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

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.

Name Type Description
error

Detalles del error para la solicitud actual.

ErrorDetails

Información detallada del error.

Name Type 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.

Name Type 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.