GET /api/realms
List of realms

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

search
optional

filter results

Validations:

  • String

order
optional

sort results

Validations:

  • String

page
optional

paginate results

Validations:

  • String

per_page
optional

number of entries per request

Validations:

  • String


GET /api/realms/:id
Show a realm

Params

Param name Description
id
required

Numerical ID or realm name

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..


POST /api/realms
Create a realm

The name field is used for the name of the realm.

Params

Param name Description
realm
required

Validations:

  • Hash

realm[name]
required

The realm name, e.g. EXAMPLE.COM

Validations:

  • String

realm[realm_proxy_id]
required , nil allowed

Proxy ID to use within this realm

Validations:

  • number.

realm[realm_type]
required

Realm type, e.g. FreeIPA or Active Directory

Validations:

  • String

realm[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

realm[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


PUT /api/realms/:id
Update a realm

Params

Param name Description
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

realm
required

Validations:

  • Hash

realm[name]
optional

The realm name, e.g. EXAMPLE.COM

Validations:

  • String

realm[realm_proxy_id]
optional , nil allowed

Proxy ID to use within this realm

Validations:

  • number.

realm[realm_type]
optional

Realm type, e.g. FreeIPA or Active Directory

Validations:

  • String

realm[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

realm[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


DELETE /api/realms/:id
Delete a realm

Params

Param name Description
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..