GET /api/realms
Liste der Realms

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Ergebnisse sortieren

Validations:

  • Must be a String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be a String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be a String


GET /api/realms/:id
Realm anzeigen

Parameter

Parametername Beschreibung
id
verpflichtend

Numerische Kennung oder Name des Realms

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
Realm erstellen

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

Parameter

Parametername Beschreibung
realm
verpflichtend

Validations:

  • Must be a Hash

realm[name]
verpflichtend

Name des Realms, z.B. EXAMPLE.COM

Validations:

  • Must be a String

realm[realm_proxy_id]
verpflichtend , nil erlaubt

Proxy ID to use within this realm

Validations:

  • Must be a number.

realm[realm_type]
verpflichtend

Art des Realms, z.B. FreeIPA oder Active Directory

Validations:

  • Must be a String

realm[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

realm[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


PUT /api/realms/:id
Realm aktualisieren

Parameter

Parametername Beschreibung
id
verpflichtend

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
verpflichtend

Validations:

  • Must be a Hash

realm[name]
optional

Name des Realms, z.B. EXAMPLE.COM

Validations:

  • Must be a String

realm[realm_proxy_id]
optional , nil erlaubt

Proxy ID to use within this realm

Validations:

  • Must be a number.

realm[realm_type]
optional

Art des Realms, z.B. FreeIPA oder Active Directory

Validations:

  • Must be a String

realm[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

realm[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


DELETE /api/realms/:id
Realm löschen

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

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