Realms

>>>

GET /api/realms
Llista dels reialmes

Params

Param name Description
location_id
optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
optional

Abast per organitzacions

Validations:

  • Must be a Integer
search
optional

filtra els resultats

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Nombre de resultats per pàgina a retornar

Validations:

  • Must be a number.

Search fields

Field name Tipus Possible values
location
location_id
name
organization
organization_id
type
>>>

GET /api/realms/:id
Mostra un reialme

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

ID numèric o nom del reialme

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
Crea un reialme

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
realm
required

Validations:

  • Must be a Hash
realm[name]
required

El nom del reialme, p. ex. 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

Tipus de reialme, p. ex. FreeIPA o Active Directory

Validations:

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

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

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

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type
>>>

PUT /api/realms/:id
Actualitza un reialme

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

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

El nom del reialme, p. ex. 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

Tipus de reialme, p. ex. FreeIPA o Active Directory

Validations:

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

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

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

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type
>>>

DELETE /api/realms/:id
Suprimeix un reialme

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

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.