Api Tokens - Create

Usługa:

IoT Central

Wersja interfejsu API:

2022-07-31

Utwórz nowy token interfejsu API w aplikacji do użycia w publicznym interfejsie API usługi IoT Central. Wartość tokenu zostanie zwrócona w odpowiedzi i nie zostanie zwrócona ponownie w kolejnych żądaniach.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
baseDomain	path	True	string	Domena podstawowa dla wszystkich żądań obsługi usługi Azure IoT Central.
subdomain	path	True	string	Poddomena aplikacji.
tokenId	path	True	string	Unikatowy identyfikator tokenu interfejsu API.
api-version	query	True	string	Wywoływana wersja interfejsu API.

Treść żądania

Nazwa	Wymagane	Typ	Opis
roles	True	RoleAssignment[]	Lista przypisań ról określających uprawnienia dostępu do aplikacji.
expiry		string (date-time)	Data sformatowana w ciągu reprezentująca godzinę wygaśnięcia tokenu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ApiToken	Powodzenie
Other Status Codes	Error	Odebrano odpowiedź o błędzie z usługi IoT Central. Nagłówki x-ms-error-code: string

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Create API token

Przykładowe żądanie

HTTP

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

{
  "roles": [
    {
      "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "id": "testtoken",
  "roles": [
    {
      "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ],
  "expiry": "2020-10-18T18:30:40.227Z",
  "token": "SharedAccessSignature sr=..."
}

Definicje

Nazwa	Opis
ApiToken	Definicja tokenu dostępu interfejsu API.
Error	Definicja błędu odpowiedzi.
ErrorDetails	Szczegółowe informacje o błędzie.
RoleAssignment	Definicja przypisania roli.

ApiToken

Objekt

Definicja tokenu dostępu interfejsu API.

Nazwa	Typ	Opis
expiry	string (date-time)	Data sformatowana w ciągu reprezentująca godzinę wygaśnięcia tokenu.
id	string	Unikatowy identyfikator tokenu interfejsu API.
roles	RoleAssignment[]	Lista przypisań ról określających uprawnienia dostępu do aplikacji.
token	string	Wartość tokenu interfejsu API.

Error

Objekt

Definicja błędu odpowiedzi.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu dla bieżącego żądania.

ErrorDetails

Objekt

Szczegółowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Szczegóły komunikatu o błędzie.
requestId	string	Identyfikator korelacji dla bieżącego żądania.
time	string (date-time-rfc1123)	Czas niepowodzenia żądania błędu.

RoleAssignment

Objekt

Definicja przypisania roli.

Nazwa	Typ	Opis
organization	string	Identyfikator organizacji dla tego przypisania roli.
role	string	Identyfikator roli dla tego przypisania roli.