ANansible
users

GET /users/

Changed on

List users

Request

  • Base URL
    /api/eda/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/eda/v1/users/
  • Auth
    • API key in cookie sessionid
    • or HTTP basic
    • or HTTP bearer
    • or API key in header X-DAB-JW-TOKEN

Query parameters

is_superuserboolean

Filter by superuser status.

namestring

Filter by Username.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

resource__ansible_idstring

Filter by resource ansible ID.

usernamestring

Response

Return a list of users.

countinteger
nextstring uri nullable
previousstring uri nullable
page_sizeinteger nullable
pageinteger nullable

Example response

{
  "count": 123,
  "next": "/eda/api/v1/example/?page=51&page_size=100",
  "previous": "/eda/api/v1/example/?page=49&page_size=100",
  "page_size": 100,
  "page": 50
}

Changes