1. Oracle Linux Automation Manager CLI and API Reference Guide
  2. Tasks
  3. Users

List Users

get

/api/v2/users/

Make a GET request to this resource to retrieve the list of users.

The resulting data structure contains:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

The count field indicates the total number of users found for the given query. The next and previous fields provides links to additional results if there are more than will fit on a single page. The results list contains zero or more user records.

Results

Each user data structure includes the following fields:

  • id: Database ID for this user. (integer)
  • type: Data type for this user. (choice)
  • url: URL for this user. (string)
  • related: Data structure with URLs of related resources. (object)
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
  • created: Timestamp when this user was created. (datetime)
  • modified: Timestamp when this user was last modified. (datetime)
  • username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
  • first_name: (string)
  • last_name: (string)
  • email: (string)
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
  • is_system_auditor: (boolean)
  • password: Field used to change the password. (string)
  • ldap_dn: (string)
  • last_login: (datetime)
  • external_account: Set if the account is managed by an external service (field)

Sorting

To specify that users are returned in a particular order, use the order_by query string parameter on the GET request.

?order_by=username

Prefix the field name with a dash - to sort in reverse:

?order_by=-username

Multiple sorting fields may be specified by separating the field names with a comma ,:

?order_by=username,some_other_field

Pagination

Use the page_size query string parameter to change the number of results returned for each request. Use the page query string parameter to retrieve a particular page of results.

?page_size=100&page=2

The previous and next links returned with the results will set these query string parameters automatically.

Searching

Use the search query string parameter to perform a case-insensitive search within all designated text fields of a model.

?search=findme

(Added in Ansible Tower 3.1.0) Search across related fields:

?related__search=findme

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : results
Type: array
Show Source
Nested Schema : User
Type: object
Show Source
Back to Top