GET /api/realms
Lista de reinos

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be Integer

search
opcional

filtrar resultados

Validations:

  • Must be String

order
opcional

organizar resultados

Validations:

  • Must be String

page
opcional

paginar resultados

Validations:

  • Must be String

per_page
opcional

número de entradas por solicitud

Validations:

  • Must be String


GET /api/realms/:id
Mostrar un reino

Parámetros

Nombre del parámetro Descripción
id
requerido

ID numérico o nombre del reino

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
Crear un reino

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

Parámetros

Nombre del parámetro Descripción
realm
requerido

Validations:

  • Must be a Hash

realm[name]
requerido

Nombre de reino, p. ej., EXAMPLE.COM

Validations:

  • Must be String

realm[realm_proxy_id]
requerido , nil permitido

Proxy ID to use within this realm

Validations:

  • Must be a number.

realm[realm_type]
requerido

Tipo de reino, p.ej. FreeIPA o Active Directory

Validations:

  • Must be String

realm[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

realm[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


PUT /api/realms/:id
Actualizar un reino

Parámetros

Nombre del parámetro Descripción
id
requerido

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
requerido

Validations:

  • Must be a Hash

realm[name]
opcional

Nombre de reino, p. ej., EXAMPLE.COM

Validations:

  • Must be String

realm[realm_proxy_id]
opcional , nil permitido

Proxy ID to use within this realm

Validations:

  • Must be a number.

realm[realm_type]
opcional

Tipo de reino, p.ej. FreeIPA o Active Directory

Validations:

  • Must be String

realm[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

realm[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


DELETE /api/realms/:id
Borrar un reino

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

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