GET /api/realms
Lista de realms

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Classificar campo e ordem, ex.: ‘id DESC’

Validations:

  • Must be a String

page
opcional

Número de página, iniciando em 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para retornar

Validations:

  • Must be a number.

Pesquisar campos

Nome do campo Tipo Valores possíveis
location
location_id
name
organization
organization_id
type

GET /api/realms/:id
Exibir um realm

Parâmentros

Nome parâmetro Descrição
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érica ou nome de 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
Criar um realm

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

Parâmentros

Nome parâmetro Descrição
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

O nome de realm, ex: EXAMPLE.COM

Validations:

  • Must be a String

realm[realm_proxy_id]
requerido , nulo permitido

ID do proxy a ser usado neste realm

Validations:

  • Must be a number.

realm[realm_type]
requerido

Tipo de realm, ex.: FreeIPA ou Active Directory

Validations:

  • Must be a String

realm[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

realm[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


PUT /api/realms/:id
Atualizar um realm

Parâmentros

Nome parâmetro Descrição
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

O nome de realm, ex: EXAMPLE.COM

Validations:

  • Must be a String

realm[realm_proxy_id]
opcional , nulo permitido

ID do proxy a ser usado neste realm

Validations:

  • Must be a number.

realm[realm_type]
opcional

Tipo de realm, ex.: FreeIPA ou Active Directory

Validations:

  • Must be a String

realm[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

realm[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


DELETE /api/realms/:id
Remover um realm

Parâmentros

Nome parâmetro Descrição
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.