Api Tokens - List

Service:

IoT Central

API Version:

2022-07-31

Obtenir la liste des jetons d’API dans une application. La valeur du jeton ne sera jamais retournée pour des raisons de sécurité.

GET https://{subdomain}.{baseDomain}/api/apiTokens?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.
api-version	query	True	string	Version de l’API appelée.

Réponses

Nom	Type	Description
200 OK	ApiTokenCollection	Succès
Other Status Codes	Error	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

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

Exemples

List API tokens

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "testtoken",
      "roles": [
        {
          "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
        },
        {
          "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.
ApiTokenCollection	Résultats paginés des jetons d’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.

ApiTokenCollection

Résultats paginés des jetons d’API.

Nom	Type	Description
nextLink	string	URL pour obtenir la page suivante des jetons d’API.
value	ApiToken[]	Collection de jetons 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.