Api Tokens - Create

Service:

IoT Central

API Version:

2022-07-31

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 bir daha döndürülemez.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	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	Gerekli	Tür	Description
roles	True	RoleAssignment[]	Uygulamaya erişim izinlerini belirten rol atamalarının listesi.
expiry		string	Belirtecin süresinin dolmasına ilişkin zamanı temsil eden dize biçimli tarih.

Yanıtlar

Name	Tür	Description
200 OK	ApiToken	Başarılı
Other Status Codes	Error	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

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

Sample Response

Status code:

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

Tanımlar

Name	Description
ApiToken	API erişim belirteci tanımı.
Error	Yanıt hatası tanımı.
ErrorDetails	Hatanın ayrıntılı bilgileri.
RoleAssignment	Rol ataması tanımı.

ApiToken

API erişim belirteci tanımı.

Name	Tür	Description
expiry	string	Belirtecin süresinin dolmasına ilişkin zamanı temsil eden dize biçimli tarih.
id	string	API belirtecinin benzersiz kimliği.
roles	RoleAssignment[]	Uygulamaya erişim izinlerini belirten rol atamalarının listesi.
token	string	API belirtecinin değeri.

Error

Yanıt hatası tanımı.

Name	Tür	Description
error	ErrorDetails	Geçerli isteğin hata ayrıntıları.

ErrorDetails

Hatanın ayrıntılı bilgileri.

Name	Tür	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 ataması tanımı.

Name	Tür	Description
organization	string	Bu rol ataması için kuruluşun kimliği.
role	string	Bu rol ataması için rolün kimliği.