GET /api/realms
Liste des royaumes

Params

Param Name Description
search
Optional

filtrer les résultats

Validations:

  • Must be String

order
Optional

trier les resultats

Validations:

  • Must be String

page
Optional

paginer les résultats

Validations:

  • Must be String

per_page
Optional

nombre d’entier par requête

Validations:

  • Must be String


GET /api/realms/:id
Afficher un royaume

Params

Param Name Description
id
Required

ID numérique ou nom de royaume

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 royaume

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

Params

Param Name Description
realm
Required

Validations:

  • Must be a Hash

realm[name]
Required

Le nom du royaume. Ex. : EXAMPLE.COM

Validations:

  • Must be String

realm[realm_proxy_id]
Required , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Proxy à utiliser pour ce royaume

Validations:

  • Must be a number.

realm[realm_type]
Required

Type de royaume. Ex : FreeIPA ou Active Directory

Validations:

  • Must be String


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

Params

Param Name Description
id
Required

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
Required

Validations:

  • Must be a Hash

realm[name]
Optional

Le nom du royaume. Ex. : EXAMPLE.COM

Validations:

  • Must be String

realm[realm_proxy_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Proxy à utiliser pour ce royaume

Validations:

  • Must be a number.

realm[realm_type]
Optional

Type de royaume. Ex : FreeIPA ou Active Directory

Validations:

  • Must be String


DELETE /api/realms/:id
Supprimer un royaume

Params

Param Name Description
id
Required

Validations:

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