GET /api/realms
領域清單

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

search
選填

篩選結果

Validations:

  • Must be a String

order
選填

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
選填

頁數,從 1 開始

Validations:

  • Must be a number.

per_page
選填

每頁要傳回的結果數量

Validations:

  • Must be a number.

Search fields

Field name 類型 Possible values
location
location_id
name
organization
organization_id
type

GET /api/realms/:id
顯示領域

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

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.

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

realm
必填

Validations:

  • Must be a Hash

realm[name]
必填

領域名稱,例如 EXAMPLE.COM

Validations:

  • Must be a String

realm[realm_proxy_id]
必填 , 允許空值

Proxy ID to use within this realm

Validations:

  • Must be a number.

realm[realm_type]
必填

領域類型,例如 FreeIPA 或是 Active Directory

Validations:

  • Must be a String

realm[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

realm[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


PUT /api/realms/:id
更新領域

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

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]
選填 , 允許空值

Proxy ID to use within this realm

Validations:

  • Must be a number.

realm[realm_type]
選填

領域類型,例如 FreeIPA 或是 Active Directory

Validations:

  • Must be a String

realm[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

realm[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


DELETE /api/realms/:id
刪除領域

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

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.