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

pagina els resultats

Validations:

  • Must be a String
per_page
Optional

Nombre d'entrades per petició

Validations:

  • Must be a String

Search fields

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

GET /api/realms/:id
Mostra un reialme

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
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

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
realm[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
realm[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

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.