GET /api/realms
List of realms

Examples

GET /api/organizations/447626438/realms
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "myrealm.net",
      "realm_type": "FreeIPA",
      "created_at": "2018-07-24 13:03:17 UTC",
      "updated_at": "2018-07-24 13:03:17 UTC",
      "id": 664044182,
      "realm_proxy_id": 982965213,
      "realm_proxy_name": "Realm Proxy",
      "realm_proxy": {
        "name": "Realm Proxy",
        "id": 982965213,
        "url": "http://else.where:1337"
      }
    }
  ]
}

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
search optional	filter results Validations: Must be a String
order optional	Sort field and order, eg. ‘id DESC’ Validations: Must be a String
page optional	paginate results Validations: Must be a String
per_page optional	number of entries per request Validations: Must be a String

Search fields

Field name	Type	Possible values
location	string
location_id	integer
name	string
organization	string
organization_id	integer
type	string