GET /api/realms
Liste der Realms

Beispiele

GET /api/locations/447626439/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": "2019-11-07 09:06:52 UTC",
      "updated_at": "2019-11-07 09:06:52 UTC",
      "id": 664044182,
      "realm_proxy_id": 982965213,
      "realm_proxy_name": null,
      "realm_proxy": null
    },
    {
      "name": "yourrealm.net",
      "realm_type": "FreeIPA",
      "created_at": "2019-11-07 09:06:52 UTC",
      "updated_at": "2019-11-07 09:06:52 UTC",
      "id": 936160439,
      "realm_proxy_id": 982965213,
      "realm_proxy_name": null,
      "realm_proxy": null
    }
  ]
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Feld und Reihenfolge sortieren, z.B. ‘id DESC’

Validations:

  • Must be a String

page
optional

Seitennummer, beginnend bei 1

Validations:

  • Must be a number.

per_page
optional

Anzahl der angezeigten Ergebnisse pro Seite

Validations:

  • Must be a number.

Suchfelder

Feld Name Typ Mögliche Werte
location string
location_id integer
name string
organization string
organization_id integer
type string

GET /api/realms/:id
Realm anzeigen

Beispiele

GET /api/realms/myrealm.net
200
{
  "name": "myrealm.net",
  "realm_type": "FreeIPA",
  "created_at": "2019-11-07 09:06:52 UTC",
  "updated_at": "2019-11-07 09:06:52 UTC",
  "id": 664044182,
  "realm_proxy_id": 982965213,
  "realm_proxy_name": "Realm Proxy",
  "realm_proxy": {
    "name": "Realm Proxy",
    "id": 982965213,
    "url": "http://else.where:1337"
  },
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
verpflichtend

Numerische Kennung oder Name des Realms

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/realms
Realm erstellen

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

Beispiele

POST /api/realms
{
  "realm": {
    "name": "realm.net",
    "realm_proxy_id": 0,
    "realm_type": "FreeIPA"
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "realm_proxy_id": [
        "was not found"
      ]
    },
    "full_messages": [
      "Realm proxy was not found"
    ]
  }
}

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

realm
verpflichtend

Validations:

  • Must be a Hash

realm[name]
verpflichtend

Name des Realms, z.B. EXAMPLE.COM

Validations:

  • Must be a String

realm[realm_proxy_id]
verpflichtend , nil erlaubt

Proxy Kennung zur Verwendung innerhalb dieses Realms

Validations:

  • Must be a number.

realm[realm_type]
verpflichtend

Art des Realms, z.B. FreeIPA oder Active Directory

Validations:

  • Must be a String

realm[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

realm[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


PUT /api/realms/:id
Realm aktualisieren

Beispiele

PUT /api/realms/90728897
{
  "realm": {
    "name": "realm.new"
  }
}
200
{
  "name": "realm.new",
  "realm_type": "FreeIPA",
  "created_at": "2019-11-07 09:07:46 UTC",
  "updated_at": "2019-11-07 09:08:06 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": []
}

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
verpflichtend

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
verpflichtend

Validations:

  • Must be a Hash

realm[name]
optional

Name des Realms, z.B. EXAMPLE.COM

Validations:

  • Must be a String

realm[realm_proxy_id]
optional , nil erlaubt

Proxy Kennung zur Verwendung innerhalb dieses Realms

Validations:

  • Must be a number.

realm[realm_type]
optional

Art des Realms, z.B. FreeIPA oder Active Directory

Validations:

  • Must be a String

realm[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

realm[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


DELETE /api/realms/:id
Realm löschen

Beispiele

DELETE /api/realms/myrealm.net
{
  "realm": {}
}
200
{
  "id": 664044182,
  "name": "myrealm.net",
  "realm_type": "FreeIPA",
  "realm_proxy_id": 982965213,
  "created_at": "2019-11-07T09:07:46.176Z",
  "updated_at": "2019-11-07T09:07:46.176Z"
}

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.