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 , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type

realm[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

지정된 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 , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type

realm[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

지정된 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.