Partager via

Api Tokens - Create

  • Référence
Service:
IoT Central
Version d'API:
2022-07-31

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

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

Paramètres URI

Nom Dans Obligatoire 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

Nom Obligatoire Type Description
roles True

RoleAssignment[]

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 à laquelle le jeton expire.

Réponses

Nom Type Description
200 OK

ApiToken

Succès
Other Status Codes

Error

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

En-têtes

x-ms-error-code: string

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

Create API token

Exemple de requête

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

Exemple de réponse

Code d’état:
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=..."
}

Définitions

Nom Description
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 d’attribution de rôle.

ApiToken

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

Nom Type Description
expiry

string

Date au format chaîne représentant l’heure à laquelle le jeton expire.
id

string

ID unique du jeton d’API.
roles

RoleAssignment[]

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.

Nom Type Description
error

ErrorDetails

Détails de l’erreur pour la demande actuelle.

ErrorDetails

Informations détaillées de l’erreur.

Nom 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 d’attribution de rôle.

Nom Type Description
organization

string

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

string

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