GET /api/usergroups
Listar todos los grupos de usuarios

Ejemplos

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Orden y campo de clasificación, p. ej., ‘id DESC’

Validations:

  • Must be a String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.

Campos de búsqueda

Nombre del campo Tipo Valores posibles
name string
role string
role_id integer

GET /api/usergroups/:id
Mostrar un grupo de usuarios

Ejemplos

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

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
Crear un grupo de usuarios

Ejemplos

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

usergroup
requerido

Validations:

  • Must be a Hash

usergroup[name]
requerido

Validations:

  • Must be a String

usergroup[admin]
opcional , nil permitido

es un grupo de usuarios administradores

Validations:

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

usergroup[user_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type

usergroup[role_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type


PUT /api/usergroups/:id
Actualizar un grupo de usuarios

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.

Ejemplos

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be a String

usergroup
requerido

Validations:

  • Must be a Hash

usergroup[name]
opcional

Validations:

  • Must be a String

usergroup[admin]
opcional , nil permitido

es un grupo de usuarios administradores

Validations:

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

usergroup[user_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type

usergroup[role_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type


DELETE /api/usergroups/:id
Borrar un grupo de usuarios

Ejemplos

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
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be a String