Api Tokens - Create

Créez un jeton d’API dans l’application à utiliser dans l’API publique IoT Central. La valeur du jeton est retournée dans la réponse et ne sera pas retournée à nouveau dans les demandes suivantes.

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

Paramètres URI

Name In Required Type Description
baseDomain
path True
  • string

Domaine de base pour toutes les demandes de service Azure IoT Central.

subdomain
path True
  • string

Sous-domaine d’application.

tokenId
path True
  • string

ID unique pour le jeton d’API.

api-version
query True
  • string

Version de l’API appelée.

Corps de la demande

Name Required Type Description
roles True

Liste des attributions de rôles qui spécifient les autorisations d’accès à l’application.

expiry
  • string

Date au format chaîne représentant l’heure d’expiration du jeton.

Réponses

Name Type Description
200 OK

Succès

Other Status Codes

Réponse d’erreur reçue du service IoT Central.

Headers

  • x-ms-error-code: string

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Name Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

ApiToken

Définition du jeton d’accès à l’API.

Error

Définition de l’erreur de réponse.

ErrorDetails

Informations détaillées de l’erreur.

RoleAssignment

Définition de l’attribution de rôle.

ApiToken

Définition du jeton d’accès à l’API.

Name Type Description
expiry
  • string

Date au format chaîne représentant l’heure d’expiration du jeton.

id
  • string

ID unique du jeton d’API.

roles

Liste des attributions de rôles qui spécifient les autorisations d’accès à l’application.

token
  • string

Valeur du jeton d’API.

Error

Définition de l’erreur de réponse.

Name Type Description
error

Détails de l’erreur pour la requête actuelle.

ErrorDetails

Informations détaillées de l’erreur.

Name Type Description
code
  • string

Code d’erreur.

message
  • string

Détails du message d’erreur.

requestId
  • string

ID de corrélation pour la requête actuelle.

time
  • string

Heure à laquelle la demande d’erreur a échoué.

RoleAssignment

Définition de l’attribution de rôle.

Name Type Description
organization
  • string

ID de l’organisation pour cette attribution de rôle.

role
  • string

ID du rôle pour cette attribution de rôle.