GET /api/realms
レルム一覧

パラメーター

パラメーター名 記述
location_id
任意

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

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

結果のソート

Validations:

  • Must be a String

page
任意

結果のページネーション

Validations:

  • Must be a String

per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String


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

パラメーター

パラメーター名 記述
id
必須

数値 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.

パラメーター

パラメーター名 記述
realm
必須

Validations:

  • Must be a Hash

realm[name]
必須

レルム名 (例: EXAMPLE.COM)

Validations:

  • Must be a String

realm[realm_proxy_id]
必須 , nil可

このレルム内で使用するプロキシー ID

Validations:

  • Must be a number.

realm[realm_type]
必須

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

Validations:

  • Must be a String

realm[location_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

realm[organization_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type


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

パラメーター

パラメーター名 記述
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.

realm
必須

Validations:

  • Must be a Hash

realm[name]
任意

レルム名 (例: EXAMPLE.COM)

Validations:

  • Must be a String

realm[realm_proxy_id]
任意 , nil可

このレルム内で使用するプロキシー ID

Validations:

  • Must be a number.

realm[realm_type]
任意

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

Validations:

  • Must be a String

realm[location_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

realm[organization_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type


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

パラメーター

パラメーター名 記述
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.