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": "2021-05-19 07:27:00 UTC",
"updated_at": "2021-05-19 07:27:00 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": "2021-05-19 07:27:00 UTC",
"updated_at": "2021-05-19 07:27:00 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": "2021-05-19 07:27:00 UTC",
"updated_at": "2021-05-19 07:27:00 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": "2021-05-19 07:27:00 UTC",
"updated_at": "2021-05-19 07:27:00 UTC",
"id": 936160439,
"realm_proxy_id": 982965213,
"realm_proxy_name": "Realm Proxy",
"realm_proxy": {
"name": "Realm Proxy",
"id": 982965213,
"url": "http://else.where:1337"
}
}
]
}
| Param name | Description |
|---|---|
|
location_id optional |
Scope by locations Validations:
|
|
organization_id optional |
Scope by organizations Validations:
|
|
search optional |
filter results Validations:
|
|
order optional |
Sort field and order, eg. ‘id DESC’ Validations:
|
|
page optional |
Page number, starting at 1 Validations:
|
|
per_page optional |
Number of results per page to return, ‘all’ to return all results Validations:
|
| Field name | Type | Possible values |
|---|---|---|
| location | string | |
| location_id | integer | |
| name | string | |
| organization | string | |
| organization_id | integer | |
| type | string |
GET /api/realms/myrealm.net
200
{
"name": "myrealm.net",
"realm_type": "FreeIPA",
"created_at": "2021-05-19 07:27:00 UTC",
"updated_at": "2021-05-19 07:27:00 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
}
]
}
| Param name | Description |
|---|---|
|
location_id optional |
Set the current location context for the request Validations:
|
|
organization_id optional |
Set the current organization context for the request Validations:
|
|
id required |
Numerical ID or realm name Validations:
|
The name field is used for the name of the realm.
POST /api/realms
{
"realm": {
"name": ""
}
}
422
{
"error": {
"id": null,
"errors": {
"realm_proxy_id": [
"was not found",
"can't be blank"
],
"name": [
"can't be blank"
],
"realm_type": [
"can't be blank",
"is not included in the list"
]
},
"full_messages": [
"Realm proxy was not found",
"Realm proxy can't be blank",
"Name can't be blank",
"Realm type can't be blank",
"Realm type is not included in the list"
]
}
}
| Param name | Description |
|---|---|
|
location_id optional |
Set the current location context for the request Validations:
|
|
organization_id optional |
Set the current organization context for the request Validations:
|
|
realm required |
Validations:
|
|
realm[name] required |
The realm name, e.g. EXAMPLE.COM Validations:
|
|
realm[realm_proxy_id] required , nil allowed |
Proxy ID to use within this realm Validations:
|
|
realm[realm_type] required |
Realm type, e.g. FreeIPA or Active Directory Validations:
|
|
realm[location_ids] optional , nil allowed |
REPLACE locations with given ids Validations:
|
|
realm[organization_ids] optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
PUT /api/realms/myrealm.net
{
"realm": {
"name": ""
}
}
422
{
"error": {
"id": 664044182,
"errors": {
"name": [
"can't be blank"
]
},
"full_messages": [
"Name can't be blank"
]
}
}
| Param name | Description |
|---|---|
|
location_id optional |
Set the current location context for the request Validations:
|
|
organization_id optional |
Set the current organization context for the request Validations:
|
|
id required |
Validations:
|
|
realm required |
Validations:
|
|
realm[name] optional |
The realm name, e.g. EXAMPLE.COM Validations:
|
|
realm[realm_proxy_id] optional , nil allowed |
Proxy ID to use within this realm Validations:
|
|
realm[realm_type] optional |
Realm type, e.g. FreeIPA or Active Directory Validations:
|
|
realm[location_ids] optional , nil allowed |
REPLACE locations with given ids Validations:
|
|
realm[organization_ids] optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
DELETE /api/realms/myrealm.net
{
"realm": {}
}
200
{
"id": 664044182,
"name": "myrealm.net",
"realm_type": "FreeIPA",
"realm_proxy_id": 982965213,
"created_at": "2021-05-19T07:27:00.710Z",
"updated_at": "2021-05-19T07:27:00.710Z"
}
| Param name | Description |
|---|---|
|
location_id optional |
Set the current location context for the request Validations:
|
|
organization_id optional |
Set the current organization context for the request Validations:
|
|
id required |
Validations:
|