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

数値 ID またはレルム名


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: ja.apipie.nil_allowed">Nil Allowed</span>

プロキシは、このレルムを使用します


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

レルムタイプ 例: FreeIPA or 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: ja.apipie.nil_allowed">Nil Allowed</span>

プロキシは、このレルムを使用します


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

レルムタイプ 例: FreeIPA or 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.