POST /api/realms
Create a realm

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

Examples

POST /api/realms
{
  "realm": {
    "name": ""
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "realm_proxy_id": [
        "was not found",
        "can't be blank"
      ],
      "name": [
        "can't be blank"
      ],
      "realm_type": [
        "can't be blank",
        "is not included in the list"
      ]
    },
    "full_messages": [
      "Realm proxy was not found",
      "Realm proxy can't be blank",
      "Name can't be blank",
      "Realm type can't be blank",
      "Realm type is not included in the list"
    ]
  }
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

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 , nil allowed

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 , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
realm[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type