Esempi

GET /api/realms
200
{
  "total": 4,
  "subtotal": 4,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "myrealm.net",
      "realm_type": "FreeIPA",
      "created_at": "2019-09-11 14:41:58 UTC",
      "updated_at": "2019-09-11 14:41:58 UTC",
      "id": 664044182,
      "realm_proxy_id": 982965213,
      "realm_proxy_name": "Realm Proxy",
      "realm_proxy": {
        "name": "Realm Proxy",
        "id": 982965213,
        "url": "http://else.where:1337"
      }
    },
    {
      "name": "unused.net",
      "realm_type": "FreeIPA",
      "created_at": "2019-09-11 14:41:58 UTC",
      "updated_at": "2019-09-11 14:41: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"
      }
    },
    {
      "name": "useless.net",
      "realm_type": "FreeIPA",
      "created_at": "2019-09-11 14:41:58 UTC",
      "updated_at": "2019-09-11 14:41:58 UTC",
      "id": 229305443,
      "realm_proxy_id": 982965213,
      "realm_proxy_name": "Realm Proxy",
      "realm_proxy": {
        "name": "Realm Proxy",
        "id": 982965213,
        "url": "http://else.where:1337"
      }
    },
    {
      "name": "yourrealm.net",
      "realm_type": "FreeIPA",
      "created_at": "2019-09-11 14:41:58 UTC",
      "updated_at": "2019-09-11 14:41:58 UTC",
      "id": 936160439,
      "realm_proxy_id": 982965213,
      "realm_proxy_name": "Realm Proxy",
      "realm_proxy": {
        "name": "Realm Proxy",
        "id": 982965213,
        "url": "http://else.where:1337"
      }
    }
  ]
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

search
opzionale

filtra i risultati

Validations:

  • Must be a String

order
opzionale

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
opzionale

Numero pagina, iniziando da 1

Validations:

  • Must be a number.

per_page
opzionale

Numero di risultati per pagina da ritornare

Validations:

  • Must be a number.

Search fields

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