Kullanıcıları ve rolleri IoT Central REST API için IoT Central REST API kullanma

Bu IoT Central REST API, yeni uygulamalarla tümleştirilmiş istemci uygulamaları IoT Central sağlar. Uygulama uygulamanıza REST API rolleri yönetmek için IoT Central kullanabilirsiniz.

Her IoT Central REST API bir yetkilendirme üst bilgisi gerektirir. Daha fazla bilgi edinmek için bkz. Çağrılarda kimlik doğrulaması IoT Central REST API yetkilendirme.

Belgeye ilişkin başvuru belgeleri IoT Central REST API bkz. Azure IoT Central REST API başvurusu.

Rolleri yönet

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

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

Bu isteğin yanıtı, üç yerleşik rolü ve özel rolü içeren aşağıdaki örnekteki gibi görünüyor:

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

Kullanıcıları yönetme

Bu REST API şunları sağlar:

  • Bir uygulamanın kullanıcılarını listele
  • Tek bir kullanıcının ayrıntılarını alma
  • Kullanıcı oluşturma
  • Kullanıcı değiştirme
  • Kullanıcı silme

Kullanıcıları listele

Uygulamanıza kullanıcı listesi almak için aşağıdaki isteği kullanın:

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

Bu isteğin yanıtı aşağıdaki örnekteki gibi görünüyor. Rol değerleri, kullanıcının ilişkili olduğu rol kimliğini tanımlamaktadır:

{
  "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ı al

Tek bir kullanıcının ayrıntılarını uygulamanıza 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=1.0

Bu isteğin yanıtı aşağıdaki örnekteki gibi görünüyor. 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ıza 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=1.0

Aşağıdaki istek gövdesinde, role değer daha önce alınan işleç rolüne göredir:

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

Bu isteğin yanıtı aşağıdaki örnekteki gibi görünüyor. Rol değeri, kullanıcının ilişkili olduğu rolü tanımlar:

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

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 örnek, daha önce alınan oluşturucu rolünün kimliğini kullanır:

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

İstek gövdesi. Değer, daha önce alınan oluşturucu rolüne göredir:

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

Bu isteğin yanıtı aşağıdaki örnekteki gibi görünüyor:

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

Kullanıcı silme

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

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

Sonraki adımlar

Artık REST API ile kullanıcıları ve rolleri yönetmeyi öğrendiğinize göre, önerilen bir sonraki adım cihazları kontrol etmek için IoT Central REST API kullanmaktır.