Realms

>>>

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
>>>

GET /api/realms/:id
Show a realm

Examples

GET /api/realms/myrealm.net
200
{
  "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": "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
    }
  ]
}

Params

Param name Description
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
required

Numerical ID or realm name

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
Create a realm

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

Examples

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"
    ]
  }
}

Params

Param name Description
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
required

Validations:

  • Must be a Hash
realm[name]
required

The realm name, e.g. EXAMPLE.COM

Validations:

  • Must be a String
realm[realm_proxy_id]
required , nil allowed

Proxy ID to use within this realm

Validations:

  • Must be a number.
realm[realm_type]
required

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
>>>

PUT /api/realms/:id
Update a realm

Examples

PUT /api/realms/90728897
{
  "realm": {
    "name": "realm.new"
  }
}
200
{
  "name": "realm.new",
  "realm_type": "FreeIPA",
  "created_at": "2021-11-26 09:44:48 UTC",
  "updated_at": "2021-11-26 09:44:50 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

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
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
>>>

DELETE /api/realms/:id
Delete a realm

Examples

DELETE /api/realms/myrealm.net
{
  "realm": {}
}
200
{
  "id": 664044182,
  "name": "myrealm.net",
  "realm_type": "FreeIPA",
  "realm_proxy_id": 982965213,
  "created_at": "2021-11-26T09:44:48.467Z",
  "updated_at": "2021-11-26T09:44:48.467Z"
}

Params

Param name Description
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
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.