GET /api/realms
List of realms

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be Integer

search
Optional

filter results

Validations:

  • Must be String

order
Optional

sort results

Validations:

  • Must be String

page
Optional

paginate results

Validations:

  • Must be String

per_page
Optional

number of entries per request

Validations:

  • Must be String


GET /api/realms/:id
Show a realm

Params

Param Name Description
id
Required

Numerical ID or realm name

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) 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:

  • Must be a Hash

realm[name]
Required

The realm name, e.g. EXAMPLE.COM

Validations:

  • Must be String

realm[realm_proxy_id]
Required , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Proxy ID to use within this realm

Validations:

  • Must be a number.

realm[realm_type]
Required

Realm type, e.g. FreeIPA or Active Directory

Validations:

  • Must be String

realm[location_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

realm[organization_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

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:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

realm
Required

Validations:

  • Must be a Hash

realm[name]
Optional

The realm name, e.g. EXAMPLE.COM

Validations:

  • Must be String

realm[realm_proxy_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Proxy ID to use within this realm

Validations:

  • Must be a number.

realm[realm_type]
Optional

Realm type, e.g. FreeIPA or Active Directory

Validations:

  • Must be String

realm[location_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

realm[organization_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

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:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.