GET /api/realms
List of 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
Show a realm

Params

Param Name Description
id
Required

Numerical ID or realm name


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

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

The realm name, e.g. EXAMPLE.COM


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

Proxy to use for this realm


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

Realm type, e.g. FreeIPA or Active Directory


Value: Must be String

PUT /api/realms/:id
Update a realm

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

The realm name, e.g. EXAMPLE.COM


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

Proxy to use for this realm


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

Realm type, e.g. FreeIPA or Active Directory


Value: Must be String

DELETE /api/realms/:id
Delete a realm

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.