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

Examples

POST /api/realms
{
  "realm": {
    "name": "realm.net",
    "realm_proxy_id": 0,
    "realm_type": "FreeIPA"
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "realm_proxy_id": [
        "was not found"
      ]
    },
    "full_messages": [
      "Realm proxy was not found"
    ]
  }
}

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer

realm
Required

Validations:

  • Must be a Hash

realm[name]
Required

The realm name, e.g. EXAMPLE.COM

Validations:

  • Must be a String

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

Proxy ID to use within this realm

Validations:

  • Must be a number.

realm[realm_type]
Required

Realm type, e.g. FreeIPA or Active Directory

Validations:

  • Must be a String

realm[location_ids]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

realm[organization_ids]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type