GET /api/realms
Elenco di realm

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

search
opzionale

filtra i risultati

Validations:

  • Must be a String

order
opzionale

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
opzionale

Numero pagina, iniziando da 1

Validations:

  • Must be a number.

per_page
opzionale

Numero di risultati per pagina da ritornare

Validations:

  • Must be a number.

Search fields

Field name Tipo Possible values
location
location_id
name
organization
organization_id
type

GET /api/realms/:id
Mostra un realm

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer

id
richiesto

ID numerico o nome del realm

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 realm

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

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer

realm
richiesto

Validations:

  • Must be a Hash

realm[name]
richiesto

Nome del realm, es. EXAMPLE.COM

Validations:

  • Must be a String

realm[realm_proxy_id]
richiesto , consentito nil

Proxy ID to use within this realm

Validations:

  • Must be a number.

realm[realm_type]
richiesto

Tipo di Realm, es FreeIPA o Active Directory

Validations:

  • Must be a String

realm[location_ids]
opzionale , consentito nil

SOSTITUIRE le posizioni con gli id dati

Validations:

  • Must be an array of any type

realm[organization_ids]
opzionale , consentito nil

SOSTITUIRE le organizzazioni con gli id dati

Validations:

  • Must be an array of any type


PUT /api/realms/:id
Aggiorna un realm

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer

id
richiesto

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
richiesto

Validations:

  • Must be a Hash

realm[name]
opzionale

Nome del realm, es. EXAMPLE.COM

Validations:

  • Must be a String

realm[realm_proxy_id]
opzionale , consentito nil

Proxy ID to use within this realm

Validations:

  • Must be a number.

realm[realm_type]
opzionale

Tipo di Realm, es FreeIPA o Active Directory

Validations:

  • Must be a String

realm[location_ids]
opzionale , consentito nil

SOSTITUIRE le posizioni con gli id dati

Validations:

  • Must be an array of any type

realm[organization_ids]
opzionale , consentito nil

SOSTITUIRE le organizzazioni con gli id dati

Validations:

  • Must be an array of any type


DELETE /api/realms/:id
Cancella un realm

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer

id
richiesto

Validations:

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