Skip to main content

Puntos de conexión de grupos de usuarios

Parámetros y puntos de conexión de los grupos de usuarios

Para obtener más información sobre las relaciones entre objetos y cómo utilizarlas en la API, ve a la sección Relaciones entre objetos.

Para obtener más información sobre los grupos personalizados, visita la página de ayuda de Administrar usuarios y grupos.Administrar usuarios y grupos

Crear un nuevo grupo de usuarios

Para crear un nuevo registro de userGroup, utiliza el punto de conexión POST {baseURL}/v3/usergroups.

Parámetros

Para crear un nuevo grupo de usuarios, especifica el parámetro contract:

  • contract (cuerpo): obligatorio. Especifica los parámetros de un grupo de usuarios:

    • name (cadena): obligatorio. Ingresa un nombre de grupo de usuarios.

    • role (cadena): obligatorio. Ingresa un rol para este grupo de usuarios. Selecciona entre estas opciones: Sin acceso, Visualizador, Miembro, Creador, Administrador y Evaluado. El rol predeterminado (Evaluado) se evalúa en el tiempo de ejecución. Para obtener más información acerca de los roles y permisos, visita la página Roles y permisos de usuarios.Roles de usuarios y permisos

Ejemplo de solicitud: cURL

curl --location --request POST 'http://localhost/webapi/v3/usergroups' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'role=Artisan'

Agregar un usuario a un grupo de usuarios

Para agregar uno o más usuarios a un grupo de usuarios, utiliza el punto de conexión POST {baseURL}/v3/usergroups/{id}/users.

Parámetros

Para agregar usuarios a un grupo de usuarios, especifica los siguientes parámetros:

  • id (cadena): obligatorio. Ingresa el ID del grupo de usuarios al que deseas agregar usuarios.

  • userIds (cuerpo): obligatorio. Ingresa los ID de usuario que deseas agregar a este grupo de usuarios.

Ejemplo de solicitud: cURL

Para agregar.

Recuperar todos los grupos de usuarios personalizados

Para buscar usuarios, utiliza el punto de conexión GET {baseURL}/v3/usergroups. Utiliza varios parámetros como filtro para buscar a los usuarios.

Nota

Solo se recuperarán los grupos de usuarios personalizados. No se devolverán grupos de Active Directory.

Parámetros

No se requieren parámetros.

Ejemplo de solicitud: cURL

curl --location --request GET 'http://localhost/webapi/v3/usergroups' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Buscar un grupo de usuarios específico

Para recuperar información acerca de un grupo de usuarios específico, utiliza el punto de conexión GET {baseURL}/v3/usergroups/{id}.

Nota

Solo funciona para grupos de usuarios personalizados. Los grupos de Active Directory no se pueden recuperar desde este punto de conexión.

Parámetros

  • id (cadena): obligatorio. Ingresa un ID de grupo de usuarios para recuperar información sobre este grupo de usuarios.

Ejemplo de solicitud: cURL

curl --location --request GET 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Actualizar un grupo de usuarios

Para actualizar el nombre y el rol de un grupo de usuarios existente, utiliza el punto de conexión PUT {baseURL}/v3/usergroups/{id}.

Parámetros

  • id (cadena): obligatorio. Ingresa un ID de grupo de usuarios para actualizar este grupo de usuarios.

  • contract (cuerpo): obligatorio. Para actualizar un grupo de usuarios, se requiere el parámetro contract. Especifica lo siguiente:

    • name (cadena): obligatorio. Ingresa un nombre de grupo de usuarios.

    • role (cadena): obligatorio. Puedes seleccionar entre estas opciones: Sin acceso, Visualizador, Miembro, Creador, Administrador y Evaluado. Para obtener más información acerca de los roles y permisos, visita la página Roles y permisos de usuarios.Roles de usuarios y permisos

Ejemplo de solicitud: cURL

curl --location --request PUT 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Marketing' \ --data-urlencode 'role=Artisan'

Quitar un usuario de un grupo de usuarios

Para quitar un usuario específico de un grupo de usuarios, utiliza el punto de conexión DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId}.

Nota

Si el usuario no forma parte del grupo, se devolverá la respuesta Aceptar.

Parámetros

  • userGroupId (cadena): obligatorio. Ingresa el ID del grupo de usuarios del que deseas quitar el usuario.

  • userId (cadena): obligatorio. Ingresa el ID de usuario que deseas quitar del grupo de usuarios.

Ejemplo de solicitud: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069/users/61d564361d6d5da7ad461a32' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Eliminar un grupo de usuarios

Para eliminar un grupo de usuarios específico del sistema, utiliza el punto de conexión DELETE {baseURL}/v3/usergroups/{id}.

Nota

Se devuelve el mensaje de error “400 Solicitud errónea” si el grupo de usuarios no está vacío y el parámetro de consulta forceDelete es falso.

Parámetros

  • id (cadena): obligatorio. Ingresa el ID del grupo de usuarios que deseas eliminar.

  • forceDelete (booleano): opcional. Si se establece en verdadero, el grupo de usuarios se eliminará incluso si este grupo de usuarios contiene usuarios.

Ejemplo de solicitud: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Relaciones entre objetos

Si creas un grupo de usuarios, puedes utilizar los objetos creados de la siguiente manera:

Objeto creado: “id” (por ejemplo, “id”: “619158e57e607d0011ac3009”)

Puedes usarlo como:

Ejemplos de solicitudes de Postman

POST /v3/usergroups

Example of a POST request in Postman.

DELETE /v3/usergroups/{userGroupId}/users/{userId}

Example of a DELETE request in Postman.

Para obtener más información sobre las solicitudes de Postman, visita la página de ayuda Cómo usar Postman.