Realms

>>>

GET /api/realms
Liste des domaines

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer
organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer
search
optionel

filtrer les résultats

Validations:

  • Must be a String
order
optionel

Champ et sens de tri, ex: 'id DESC'

Validations:

  • Must be a String
page
optionel

paginer les résultats

Validations:

  • Must be a String
per_page
optionel

nombre d'entrées par requête

Validations:

  • Must be a String

Rechercher les champs

Nom du champ Type Valeurs possibles
location string
location_id integer
name string
organization string
organization_id integer
type string
>>>

GET /api/realms/:id
Afficher un domaine

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer
organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer
id
requis

ID numérique ou nom de domaine

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
Créer un domaine

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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer
organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer
realm
requis

Validations:

  • Must be a Hash
realm[name]
requis

Le nom du domaine. Ex. : EXAMPLE.COM

Validations:

  • Must be a String
realm[realm_proxy_id]
requis , nil autorisé

ID Proxy à utiliser dans ce domaine

Validations:

  • Must be a number.
realm[realm_type]
requis

Type de domaine. Ex : FreeIPA ou Active Directory

Validations:

  • Must be a String
realm[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type
realm[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type
>>>

PUT /api/realms/:id
Mise à jour d'un domaine

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer
organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer
id
requis

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
requis

Validations:

  • Must be a Hash
realm[name]
optionel

Le nom du domaine. Ex. : EXAMPLE.COM

Validations:

  • Must be a String
realm[realm_proxy_id]
optionel , nil autorisé

ID Proxy à utiliser dans ce domaine

Validations:

  • Must be a number.
realm[realm_type]
optionel

Type de domaine. Ex : FreeIPA ou Active Directory

Validations:

  • Must be a String
realm[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type
realm[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type
>>>

DELETE /api/realms/:id
Supprimer un domaine

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer
organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer
id
requis

Validations:

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