Ejemplo: API REST de Group Management

Este ejemplo muestra cómo utilizar la API REST Group Management de operaciones en la nube para acciones típicas de gestión de grupos.

El ejemplo le muestra cómo visualizar grupos y miembros de grupos, añadir miembros y suprimir miembros de grupos del sistema. Para obtener una lista de los grupos de sistemas para cada una de las capacidades, consulte Grupos de sistemas.
Nota: Este ejemplo no se aplica a IBM® Operational Decision Manager on Cloud.
Antes de empezar
Todas las llamadas de API requieren una señal de falsificación de solicitud entre sitios (CSRF) válida en la cabecera IBM-CSRF-TOKEN de la llamada. Obtenga una señal CSRF mediante POST /instance/services/csrf_token. Para obtener más información, consulte Cómo evitar la falsificación de solicitudes entre sitios.
Visualizar grupos y los miembros correspondientes
Utilice la llamada siguiente para visualizar los grupos:
GET /instance/services/groups
Para filtrar la lista de grupos para que incluyan una serie determinada, incluya un término de búsqueda en la llamada, por ejemplo Administrators.
GET /instance/services/groups?search_term=Administrators
Si ningún grupo coincide con el término de búsqueda, el objeto JSON devuelto por la llamada contiene una lista vacía.
Para incluir los miembros de grupo en la lista de grupos, añada el parámetro optional_parts a la llamada. Tenga en cuenta que este parámetro puede afectar significativamente al rendimiento de la llamada y que debe utilizarlo en combinación con términos de búsqueda o paginación.
GET /instance/services/groups?search_term=Administrators&optional_parts=members
Añadir miembros a un grupo de sistemas
La suscripción de Cloud incluye los siguientes grupos de usuarios del sistema: Administradores, Operadores, Participantes, Desarrolladores y Testers. Por ejemplo, para añadir miembros nuevos al grupo Administrators utilice la llamada siguiente e incluya los IDs de usuario de los miembros nuevos en el cuerpo de la llamada.
POST /instance/services/groups/Administrators/members
...
{
 "group_members": [
    {
      "member_id": "john.smith@host.com",
      "type": "user"
    },
    {
      "member_id": "jane.brown@host.com",
      "type": "user"
    }
  ]
}
Actualizar información de miembros para un grupo de sistemas
Puede actualizar la información de miembro enviando el objeto JSON completo, incluidos todos los miembros del grupo, en el cuerpo de la llamada. Por ejemplo, si John Smith y Jane Brown pasan al equipo de prueba y sus responsabilidades administrativas las asumen completamente David Short y Ann Jones, sustituya los nombres de John y Jane en el objeto JSON que envía con la llamada por los nombres de David y Ann:
PUT /instance/services/groups/Administrators/members
...
{
 "group_members": [
    {
      "member_id": "david.short@host.com",
      "type": "user"
    },
    {
      "member_id": "ann.jones@host.com",
      "type": "user"
    }
  ]
}
La información de usuario almacenada se sustituye completamente por la información que se envía en el cuerpo de solicitud. Si omite las propiedades del objeto JSON, por ejemplo, si omite usuarios de la lista de miembros del grupo, los usuarios se eliminan del grupo.
Sugerencia: Tenga cuidado al actualizar la información de miembro. Si olvida incluir el objeto JSON con la llamada, eliminará todos los miembros del grupo que está actualizando.
Suprimir miembros de un grupo de sistemas
Por ejemplo, para suprimir miembros del grupo Administrators utilice la llamada siguiente:
DELETE /instance/services/groups/Administrators/members
...
{
 "group_members": [
    {
      "member_id": "john.smith@host.com",
      "type": "user"
    },
    {
      "member_id": "jane.brown@host.com",
      "type": "user"
    }
  ]
}