GET /api/realms
レルム一覧

Params

Param Name Description
location_id
Optional

ロケーション別のスコープ

Validations:

  • Must be Integer

organization_id
Optional

組織別のスコープ

Validations:

  • Must be Integer

search
Optional

結果のフィルター

Validations:

  • Must be String

order
Optional

結果のソート

Validations:

  • Must be String

page
Optional

結果のページネーション

Validations:

  • Must be String

per_page
Optional

要求ごとのエントリー数

Validations:

  • Must be String


GET /api/realms/:id
レルムの表示

Params

Param Name Description
id
Required

数値 ID またはレルム名

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
レルムの作成

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

Params

Param Name Description
realm
Required

Validations:

  • Must be a Hash

realm[name]
Required

レルム名 (例: EXAMPLE.COM)

Validations:

  • Must be String

realm[realm_proxy_id]
Required , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Proxy ID to use within this realm

Validations:

  • Must be a number.

realm[realm_type]
Required

レルムタイプ。例: FreeIPA または Active Directory

Validations:

  • Must be String

realm[location_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

realm[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


PUT /api/realms/:id
レルムの更新

Params

Param Name Description
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

レルム名 (例: EXAMPLE.COM)

Validations:

  • Must be String

realm[realm_proxy_id]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Proxy ID to use within this realm

Validations:

  • Must be a number.

realm[realm_type]
Optional

レルムタイプ。例: FreeIPA または Active Directory

Validations:

  • Must be String

realm[location_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

realm[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


DELETE /api/realms/:id
レルムの削除

Params

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