GET /api/realms
List of realms

Examples

GET /api/locations/447626441/realms
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "myrealm.net",
      "realm_type": "FreeIPA",
      "created_at": "2021-11-26 09:10:47 UTC",
      "updated_at": "2021-11-26 09:10:47 UTC",
      "id": 664044182,
      "realm_proxy_id": 982965213,
      "realm_proxy_name": null,
      "realm_proxy": null
    },
    {
      "name": "yourrealm.net",
      "realm_type": "FreeIPA",
      "created_at": "2021-11-26 09:10:47 UTC",
      "updated_at": "2021-11-26 09:10:47 UTC",
      "id": 936160439,
      "realm_proxy_id": 982965213,
      "realm_proxy_name": null,
      "realm_proxy": null
    }
  ]
}

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 and order by a searchable field, e.g. ‘id DESC’ Validations: Must be a String
page optional	Page number, starting at 1 Validations: Must be a number.
per_page optional	Number of results per page to return, ‘all’ to return all results Validations: Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

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