Api Tokens - Create

Služba:

IoT Central

Verze rozhraní API:

2022-07-31

Vytvořte v aplikaci nový token rozhraní API pro použití ve veřejném rozhraní API IoT Central. Hodnota tokenu se vrátí v odpovědi a nebude vrácena znovu v dalších požadavcích.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
baseDomain	path	True	string	Základní doména pro všechny žádosti o službu Azure IoT Central
subdomain	path	True	string	Subdoména aplikace.
tokenId	path	True	string	Jedinečné ID tokenu rozhraní API
api-version	query	True	string	Verze rozhraní API, která se volá.

Text požadavku

Name	Vyžadováno	Typ	Description
roles	True	RoleAssignment[]	Seznam přiřazení rolí, která určují oprávnění pro přístup k aplikaci.
expiry		string	Datum ve formátu řetězce představující čas vypršení platnosti tokenu.

Odpovědi

Name	Typ	Description
200 OK	ApiToken	Success
Other Status Codes	Error	Ze služby IoT Central byla přijata chybová odpověď. Hlavičky x-ms-error-code: string

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Create API token

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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=..."
}

Definice

Name	Description
ApiToken	Definice přístupového tokenu rozhraní API
Error	Definice chyby odpovědi.
ErrorDetails	Podrobné informace o chybě
RoleAssignment	Definice přiřazení role.

ApiToken

Definice přístupového tokenu rozhraní API

Name	Typ	Description
expiry	string	Datum ve formátu řetězce představující čas vypršení platnosti tokenu.
id	string	Jedinečné ID tokenu rozhraní API
roles	RoleAssignment[]	Seznam přiřazení rolí, která určují oprávnění pro přístup k aplikaci.
token	string	Hodnota tokenu rozhraní API.

Error

Definice chyby odpovědi.

Name	Typ	Description
error	ErrorDetails	Podrobnosti o chybě pro aktuální požadavek

ErrorDetails

Podrobné informace o chybě

Name	Typ	Description
code	string	Kód chyby
message	string	Podrobnosti o chybové zprávě
requestId	string	ID korelace pro aktuální požadavek
time	string	Čas, kdy žádost o chybu selhala.

RoleAssignment

Definice přiřazení role.

Name	Typ	Description
organization	string	ID organizace pro toto přiřazení role.
role	string	ID role pro toto přiřazení role