GET /api/realms
Lista de reinos

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Orden y campo de clasificación, p. ej., 'id DESC'

Validations:

  • Must be a String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.

Campos de búsqueda

Nombre del campo Tipo Valores posibles
location
location_id
name
organization
organization_id
type

GET /api/realms/:id
Mostrar un reino

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

realm
requerido

Validations:

  • Must be a Hash

realm[name]
requerido

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

Validations:

  • Must be a String

realm[realm_proxy_id]
requerido , nil permitido

ID de proxy que se utilizará dentro de este dominio

Validations:

  • Must be a number.

realm[realm_type]
requerido

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

Validations:

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

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

realm[realm_proxy_id]
opcional , nil permitido

ID de proxy que se utilizará dentro de este dominio

Validations:

  • Must be a number.

realm[realm_type]
opcional

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

Validations:

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

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.