GET /api/realms
Список областей

Params

Param Name Description
search
Optional

отфильтровать результаты


Value: Must be String
order
Optional

отсортировать результаты


Value: Must be String
page
Optional

разместить результат на нескольких страницах


Value: Must be String
per_page
Optional

количество записей на запрос


Value: Must be String

GET /api/realms/:id
Показать область

Params

Param Name Description
id
Required

Цифровой код или имя области


Value: 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
Создать область

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

Params

Param Name Description
realm
Required

Value: Must be a Hash
realm[name]
Required

Имя области, например EXAMPLE.COM


Value: Must be String
realm[realm_proxy_id]
Required , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Прокси для использования с этой областью


Value: Must be a number.
realm[realm_type]
Required

Тип области, например FreeIPA или Active Directory


Value: Must be String

PUT /api/realms/:id
Изменить область

Params

Param Name Description
id
Required

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

Value: Must be a Hash
realm[name]
Optional

Имя области, например EXAMPLE.COM


Value: Must be String
realm[realm_proxy_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Прокси для использования с этой областью


Value: Must be a number.
realm[realm_type]
Optional

Тип области, например FreeIPA или Active Directory


Value: Must be String

DELETE /api/realms/:id
Удалить область

Params

Param Name Description
id
Required

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