Kullanıcıları ve rolleri yönetmek için IoT Central REST API'sini kullanma

IoT Central REST API,IoT Central uygulamalarıyla tümleşen istemci uygulamaları geliştirmenizi sağlar. IoT Central uygulamanızdaki kullanıcıları ve rolleri yönetmek için REST API'yi kullanabilirsiniz.

Her IoT Central REST API çağrısı bir yetkilendirme üst bilgisi gerektirir. Daha fazla bilgi edinmek için bkz . IoT Central REST API çağrılarının kimliğini doğrulama ve yetkilendirme.

Not

Kullanıcılar ve roller üzerindeki işlemler IoT Central denetim günlüğüne kaydedilir.

IoT Central REST API'sinin başvuru belgeleri için bkz . Azure IoT Central REST API başvurusu.

İpucu

Postman'i kullanarak bu makalede açıklanan REST API çağrılarını deneyebilirsiniz. IoT Central Postman koleksiyonunu indirin ve Postman'a aktarın. Koleksiyonda, uygulamanızın alt etki alanı ve yönetici belirteci gibi değişkenleri ayarlamanız gerekir.

IoT Central kullanıcı arabirimini kullanarak kullanıcıları ve rolleri yönetmeyi öğrenmek için bkz . IoT Central uygulamanızda kullanıcıları ve rolleri yönetme.

Rolleri yönetme

REST API, IoT Central uygulamanızda tanımlanan rolleri listelemenizi sağlar. Uygulamanızdan rol kimliklerinin listesini almak için aşağıdaki isteği kullanın:

GET https://{your app subdomain}.azureiotcentral.com/api/roles?api-version=2022-07-31

Bu isteğin yanıtı, üç yerleşik rolü ve özel rolü içeren aşağıdaki örneğe benzer:

{
  "value": [
    {
      "id": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4",
      "displayName": "Administrator"
    },
    {
      "id": "ae2c9854-393b-4f97-8c42-479d70ce626e",
      "displayName": "Operator"
    },
    {
      "id": "344138e9-8de4-4497-8c54-5237e96d6aaf",
      "displayName": "Builder"
    },
    {
      "id": "16f8533f-6b82-478f-8ba8-7e676b541b1b",
      "displayName": "Example custom role"
    }
  ]
}

Not

Bu komut, özel kuruluş düzeyi rolüyle değil yalnızca bir uygulamayla ilişkili rolleri gösterir.

Kullanıcıları yönet

REST API şunları yapmanızı sağlar:

• Uygulamadaki kullanıcıları listeleme
• Tek bir kullanıcının ayrıntılarını alma
• Kullanıcı oluşturma
• Kullanıcıyı değiştirme
• Kullanıcı silme

Kullanıcıları listele

Uygulamanızdan kullanıcı listesini almak için aşağıdaki isteği kullanın:

GET https://{your app subdomain}.azureiotcentral.com/api/users?api-version=2022-07-31

Bu isteğin yanıtı aşağıdaki örneğe benzer. Rol değerleri, kullanıcının ilişkili olduğu rol kimliğini tanımlar:

{
  "value": [
    {
      "id": "91907508-04fe-4349-91b5-b872f3055a95",
      "type": "email",
      "roles": [
        {
          "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
        }
      ],
      "email": "user1@contoso.com"
    },
    {
      "id": "dc1c916b-a652-49ea-b128-7c465a54c759",
      "type": "email",
      "roles": [
        {
          "role": "ae2c9854-393b-4f97-8c42-479d70ce626e"
        }
      ],
      "email": "user2@contoso.com"
    },
    {
      "id": "3ab9375e-d2d9-42da-b419-6ae86a938321",
      "type": "email",
      "roles": [
        {
          "role": "344138e9-8de4-4497-8c54-5237e96d6aaf"
        }
      ],
      "email": "user3@contoso.com"
    },
    {
      "id": "fc5a250b-83fb-433d-892c-e0a144f68c2b",
      "type": "email",
      "roles": [
        {
          "role": "16f8533f-6b82-478f-8ba8-7e676b541b1b"
        }
      ],
      "email": "user4@contoso.com"
    }
  ]
}

Kullanıcı alma

Uygulamanızdan tek bir kullanıcının ayrıntılarını almak için aşağıdaki isteği kullanın:

GET https://{your app subdomain}.azureiotcentral.com/api/users/dc1c916b-a652-49ea-b128-7c465a54c759?api-version=2022-07-31

Bu isteğin yanıtı aşağıdaki örneğe benzer. Rol değeri, kullanıcının ilişkili olduğu rol kimliğini tanımlar:

{
  "id": "dc1c916b-a652-49ea-b128-7c465a54c759",
  "type": "email",
  "roles": [
    {
      "role": "ae2c9854-393b-4f97-8c42-479d70ce626e"
    }
  ],
  "email": "user2@contoso.com"
}

Kullanıcı oluşturma

Uygulamanızda bir kullanıcı oluşturmak için aşağıdaki isteği kullanın. Kimlik ve e-posta uygulamada benzersiz olmalıdır:

PUT https://{your app subdomain}.azureiotcentral.com/api/users/user-001?api-version=2022-07-31

Aşağıdaki istek gövdesinde role değer, daha önce aldığınız işleç rolüne yöneliktir:

{
  "id": "user-001",
  "type": "email",
  "roles": [
    {
      "role": "ae2c9854-393b-4f97-8c42-479d70ce626e"
    }
  ],
  "email": "user5@contoso.com"
}

Bu isteğin yanıtı aşağıdaki örneğe benzer. Rol değeri, kullanıcının hangi rolle ilişkili olduğunu tanımlar:

{
  "id": "user-001",
  "type": "email",
  "roles": [
    {
      "role": "ae2c9854-393b-4f97-8c42-479d70ce626e"
    }
  ],
  "email": "user5@contoso.com"
}

REST API çağrıları için hizmet sorumlusu kimlik doğrulamasını kullanmanız gerekiyorsa yararlı olan bir hizmet sorumlusu kullanıcısı da ekleyebilirsiniz. Daha fazla bilgi edinmek için bkz . Hizmet sorumlusu kullanıcısı ekleme veya güncelleştirme.

Kullanıcının rolünü değiştirme

Kullanıcıya atanan rolü değiştirmek için aşağıdaki isteği kullanın. Bu örnekte, daha önce aldığınız oluşturucu rolünün kimliği kullanılır:

PATCH https://{your app subdomain}.azureiotcentral.com/api/users/user-001?api-version=2022-07-31

İstek gövdesi. Değer, daha önce aldığınız oluşturucu rolüne yöneliktir:

{
  "roles": [
    {
      "role": "344138e9-8de4-4497-8c54-5237e96d6aaf"
    }
  ]
}

Bu isteğin yanıtı aşağıdaki örneğe benzer:

{
  "id": "user-001",
  "type": "email",
  "roles": [
    {
      "role": "344138e9-8de4-4497-8c54-5237e96d6aaf"
    }
  ],
  "email": "user5@contoso.com"
}

Kullanıcı silme

Kullanıcıyı silmek için aşağıdaki isteği kullanın:

DELETE https://{your app subdomain}.azureiotcentral.com/api/users/user-001?api-version=2022-07-31

Sonraki adımlar

REST API ile kullanıcıları ve rolleri yönetmeyi öğrendiğinize göre, önerilen bir sonraki adım IoT Central REST API'sini kullanarak kuruluşları yönetmektir.