ListUsers

GET/api/v1/users

List or search for users. Can be used to translate an email to a user ID.

Example request

US
Europe

curl \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  "https://us.oblique.security/api/v1/users"

Set OBLIQUE_API_KEY to your API key.

curl \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  "https://eu.oblique.security/api/v1/users"

Set OBLIQUE_API_KEY to your API key.

Query parameters

pageSizeinteger (int32)
pageTokenstring

filterstring

Optional filter for search. The filter supports emails and display name with support for * wildcards and the case-insensitive ~= comparator.

email="janedoe@example.com"

email="janedoe@example.com" OR email="johndoe@example.com"

// matches janedoe@example.com or janedoe@foo.com
email="janedoe@*"

// Matches "Jane Doe", "Jane Smith", but not "Smith Jane"
displayName = "Jane *"

// Case-insensitive, matches "Jane Doe" and "jane doe"
displayName ~= "jane *"

displayName = "Jane *" OR displayName = "John *" OR displayName = "* Doe"

// Search for displayName or email
displayName ~= "* doe" OR email ~= "jane@*"

showDeletedboolean
If true, include deleted users in the response.

Response

200ListUsersResponse

usersUser[]
- namestring
  Assigned by Oblique. Format: users/{id}
- createTimestring (date-time)read-only
  Create and update timestamps.
- updateTimestring (date-time)read-only
- deleteTimestring (date-time)read-only
  Users can only be soft-deleted to preserve logs and history.
- displayNamestringrequired
  Primary display name of the user.
- emailstringrequired
  Primary email of the user.
- secondaryEmailsstring[]
  Additional emails of the user. These are in addition to the primary email.
- titlestring
  Self reported role. “VP of Engineering”, “Senior Frontend Engineer”, “Engineering Director, Frontend”.
- managerstring
  Optional manager of the user.
  
  Format: users/{user}
- pictureUristring
  URI for the user’s profile picture. This can either be an “https://” scheme, or an absolute path (/imgs/foo.png).
- directReportCountinteger (int32)read-only
  Number of direct reports to this user.
- totalReportCountinteger (int32)read-only
  Number of total reports to this user.
- lastLoginTimestring (date-time)read-only
  The time the user last logged in. Not set if the user has never logged in.
nextPageTokenstring

Errors

Status	Meaning
`400`	Malformed request
`401`	Missing or invalid API key
`403`	Not allowed for this API key
`404`	Not found
`429`	Too many requests
`500`	Internal server error