Retrieves effective Permissions and Preferences for an Application.

Full content information for the permissions and preferences response fields can be found under #/Permissions/getPermissionsV2 and #/Preferences/getPreferences respectively. When a value for externalRef is provided, pagination fields are ignored.

For optimum performance, it is recommended that the includeTotal parameter is set to false unless the value of the total field in the response is absolutely necessary. For backwards compatibility, it defaults to true.

In the event of receiving a response with status code 504 (GATEWAY TIMEOUT), it is recommended that the since and before parameters are used to reduce the quantity of data to be paginated.

Multiple smaller date ranges can be used to traverse larger periods.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
length between 1 and 50

The ID associated with the target Application.

string
length between 0 and 100

The unique reference associated with the Citizen.

string
Defaults to 1970-01-01T00:00:00.000Z

An ISO 8601 date (and time) specifying an inclusive lower limit for the results sought.

string
Defaults to now

An ISO 8601 date (and time) specifying an exclusive upper limit for the results sought.

int32
1 to 100
Defaults to 20

The number of items to return in a page.

int64
≥ 0
Defaults to 0

The index of the first record to return.

string
enum

Flag to indicate whether or not to exclude the total number of available records.

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json