GET /api/realms
List of realms

參數

參數名字 描述
location_id
選填

Scope by locations

Validations:

  • Must be Integer

organization_id
選填

Scope by organizations

Validations:

  • Must be Integer

search
選填

篩選結果

Validations:

  • Must be String

order
選填

排序結果

Validations:

  • Must be String

page
選填

編頁結果

Validations:

  • Must be String

per_page
選填

每個請求的項目數量

Validations:

  • Must be String


GET /api/realms/:id
Show a realm

參數

參數名字 描述
id
必填

Numerical ID or realm name

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

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

參數

參數名字 描述
realm
必填

Validations:

  • Must be a Hash

realm[name]
必填

The realm name, e.g. EXAMPLE.COM

Validations:

  • Must be String

realm[realm_proxy_id]
必填 , 允許空值

Proxy to use for this realm

Validations:

  • Must be a number.

realm[realm_type]
必填

Realm type, e.g. FreeIPA or Active Directory

Validations:

  • Must be String

realm[location_ids]
選填 , 允許空值

REPLACE locations with given ids

Validations:

  • Must be an array of any type

realm[organization_ids]
選填 , 允許空值

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


PUT /api/realms/:id
Update a realm

參數

參數名字 描述
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]
選填

The realm name, e.g. EXAMPLE.COM

Validations:

  • Must be String

realm[realm_proxy_id]
選填 , 允許空值

Proxy to use for this realm

Validations:

  • Must be a number.

realm[realm_type]
選填

Realm type, e.g. FreeIPA or Active Directory

Validations:

  • Must be String

realm[location_ids]
選填 , 允許空值

REPLACE locations with given ids

Validations:

  • Must be an array of any type

realm[organization_ids]
選填 , 允許空值

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


DELETE /api/realms/:id
Delete a realm

參數

參數名字 描述
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.