GET /api/usergroups
すべてのユーザーグループを一覧表示

GET /api/usergroups
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "admin": false,
      "created_at": "2019-09-11 14:33:34 UTC",
      "updated_at": "2019-09-11 14:33:34 UTC",
      "name": "usergroup200",
      "id": 15
    }
  ]
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.

検索フィールド

フィールド名 タイプ 設定可能な値
name string
role string
role_id integer

GET /api/usergroups/:id
ユーザーグループの表示

GET /api/usergroups/11-usergroup196
200
{
  "admin": false,
  "created_at": "2019-09-11 14:33:33 UTC",
  "updated_at": "2019-09-11 14:33:33 UTC",
  "name": "usergroup196",
  "id": 11,
  "external_usergroups": [],
  "usergroups": [],
  "users": [],
  "roles": []
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

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/usergroups
ユーザーグループの作成

POST /api/usergroups
{
  "usergroup": {
    "name": "test_usergroup",
    "user_ids": [
      980190962,
      298486374,
      200482051
    ]
  }
}
201
{
  "admin": false,
  "created_at": "2019-09-11 14:33:33 UTC",
  "updated_at": "2019-09-11 14:33:33 UTC",
  "name": "test_usergroup",
  "id": 2,
  "external_usergroups": [],
  "usergroups": [],
  "users": [
    {
      "id": 980190962,
      "login": "one",
      "description": null
    },
    {
      "id": 298486374,
      "login": "two",
      "description": null
    },
    {
      "id": 200482051,
      "login": "test",
      "description": null
    }
  ],
  "roles": []
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

usergroup
必須

Validations:

  • Must be a Hash

usergroup[name]
必須

Validations:

  • Must be a String

usergroup[admin]
任意 , nil可

管理者ユーザーグループ

Validations:

  • Must be one of: true, false, 1, 0.

usergroup[user_ids]
任意 , nil可

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
任意 , nil可

Validations:

  • Must be an array of any type

usergroup[role_ids]
任意 , nil可

Validations:

  • Must be an array of any type


PUT /api/usergroups/:id
ユーザーグループの更新

User groups linked to external groups (LDAP) are automatically synced with these groups on update. Remember this synchronization will remove any LDAP users manually added to the Foreman user group. Only LDAP users in the external groups will remain. Internal users can be added or removed freely.

PUT /api/usergroups/3-usergroup190
{
  "usergroup": {
    "name": "test_usergroup",
    "usergroup_ids": [
      4
    ]
  }
}
200
{
  "admin": false,
  "created_at": "2019-09-11 14:33:33 UTC",
  "updated_at": "2019-09-11 14:33:33 UTC",
  "name": "test_usergroup",
  "id": 3,
  "external_usergroups": [],
  "usergroups": [
    {
      "name": "usergroup191",
      "id": 4,
      "created_at": "2019-09-11 14:33:33 UTC",
      "updated_at": "2019-09-11 14:33:33 UTC"
    }
  ],
  "users": [],
  "roles": []
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be a String

usergroup
必須

Validations:

  • Must be a Hash

usergroup[name]
任意

Validations:

  • Must be a String

usergroup[admin]
任意 , nil可

管理者ユーザーグループ

Validations:

  • Must be one of: true, false, 1, 0.

usergroup[user_ids]
任意 , nil可

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
任意 , nil可

Validations:

  • Must be an array of any type

usergroup[role_ids]
任意 , nil可

Validations:

  • Must be an array of any type


DELETE /api/usergroups/:id
ユーザーグループの削除

DELETE /api/usergroups/17-usergroup202
{
  "usergroup": {}
}
200
{
  "id": 17,
  "name": "usergroup202",
  "created_at": "2019-09-11T14:33:34.088Z",
  "updated_at": "2019-09-11T14:33:34.088Z",
  "admin": false
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be a String