List users

get

https://{hostname}/amfa/v1/users

List user accounts configured in Akamai MFA, optionally filtered and paginated.

Query Params

page

integer

Defaults to 1

The page number index starting at the default value of 1.

pageSize

integer

Defaults to 25

The number of records displayed on each page. The default value is 25.

status

string

enum

Enum Filter user records by the specific status and display a list of user accounts that have this status.

Allowed:

includeDevices

boolean

Defaults to false

Whether the response should include device details for listed users. The default value is false.

policyId

string

Optionally filter users subject to a specific policy.

policyName

string

Optionally filter users subject to a specific policy, referred to by name.

username

string

Optionally filter users by name.

string

Optionally filter users by email.

contractId

string

required

Unique identifier for the contract.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200The response provides a list of users.

401Unauthorized.

500Internal server error.