Realms

>>>

GET /api/realms
Som realms op

Params

Param name Description
location_id
optional

Scope met locaties

Validations:

  • Must be a Integer
organization_id
optional

Scope met organisaties

Validations:

  • Must be a Integer
search
optional

filter resultaten

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

Pagineer de resultaten

Validations:

  • Must be a String
per_page
optional

Aantal items per aanvraag

Validations:

  • Must be a String

Search fields

Field name Type Possible values
location string
location_id integer
name string
organization string
organization_id integer
type string
>>>

GET /api/realms/:id
Toon een realm

Params

Param name Description
location_id
optional

Scope met locaties

Validations:

  • Must be a Integer
organization_id
optional

Scope met organisaties

Validations:

  • Must be a Integer
id
required

Numeriek ID of realm naam

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
Maak een realm

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

Params

Param name Description
location_id
optional

Scope met locaties

Validations:

  • Must be a Integer
organization_id
optional

Scope met organisaties

Validations:

  • Must be a Integer
realm
required

Validations:

  • Must be a Hash
realm[name]
required

De realm naam, bijvoorbeeld EXAMPLE.COM

Validations:

  • Must be a String
realm[realm_proxy_id]
required , nil allowed

Proxy ID to use within this realm

Validations:

  • Must be a number.
realm[realm_type]
required

Realm type, bijvoorbeeld FreeIPA of Active Directory

Validations:

  • Must be a String
realm[location_ids]
optional , nil allowed

Vervang locaties met de opgegeven ids

Validations:

  • Must be an array of any type
realm[organization_ids]
optional , nil allowed

Vervang organisaties met de opgegeven ids.

Validations:

  • Must be an array of any type
>>>

PUT /api/realms/:id
Wijzig een realm

Params

Param name Description
location_id
optional

Scope met locaties

Validations:

  • Must be a Integer
organization_id
optional

Scope met organisaties

Validations:

  • Must be a Integer
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

De realm naam, bijvoorbeeld EXAMPLE.COM

Validations:

  • Must be a String
realm[realm_proxy_id]
optional , nil allowed

Proxy ID to use within this realm

Validations:

  • Must be a number.
realm[realm_type]
optional

Realm type, bijvoorbeeld FreeIPA of Active Directory

Validations:

  • Must be a String
realm[location_ids]
optional , nil allowed

Vervang locaties met de opgegeven ids

Validations:

  • Must be an array of any type
realm[organization_ids]
optional , nil allowed

Vervang organisaties met de opgegeven ids.

Validations:

  • Must be an array of any type
>>>

DELETE /api/realms/:id
Verwijder een realm

Params

Param name Description
location_id
optional

Scope met locaties

Validations:

  • Must be a Integer
organization_id
optional

Scope met organisaties

Validations:

  • Must be a Integer
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.