GET /api/usergroups
Elenca tutti i gruppi di utenti

Esempi

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
    }
  ]
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

search
opzionale

filtra i risultati

Validations:

  • Must be a String

order
opzionale

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
opzionale

Numero pagina, iniziando da 1

Validations:

  • Must be a number.

per_page
opzionale

Numero di risultati per pagina da ritornare

Validations:

  • Must be a number.

Search fields

Field name Tipo Possible values
name string
role string
role_id integer

GET /api/usergroups/:id
Mostra un gruppo di utenti

Esempi

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": []
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

id
richiesto

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
Crea un gruppo di utenti

Esempi

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": []
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

usergroup
richiesto

Validations:

  • Must be a Hash

usergroup[name]
richiesto

Validations:

  • Must be a String

usergroup[admin]
opzionale , consentito nil

is an admin user group

Validations:

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

usergroup[user_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type

usergroup[role_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type


PUT /api/usergroups/:id
Aggiorna un gruppo di utenti

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.

Esempi

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": []
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

id
richiesto

Validations:

  • Must be a String

usergroup
richiesto

Validations:

  • Must be a Hash

usergroup[name]
opzionale

Validations:

  • Must be a String

usergroup[admin]
opzionale , consentito nil

is an admin user group

Validations:

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

usergroup[user_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type

usergroup[role_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type


DELETE /api/usergroups/:id
Cancella un gruppo di utenti

Esempi

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
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

id
richiesto

Validations:

  • Must be a String