Skip to main content
GET
List of Admins (Globally)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[size]
integer
default:500

The number of results that will be returned per page.

page[number]
integer

The page number to start the pagination from.

filter
string
page
string
sort
string
filter[id]
string

Filter by Policy Ruleset Admin ID

filter[policy_ruleset_id]
string

Filter by Policy Ruleset ID

filter[directory_user_id]
string

Filter by Directory User ID

filter[role]
string

Filter by admin role (admin, audit, create, activate)

filter[state]
string

Filter by state (staged, active, expiring, expired, deactivated)

filter[created_before]
string

Filter by created before date

filter[created_after]
string

Filter by created after date

filter[updated_before]
string

Filter by updated before date

filter[updated_after]
string

Filter by updated after date

filter[expires_before]
string

Filter by expires before date

filter[expires_after]
string

Filter by expires after date

filter[deactivated_before]
string

Filter by deactivated before date

filter[deactivated_after]
string

Filter by deactivated after date

filter[deleted_before]
string

Filter by deleted before date

filter[deleted_after]
string

Filter by deleted after date

filter[trashed]
string

Include trashed records (with, only, without)

include
enum<string>[]

Include related resources (ruleset, user)

Available options:
ruleset,
ruleset-count,
ruleset-exists,
user,
user-count,
user-exists

Response

Paginated set of PolicyUserDetailedResponseData

current_page
integer
required
Required range: x >= 1
data
PolicyUserDetailedResponseData · object[]
required
first_page_url
string | null
required
from
integer | null
required
Required range: x >= 1
last_page_url
string | null
required
last_page
integer
required
Required range: x >= 1

Generated paginator links.

next_page_url
string | null
required
path
string | null
required

Base path for paginator generated URLs.

per_page
integer
required

Number of items shown per page.

Required range: x >= 0
prev_page_url
string | null
required
to
integer | null
required

Number of the last item in the slice.

Required range: x >= 1
total
integer
required

Total number of items being paginated.

Required range: x >= 0