Users

List users for autocomplete

post/api/v1/{tenant}/tenant-access/autocomplete

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/tenant-access/autocomplete
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

tenantstring required

Request body

qstring nullable
idsstring[] nullable
existingOnlyboolean
usernamestring nullable

Example request

{
  "q": "q",
  "existingOnly": true,
  "ids": [
    "ids",
    "ids"
  ]
}

Response

autocompleteUsers 200 response

idstring
usernamestring
displayNamestring
descriptionstring

Example response

[
  {
    "displayName": "displayName",
    "auths": [
      {
        "name": "name",
        "type": "type"
      },
      {
        "name": "name",
        "type": "type"
      }
    ],
    "description": "description",
    "groups": [
      {
        "external": true,
        "name": "name",
        "id": "id"
      },
      {
        "external": true,
        "name": "name",
        "id": "id"
      }
    ],
    "id": "id",
    "username": "username"
  }
]

Changes

No recorded changes to this operation across all 7 revisions of this API.