Api Tokens - Get

Dienst:

IoT Central

API-Version:

2022-07-31

Rufen Sie ein API-Token nach ID ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
baseDomain	path	True	string	Die Basisdomäne für alle Azure IoT Central-Dienstanforderungen.
subdomain	path	True	string	Die Anwendungsdomäne.
tokenId	path	True	string	Eindeutige ID für das API-Token.
api-version	query	True	string	Die Version der aufgerufenen API.

Antworten

Name	Typ	Beschreibung
200 OK	ApiToken	Erfolg
Other Status Codes	Error	Eine Vom IoT Central Service empfangene Fehlerantwort. Header x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get API token by ID

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
ApiToken	Die API-Zugriffstokendefinition.
Error	Die Antwortfehlerdefinition.
ErrorDetails	Die Detailinformationen des Fehlers.
RoleAssignment	Die Rollenzuweisungsdefinition.

ApiToken

Objekt

Die API-Zugriffstokendefinition.

Name	Typ	Beschreibung
expiry	string (date-time)	Zeichenfolgenformatiertes Datum, das die Uhrzeit darstellt, zu der das Token abläuft.
id	string	Eindeutige ID des API-Tokens.
roles	RoleAssignment[]	Liste der Rollenzuweisungen, die die Berechtigungen für den Zugriff auf die Anwendung angeben.
token	string	Wert des API-Tokens.

Error

Objekt

Die Antwortfehlerdefinition.

Name	Typ	Beschreibung
error	ErrorDetails	Fehlerdetails für die aktuelle Anforderung.

ErrorDetails

Objekt

Die Detailinformationen des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldungsdetails.
requestId	string	Korrelations-ID für aktuelle Anforderung.
time	string (date-time-rfc1123)	Der Zeitpunkt, zu dem die Fehleranforderung fehlgeschlagen ist.

RoleAssignment

Objekt

Die Rollenzuweisungsdefinition.

Name	Typ	Beschreibung
organization	string	ID der Organisation für diese Rollenzuweisung.
role	string	ID der Rolle für diese Rollenzuweisung.