Api Tokens - Get

Service:

IoT Central

Version d'API:

2022-07-31

Obtenir un jeton d’API via son ID.

GET 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 de l’application.
tokenId	path	True	string	ID unique pour le jeton d’API.
api-version	query	True	string	Version de l’API appelée.

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

Get API token by ID

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

200

{
  "id": "testtoken",
  "roles": [
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ],
  "expiry": "2020-10-18T18:30:40.227Z"
}

Définitions

Nom	Description
ApiToken	Définition du jeton d’accès de 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 de 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 requête 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.