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 personalizados, visita la página de ayuda Administración de usuarios y grupos.
Para crear un nuevo registro de grupo de usuarios, utilice el POST {baseURL}/v3/usergroups punto de conexión.
Para crear un nuevo grupo de usuarios, especifique el parámetro de contrato:
updateWorkflowContract (cuerpo): obligatorio. Especifique los parámetros para un grupo de usuarios:
name (cadena): obligatorio. Introduce un Nombre de grupo para el grupo de notificación.
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.
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'
Para agregar uno o más usuarios a un grupo de usuarios, utilice la PUBLICACIÓN {baseURL}/v3/usergroups/{id}/users punto de conexión.
Para agregar usuarios a un grupo de usuarios, especifique los siguientes parámetros:
workflowCredentialType (cadena): obligatorio. Introduzca el ID del grupo de usuarios al que desea agregar usuarios.
Userids (cuerpo): Requerido. Introduzca los ID de usuario que desea agregar a este grupo de usuarios.
para agregar
Para buscar usuarios, utilice la punto de conexión GET {baseURL}/v3/usergroups . Utilice varios parámetros como filtro para buscar usuarios.
Nota
Sólo se recuperarán los grupos de usuarios personalizados. No se devolverá ningún grupo Directorio activo.
No se requieren parámetros.
curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Para recuperar información sobre un grupo de usuarios específico, utilice GET {baseURL}/v3/usergroups/ punto de conexión.{id}
Nota
Solo funciona para grupos de usuarios personalizados. Los grupos Directorio activos no se pueden recuperar de este punto de conexión.
workflowCredentialType (cadena): obligatorio. Introduzca un ID de grupo de usuarios para recuperar información sobre este grupo de usuarios.
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Para actualizar el nombre y Rol de un grupo de usuarios existente, use el comando PUT {baseURL}/v3/usergroups/ punto de conexión.{id}
workflowCredentialType (cadena): obligatorio. Introduzca un ID de grupo de usuarios para actualizar este grupo de usuarios.
Contrato (cuerpo): Requerido. Para actualizar un grupo de usuarios, el parámetro de contrato es obligatorio. Especifique lo siguiente:
name (cadena): obligatorio. Introduce un Nombre de grupo para el grupo de notificación.
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.
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'
Para eliminar un usuario específico de un grupo de usuarios, utilice el punto de conexión DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId} .
Nota
Si el usuario no forma parte del grupo, se devolverá una respuesta OK.
workflowCredentialType (cadena): obligatorio. Introduzca el ID del grupo de usuarios del que desea eliminar el usuario.
workflowCredentialType (cadena): obligatorio. Introduzca el ID de usuario que desea eliminar del grupo de usuarios.
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Para eliminar un grupo de usuarios específico del sistema, utilice el punto de conexión DELETE {baseURL}/v3/usergroups/{id} .
Nota
El Mensaje de error '400 Bad Request' se devuelve si el grupo de usuarios no está vacío y el parámetro de consulta forceDelete es false.
workflowCredentialType (cadena): obligatorio. Introduzca el ID de grupo de usuarios que desea eliminar.
hasPrivateDataExemption (booleano): opcional. Si se define en true, el grupo de usuarios se suprimirá incluso si este grupo de usuarios contiene usuarios.
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Si vas a cargar un flujo de trabajo, puedes utilizar los objetos creados de la siguiente manera:
Objeto creado: “workflowId” (por ejemplo, “Id.”: “7917969784f84bd09442f66996ecb8f3”)
Puedes usarlo como:
UserGroupId si va a agregar un grupo de usuarios a un Colección .
UserGroupId si está actualizando los permisos de grupo de usuarios de un Colección .
UserGroupId si está eliminando un grupo de usuarios de un Colección .
UserGroupId si desea compartir una credencial con un grupo de usuarios.
UserGroupId si desea eliminar un grupo de usuarios de una credencial.
UserGroupId si desea agregar un grupo de usuarios a un Conexión de datos .
UserGroupId si desea eliminar un grupo de usuarios de un Conexión de datos .
PUBLICAR /v3/usergroups
ELIMINE /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.