Api Tokens - Create

Vytvořte v aplikaci nový token rozhraní API, který se použije ve veřejném rozhraní API IoT Central. Hodnota tokenu bude vrácena 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 In Required Type Description
baseDomain
path True
  • string

Základní doména pro všechny požadavky služby 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

Volána verze rozhraní API.

Text požadavku

Name Required Type Description
roles True

Seznam přiřazení rolí, která určují oprávnění pro přístup k aplikaci.

expiry
  • string

Datum formátované řetězcem představující čas vypršení platnosti tokenu

Odpovědi

Name Type Description
200 OK

Success

Other Status Codes

Od služby IoT Central došlo k chybě.

Headers

  • x-ms-error-code: string

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

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

Scopes

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

Příklady

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

Definice

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 Type Description
expiry
  • string

Datum formátované řetězcem představující čas vypršení platnosti tokenu

id
  • string

Jedinečné ID tokenu rozhraní API

roles

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 Type Description
error

Podrobnosti o chybě pro aktuální požadavek

ErrorDetails

Podrobné informace o chybě.

Name Type Description
code
  • string

Kód chyby

message
  • string

Podrobnosti chybové zprávy

requestId
  • string

ID korelace pro aktuální požadavek

time
  • string

Čas, kdy se žádost o chybu nezdařila.

RoleAssignment

Definice přiřazení role.

Name Type Description
organization
  • string

ID organizace pro toto přiřazení role

role
  • string

ID role pro toto přiřazení role