Realms

>>>

GET /api/realms
영역 목록

Params

Param name Description
location_id
optional

위치 별 범위

Validations:

  • Must be a Integer
organization_id
optional

조직 별 범위

Validations:

  • Must be a Integer
search
optional

필터 결과

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

페이지네이션 결과

Validations:

  • Must be a String
per_page
optional

요청 당 항목 수

Validations:

  • Must be a String

Search fields

Field name 유형 Possible values
location string
location_id integer
name string
organization string
organization_id integer
type string
>>>

GET /api/realms/:id
영역 표시

Params

Param name Description
location_id
optional

위치 별 범위

Validations:

  • Must be a Integer
organization_id
optional

조직 별 범위

Validations:

  • Must be a Integer
id
required

숫자로된 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.

Params

Param name Description
location_id
optional

위치 별 범위

Validations:

  • Must be a Integer
organization_id
optional

조직 별 범위

Validations:

  • Must be a Integer
realm
required

Validations:

  • Must be a Hash
realm[name]
required

영역 이름 예: EXAMPLE.COM

Validations:

  • Must be a String
realm[realm_proxy_id]
required , nil allowed

Proxy ID to use within this realm

Validations:

  • Must be a number.
realm[realm_type]
required

영역 유형. 예: FreeIPA 또는 활성 디렉토리

Validations:

  • Must be a String
realm[location_ids]
optional , nil allowed

지정된 ID로 위치를 변경합니다

Validations:

  • Must be an array of any type
realm[organization_ids]
optional , nil allowed

지정된 ID로 조직을 변경합니다

Validations:

  • Must be an array of any type
>>>

PUT /api/realms/:id
영역 업데이트

Params

Param name Description
location_id
optional

위치 별 범위

Validations:

  • Must be a Integer
organization_id
optional

조직 별 범위

Validations:

  • Must be a Integer
id
required

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
required

Validations:

  • Must be a Hash
realm[name]
optional

영역 이름 예: EXAMPLE.COM

Validations:

  • Must be a String
realm[realm_proxy_id]
optional , nil allowed

Proxy ID to use within this realm

Validations:

  • Must be a number.
realm[realm_type]
optional

영역 유형. 예: FreeIPA 또는 활성 디렉토리

Validations:

  • Must be a String
realm[location_ids]
optional , nil allowed

지정된 ID로 위치를 변경합니다

Validations:

  • Must be an array of any type
realm[organization_ids]
optional , nil allowed

지정된 ID로 조직을 변경합니다

Validations:

  • Must be an array of any type
>>>

DELETE /api/realms/:id
영역 삭제

Params

Param name Description
location_id
optional

위치 별 범위

Validations:

  • Must be a Integer
organization_id
optional

조직 별 범위

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.