Api Tokens - Create

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

Name In Required Type Description
baseDomain
path True
  • string

Domena podstawowa dla wszystkich żądań usług 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

Name Required Type Description
roles True

Lista przypisań ról określających uprawnienia dostępu do aplikacji.

expiry
  • string

Data sformatowana w ciągu reprezentująca godzinę wygaśnięcia tokenu.

Odpowiedzi

Name Type Description
200 OK

Powodzenie

Other Status Codes

Odpowiedź o błędzie odebrana z usługi IoT Central.

Headers

  • x-ms-error-code: string

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

Create API token

Sample Request

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

Sample Response

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

ApiToken

Definicja tokenu dostępu interfejsu API.

Error

Definicja błędu odpowiedzi.

ErrorDetails

Szczegółowe informacje o błędzie.

RoleAssignment

Definicja przypisania roli.

ApiToken

Definicja tokenu dostępu interfejsu API.

Name Type Description
expiry
  • string

Data sformatowana w ciągu reprezentująca godzinę wygaśnięcia tokenu.

id
  • string

Unikatowy identyfikator tokenu interfejsu API.

roles

Lista przypisań ról określających uprawnienia dostępu do aplikacji.

token
  • string

Wartość tokenu interfejsu API.

Error

Definicja błędu odpowiedzi.

Name Type Description
error

Szczegóły błędu dla bieżącego żądania.

ErrorDetails

Szczegółowe informacje o błędzie.

Name Type Description
code
  • string

Kod błędu.

message
  • string

Szczegóły komunikatu o błędzie.

requestId
  • string

Identyfikator korelacji dla bieżącego żądania.

time
  • string

Czas niepowodzenia żądania błędu.

RoleAssignment

Definicja przypisania roli.

Name Type Description
organization
  • string

Identyfikator organizacji dla tego przypisania roli.

role
  • string

Identyfikator roli dla tego przypisania roli.