Api Tokens - Create

IoT Central genel API'sinde kullanılacak uygulamada yeni bir API belirteci oluşturun. Belirteç değeri yanıtta döndürülür ve sonraki isteklerde yeniden döndürülmeyecektir.

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

URI Parametreleri

Name In Required Type Description
baseDomain
path True
  • string

Tüm Azure IoT Central hizmet istekleri için temel etki alanı.

subdomain
path True
  • string

Uygulama alt etki alanı.

tokenId
path True
  • string

API belirtecinin benzersiz kimliği.

api-version
query True
  • string

Çağrılan API sürümü.

İstek Gövdesi

Name Required Type Description
roles True

Uygulamaya erişim izinlerini belirten rol atamalarının listesi.

expiry
  • string

Belirtecin süresinin dolmasına neden olan dize biçimli tarih.

Yanıtlar

Name Type Description
200 OK

Başarılı

Other Status Codes

IoT Central Hizmetinden alınan bir hata yanıtı.

Headers

  • x-ms-error-code: string

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Tanımlar

ApiToken

API erişim belirteci tanımı.

Error

Yanıt hatası tanımı.

ErrorDetails

Hatanın ayrıntılı bilgileri.

RoleAssignment

Rol atama tanımı.

ApiToken

API erişim belirteci tanımı.

Name Type Description
expiry
  • string

Belirtecin süresinin dolmasına neden olan dize biçimli tarih.

id
  • string

API belirtecinin benzersiz kimliği.

roles

Uygulamaya erişim izinlerini belirten rol atamalarının listesi.

token
  • string

API belirtecinin değeri.

Error

Yanıt hatası tanımı.

Name Type Description
error

Geçerli istek için hata ayrıntıları.

ErrorDetails

Hatanın ayrıntılı bilgileri.

Name Type Description
code
  • string

Hata kodu.

message
  • string

Hata iletisi ayrıntıları.

requestId
  • string

Geçerli istek için bağıntı kimliği.

time
  • string

Hata isteğinin başarısız olduğu zaman.

RoleAssignment

Rol atama tanımı.

Name Type Description
organization
  • string

Bu rol ataması için kuruluşun kimliği.

role
  • string

Bu rol ataması için rolün kimliği.