GuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Adds new account.

Adds the user account provided.

The requesting account cannot grant a privilege level, access level or site it does not
itself hold.

šŸ“‹

Required privilege: Create Accounts

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
password
string
string
string
string
integer
Defaults to -1
string
integer
Defaults to -1

Site the account is scoped to, or -1 for no site. Omitting this field on an update
applies the default of -1 and therefore clears any site already set, so send the
current value to keep it. Changing it requires the requesting account to have full
access.

string
enum
Defaults to FullAccess

Access level for the account. Omitting this field applies the default of FullAccess,
which the requesting account may only grant if it has full access itself.

Allowed:
string
enum
Defaults to ADMINISTRATOR

Privilege level for the account. Omitting this field applies the default of
ADMINISTRATOR; ADMINISTRATOR, AUDITOR and ENROLLMENT expand to fixed privilege sets
and may only be granted by an administrator.

Allowed:
boolean
string
enum
Defaults to Enabled

Status of the account

Allowed:
string
enum
Defaults to DEFAULT

Type of the account

Allowed:
string
enum

Controls whether this account is eligible for ROPF (Redirect-Only Password Flow) migration to IDPCS. On create, omitting this field defaults to AUTO; supplying EXCLUDED creates the account with migration suppressed and no IDPCS sync is initiated. On update, omitting this field leaves the stored value unchanged; an explicit EXCLUDED reverts a MIGRATED account to DEFAULT and removes its IDPCS record — the local revert commits before the IDPCS delete is attempted, so if the IDPCS delete fails the account remains DEFAULT locally until cleanup. EXCLUDED is rejected (400) for FEDERATED accounts.

Allowed:
Responses

403

Forbidden - the requesting account cannot grant the requested authority

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json