Freigeben über


Api Tokens - Get

Abrufen eines API-Tokens anhand der ID

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 Anwendungsunterdomä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.

Headers

x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Get API token by ID

Sample Request

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

Sample Response

{
  "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

Die API-Zugriffstokendefinition.

Name Typ Beschreibung
expiry

string

Zeichenfolgenformatiertes Datum, das die Zeit 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

Die Antwortfehlerdefinition.

Name Typ Beschreibung
error

ErrorDetails

Fehlerdetails für die aktuelle Anforderung.

ErrorDetails

Die Detailinformationen des Fehlers.

Name Typ Beschreibung
code

string

Fehlercode

message

string

Fehlermeldungsdetails.

requestId

string

Korrelations-ID für die aktuelle Anforderung.

time

string

Der Zeitpunkt, zu dem die Fehleranforderung fehlgeschlagen ist.

RoleAssignment

Die Rollenzuweisungsdefinition.

Name Typ Beschreibung
organization

string

ID des organization für diese Rollenzuweisung.

role

string

ID der Rolle für diese Rollenzuweisung.