Retrieve users

This operation returns an object containing information about users that the current user can manage (view, edit, or delete). Adding query_viewable=1 expands this to all users that are viewable by the current user.

Query Params
string

Retrieves users with usernames that match part or all of what is given (case insensitive). EXAMPLE: Given a value of 'abc', this parameter would fetch users with usernames of '[email protected]', '[email protected]', and '[email protected]'.

string

Retrieves users with first names that match part or all of what is given (case insensitive). EXAMPLE: Given a value of 'Fred', this parameter would fetch users whose first name is 'Fred', 'Frederic', and 'Manfred'.

string

Retrieves users with last names that match part or all of what is given (case insensitive). EXAMPLE: Given a value of 'Man', this parameter would fetch users whose last name is 'Man', 'Mann', 'Roman', or 'Romanoff'.

string

Retrieves users whose last login to Sentinel occurred after the date and time given. Requires a valid ISO-8601 (UTC/GMT) date format string. EXAMPLE: 'YYYY-MM-DDThh:mm:ssZ' -> '2008-12-12T21:35:59Z'

string
enum
Defaults to 0

Retrieves both managed users and users that the requesting user has permission to view but not manage.

Allowed:
string
enum
Defaults to 0

This parameter controls if additional user attributes are displayed. PREREQUISITE: format=json

Allowed:
string
enum
Defaults to 0

Displays a list of preferences for each user.

Allowed:
string
enum
Defaults to 0

This parameter controls what view is displayed for exporting user data in CSV format. Two views are currently supported. Absence of this flag or a value of '0' displays the older (default) view. Setting the value of this flag to '1' displays a newer view. Each view has some key information in common (username, role), but the remaining information is different. PREREQUISITE: format=csv

Allowed:
int32

Limit results to n number of pages.

int32

Begin showing results from page number n.

string
enum
Defaults to id

Order the results.

string
enum
Defaults to application/xml

Selects the requested response representation format.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

BadRequestResponse indicates a request with invalid parameters.

401

UnauthorizedResponse signals an unauthorized API access.

403

ForbiddenResponse signals a request for a resource that does not exist or is not authorized.

500

GenericError generic error.

Language
Response
Choose an example:
application/json
application/xml
text/csv