Get Users

Gets users filtered by given subscription ID and application IDs. When no application IDs are given, they are derived from the calling AAD application.

Query Parameters

• subscriptionId uuid

  Subscription ID.

• applicationId uuid[]

  Optional list of application IDs.

Responses

• 200
• 400
• 401

---

Ok

application/json

• Schema
• Example (from schema)

---

Schema

• data object[] required

  Data.

  Array [

  id uuid required

  User ID

  email string required

  Email

  assignedApplications object[] required

  List of applications that are assigned to the user.

  Array [

  id uuid required

  Application id

  ]

  assignedSubscriptions object[] required

  List of subscriptions that are assigned to the user.

  Array [

  id uuid required

  Subscription ID

  role object

  Role of a user.

  ]

  displayName string nullable deprecated

  Display name

  firstName string nullable

  First name

  lastName string nullable

  Last name

  ]
• totalCount int32 required

  Total count.

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "email": "string",
      "assignedApplications": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        }
      ],
      "assignedSubscriptions": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "role": "admin"
        }
      ],
      "firstName": "string",
      "lastName": "string"
    }
  ],
  "totalCount": 0
}

Bad request

application/json

• Schema
• Example (from schema)

---

Schema

• message string nullable
• details string[] nullable

{
  "message": "string",
  "details": [
    "string"
  ]
}

Unauthorized

application/json

• Schema
• Example (from schema)

---

Schema

• message string nullable
• details string[] nullable

{
  "message": "string",
  "details": [
    "string"
  ]
}

Loading...