Api Tokens - List

Service:

IoT Central

API Version:

2022-07-31

Abrufen einer Liste der API-Token in einer Anwendung Der Tokenwert wird aus Sicherheitsgründen nie zurückgegeben.

GET https://{subdomain}.{baseDomain}/api/apiTokens?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 Unterdomäne der Anwendung.
api-version	query	True	string	Die Version der aufgerufenen API.

Antworten

Name	Typ	Beschreibung
200 OK	ApiTokenCollection	Erfolg
Other Status Codes	Error	Eine vom IoT Central-Dienst 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

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

Definitionen

Name	Beschreibung
ApiToken	Die API-Zugriffstokendefinition.
ApiTokenCollection	Die ausgelagerten Ergebnisse von API-Token.
Error	Die Antwortfehlerdefinition.
ErrorDetails	Die Detailinformationen des Fehlers.
RoleAssignment	Die Rollenzuweisungsdefinition.

ApiToken

Die API-Zugriffstokendefinition.

Name	Typ	Beschreibung
expiry	string	Datum im Zeichenfolgenformat, das den Zeitpunkt darstellt, zu dem 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.

ApiTokenCollection

Die ausgelagerten Ergebnisse von API-Token.

Name	Typ	Beschreibung
nextLink	string	URL zum Abrufen der nächsten Seite von API-Token.
value	ApiToken[]	Die Sammlung von API-Token.

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 bei der Fehleranforderung ein Fehler aufgetreten 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.