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]
必填 , 允许空值

要在此域中使用的代理 ID

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
更新范围

参数

参数名字 描述
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]
选填 , 允许空值

要在此域中使用的代理 ID

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
删除范围

参数

参数名字 描述
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.