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 grupos de usuarios de Sever, visita la página de ayuda Administración de usuarios y grupos
Crear un nuevo grupo de usuarios
Para crear un nuevo grupo de usuarios, utiliza el punto de conexión
POST {baseURL}/v3/usergroups
.
Nota
Solo los administradores pueden usar este punto de conexión de la API.
Parámetros
Para crear un nuevo grupo de usuarios de Server, especifica el parámetro contract:
contract (cuerpo): obligatorio. Especifica los parámetros de un grupo de usuarios de Server:
name (cadena): obligatorio. Ingresa un nombre de grupo de usuarios de Server.
role (cadena): obligatorio. Ingresa un rol para este grupo de usuarios de Server. 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 Permisos y roles de usuarios .
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 usuarios a un grupo de usuarios
Para agregar 1 o más usuarios existentes a un grupo de usuarios existente, utiliza el punto de conexión
POST {baseURL}/v3/usergroups/{userGroupId}/users
.
Nota
Solo los administradores pueden usar este punto de conexión de la API.
Parámetros
Para agregar usuarios a un grupo de usuarios de Server, especifica los siguientes parámetros:
userGroupId (cadena): obligatorio. Ingresa el ID del grupo de usuarios al que deseas agregar usuarios.
userIds (cuerpo): obligatorio. Ingresa la lista de ID de usuarios que deseas agregar a este grupo de usuarios, separados por comas.
Agregar un grupo de Active Directory a un grupo de usuarios
Para agregar un grupo de Active Directory a un grupo de usuarios existente, utiliza el punto de conexión
POST /v3/usergroups/{userGroupId}/activedirectorygroups
.
Nota
Solo los administradores pueden usar este punto de conexión de la API.
Este punto de conexión solo se puede usar para las instancias de Server configuradas con autenticación de Windows.
Parámetros
userGroupId (cadena): obligatorio. Ingresa el ID de un grupo de usuarios existente al que deseas agregar un grupo de Active Directory.
sid (cadena): obligatorio. Ingresa el identificador de seguridad (SID) del grupo Active Directory. Esta es una carga del cuerpo de JSON. Debes enviar el valor en comillas, por ejemplo “S-My-SID”.
Recuperar todos los grupos de usuarios
Para recuperar todos los registros de grupos de usuarios accesibles, utiliza el punto de conexión
GET {baseURL}/v3/usergroups
. Utiliza varios parámetros como filtro para buscar a los usuarios.
Nota
Solo los administradores pueden usar este punto de conexión de la API.
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'
Recuperar detalles de un grupo de usuarios específico
Para obtener detalles sobre un grupo de usuarios existente, utiliza el punto de conexión
GET {baseURL}/v3/usergroups/{userGroupId}
.
Nota
Solo los administradores pueden usar este punto de conexión de la API.
Solo funciona para grupos de usuarios de Server. Los grupos de Active Directory no se pueden recuperar desde este punto de conexión.
Parámetros
userGroupId (cadena): obligatorio. Ingresa un ID de grupo de usuarios existente 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/{userGroupId}
.
Nota
Solo los administradores pueden usar este punto de conexión de la API.
Parámetros
userGroupId (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 Permisos y roles de usuarios .
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 existente, utiliza el punto de conexión
DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId}
.
Nota
Solo los administradores pueden usar este punto de conexión de la API.
Si el usuario no forma parte del grupo de usuarios, 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'
Quitar un grupo de Active Directory de un grupo de usuarios
Para quitar un grupo de Active Directory de un grupo de usuarios existente, utiliza el punto de conexión
DELETE /v3/usergroups/{userGroupId}/activedirectorygroups/{adGroupSid}
.
Nota
Solo los administradores pueden usar este punto de conexión de la API.
Este punto de conexión solo se puede usar para las instancias de Server configuradas con autenticación de Windows.
Parámetros
userGroupId (cadena): obligatorio. Ingresa el identificador del grupo de usuarios del que deseas quitar el grupo de Active Directory.
adGroupSid (cadena): obligatorio. Ingresa el identificador de seguridad (SID) del grupo de Active Directory que deseas quitar del grupo de usuarios.
Eliminar un grupo de usuarios
Para eliminar un grupo de usuarios existente del sistema, utiliza el punto de conexión
DELETE {baseURL}/v3/usergroups/{userGroupId}
.
Nota
Solo los administradores pueden usar este punto de conexión de la API.
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
userGroupId (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:
userGroupId si vas a agregar un grupo de usuarios a una colección .
userGroupId si vas a actualizar los permisos de grupo de usuarios de una colección .
userGroupId si vas a quitar un grupo de usuarios de una colección .
userGroupId si deseas compartir una credencial con un grupo de usuarios .
userGroupId si deseas quitar un grupo de usuarios de una credencial .
userGroupId si deseas agregar un grupo de usuarios a una conexión de datos .
userGroupId si deseas quitar un grupo de usuarios de una conexión de datos .
Ejemplos de solicitudes de Postman
POST /v3/usergroups
DELETE /v3/usergroups/{userGroupId}/users/{userId}
Para obtener más información sobre las solicitudes de Postman, visita la página de ayuda Cómo usar Postman .