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.