GET /api/users
모든 사용자 나열

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
LDAP 인증 소스에 대한 모든 사용자 나열

GET /api/auth_source_externals/:auth_source_external_id/users
List all users for external authentication source

GET /api/usergroups/:usergroup_id/users
사용자 그룹에 대한 모든 사용자 나열

GET /api/roles/:role_id/users
역할에 대한 모든 사용자 나열

GET /api/locations/:location_id/users
위치에 대한 모든 사용자 나열

GET /api/organizations/:organization_id/users
조직에 대한 모든 사용자 나열

Examples

GET /api/users
200
{
  "total": 9,
  "subtotal": 0,
  "page": 1,
  "per_page": 20,
  "search": "login == foreman_admin",
  "sort": {
    "by": null,
    "order": null
  },
  "results": []
}

Params

Param Name Description
auth_source_ldap_id
Optional

LDAP 인증 소스 ID

Validations:

  • Must be a String
usergroup_id
Optional

사용자 그룹 ID

Validations:

  • Must be a String
role_id
Optional

역할 ID

Validations:

  • Must be a String
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

1 부터 페이지 번호

Validations:

  • Must be a number.
per_page
Optional

반환할 페이지 당 결과 수

Validations:

  • Must be a number.

Search fields

Field name 유형 Possible values
admin true, false
description text
firstname string
last_login_on datetime
lastname string
location string
location_id integer
login string
mail string
organization string
organization_id integer
role string
role_id integer
usergroup string