GET /api/realms
Lista de territórios

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be Integer

search
opcional

filtrar resultados

Validations:

  • Must be String

order
opcional

ordenar resultados

Validations:

  • Must be String

page
opcional

paginar resultados

Validations:

  • Must be String

per_page
opcional

número de entradas por requisições

Validations:

  • Must be String


GET /api/realms/:id
Exibir um realm

Parâmentros

Nome parâmetro Descrição
id
requerido

ID numérico ou nome de território

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

Validations:

  • Must be a Hash

realm[name]
requerido

O Nome do Território ex: EXAMPLE.COM

Validations:

  • Must be String

realm[realm_proxy_id]
requerido , nulo permitido

Proxy a usar para este território

Validations:

  • Must be a number.

realm[realm_type]
requerido

Tipo de território, ex.: FreeIPA ou Diretório Ativo

Validations:

  • Must be 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
Atualize um território

Parâmentros

Nome parâmetro Descrição
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 do Território ex: EXAMPLE.COM

Validations:

  • Must be String

realm[realm_proxy_id]
opcional , nulo permitido

Proxy a usar para este território

Validations:

  • Must be a number.

realm[realm_type]
opcional

Tipo de território, ex.: FreeIPA ou Diretório Ativo

Validations:

  • Must be 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
Apagar um realm

Parâmentros

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