Examples

PUT /api/realms/90728897
{
  "realm": {
    "name": "realm.new"
  }
}
200
{
  "name": "realm.new",
  "realm_type": "FreeIPA",
  "created_at": "2019-02-20 13:44:57 UTC",
  "updated_at": "2019-02-20 13:44:58 UTC",
  "id": 90728897,
  "realm_proxy_id": 982965213,
  "realm_proxy_name": "Realm Proxy",
  "realm_proxy": {
    "name": "Realm Proxy",
    "id": 982965213,
    "url": "http://else.where:1337"
  },
  "locations": [],
  "organizations": []
}

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

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

The realm name, e.g. EXAMPLE.COM

Validations:

  • Must be a String

realm[realm_proxy_id]
optional , nil allowed

Proxy ID to use within this realm

Validations:

  • Must be a number.

realm[realm_type]
optional

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