Puntos de conexión de usuarios
Parámetros y puntos de conexión de los usuarios
Para obtener más información sobre las relaciones de objetos, vaya a la #relaciones-entre-objetos-6518518 sección Relaciones de objetos.
Para obtener más información sobre usuarios, visita la página de ayuda Administración de usuarios y grupos.
Crear un nuevo usuario
Para crear un nuevo registro de usuario, utilice el POST {baseURL}/v3/users punto de conexión.
Nota
Este punto de conexión solo se puede usar para las instancias de Server configuradas con autenticación de Windows.
Parámetros
UserContract (cuerpo): Para crear un nuevo usuario, se requiere el parámetro userContract. Especifique los siguientes parámetros:
workflowCredentialType (cadena): obligatorio. Introduzca el nombre de un usuario.
workflowCredentialType (cadena): obligatorio. Introduzca el apellido de un usuario.
workflowCredentialType (cadena): obligatorio. Introduzca la dirección de correo electrónico de un usuario.
role (cadena): opcional. Puedes seleccionar entre estas opciones: Sin acceso, Visualizador, Miembro, Creador, Administrador y Evaluado (el rol predeterminado evaluado 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. Cuando no se selecciona ningún rol, el valor predeterminado es el rol Evaluado.
defaultWorkerTag (cadena): opcional. Especifica la etiqueta de trabajador definida en los trabajadores para ayudar a asignar tareas a determinados nodos de trabajadores. Cuando no se especifica, el valor predeterminado es "". Para obtener más información, visita la página de ayuda Trabajador.
canScheduleJobs (booleano): opcional. Especifica si el usuario puede programar tareas. Cuando no se especifica, el valor predeterminado es falso. Para obtener más información, visita la página de ayuda Tareas.
canPrioritizeJobs (booleano): opcional. Especifica si un usuario puede priorizar las tareas. Cuando no se especifica, el valor predeterminado es falso. Para obtener más información, visita la página de ayuda Tareas.
canAssignJobs (booleano): opcional. Especifica si un usuario puede asignar tareas. Cuando no se especifica, el valor predeterminado es falso. Para obtener más información, visita la página de ayuda Tareas.
canCreateCollections (booleano): opcional. Especifica si un usuario puede crear nuevas colecciones. Cuando no se especifica, el valor predeterminado es falso. Para obtener más información, visita la página de ayuda Colecciones.
isPublic (booleano): opcional. Especifique si la API está activada para un usuario. Si no se selecciona, el valor predeterminado es “false” (falso).
credentialId (cadena): opcional. Este parámetro hace referencia al ID único de un Flujo de trabajo, asignado al usuario por defecto. Cuando no se especifica, se utiliza el valor “Default" (predeterminado).
force (booleano): opcional. Seleccione si un usuario está activo o desactivado. Cuando no se especifica, se utiliza el valor “Default" (predeterminado).
dirección (cadena): opcional. Introduzca la zona horaria, por ejemplo, Europa/Kiev. Cuando no se especifica, se utiliza el valor “Default" (predeterminado).
Ejemplo de solicitud: cURL
Curl --location --request POST 'http://localhost/webapi/v3/users' \ --header 'Content-Type: Application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'FirstName=John' \ --data-urlencode 'LastName=Doe' \ --data-urlencode 'email=John.Doe@emailexample.com'
Desactivar un usuario
Para desactivar un usuario en el sistema, utilice el POST {baseURL}/v3/users/{id}/Deactivate punto de conexión.
Parámetros
workflowCredentialType (cadena): obligatorio. Introduzca un ID de usuario para desactivarlo.
Ejemplo de solicitud: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Restablecer una contraseña para un usuario
Para restablecer y enviar un correo electrónico de restablecimiento de contraseña para un usuario específico, utilice la PUBLICACIÓN {baseURL}/v3/users/{id}/passwordReset punto de conexión.
Nota
Este punto de conexión solo se puede usar para las instancias de Server configuradas con autenticación de Windows.
Parámetros
workflowCredentialType (cadena): obligatorio. Introduzca un ID de usuario para restablecer su contraseña.
Ejemplo de solicitud: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Buscar usuarios
Para buscar usuarios, utilice la punto de conexión GET {baseURL}/v3/users . Utilice varios parámetros como filtro para buscar usuarios.
Parámetros
view (cadena): opcional. Se puede dejar sin un valor. Puedes seleccionar entre los siguientes valores: “Default" (predeterminado) y "Full" (completo). Si este parámetro se define como “Default" (predeterminado), entonces se devolverá un objeto de vista reducida. Cuando no se especifica, se utiliza el valor “Default" (predeterminado).
force (booleano): opcional. Seleccione si un usuario está activo o desactivado.
limit (cadena): opcional. Introduzca la dirección de correo electrónico del usuario.
role (cadena): opcional. Selecciona el rol de usuario para limitar la búsqueda. 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.
limit (cadena): opcional. Introduzca el nombre del usuario.
limit (cadena): opcional. Introduzca el apellido del usuario.
CreatedAfter (fecha-hora): Opcional. Ingresa la fecha y la hora después de la cual se creó el flujo de trabajo. Ingresa la fecha y la hora en formato ISO8601.
CreatedBefore (fecha-hora): Opcional. Ingresa la fecha y la hora antes de la cual se creó el flujo de trabajo. Ingresa la fecha y la hora en formato ISO8601.
Ejemplo de solicitud: cURL
Curl --location --request GET 'http://localhost/webapi/v3/users?view=Full&active=true&lastName=Doe' \ --header 'Autorización: Portador BearerTokenGoesHere'
Buscar un usuario
Para buscar un usuario específico, utilice GET {baseURL}/v3/users/ punto de conexión.{id}
Parámetros
workflowCredentialType (cadena): obligatorio. Introduzca un ID de usuario para recuperar información sobre este usuario.
Ejemplo de solicitud: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Recuperar todos los activos que posee un usuario
Para obtener una lista completa de los activos que posee un usuario, utilice GET {baseURL}/v3/users/{id}/Assets punto de conexión.
Parámetros
workflowCredentialType (cadena): obligatorio. Introduzca un ID de usuario para recuperar la lista de activos de este usuario.
offset (cadena): opcional. Seleccione los tipos de activos que desea devolver. El valor predeterminado es 'Todo'.
Ejemplo de solicitud: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Actualizar un usuario existente
Para actualizar un usuario existente, utilice la punto de conexión PUT{baseURL}/v3/users/{id} .
Nota
El ID de updateContract se sobrescribirá con el valor de ID de la URL.
Parámetros
workflowCredentialType (cadena): obligatorio. Introduzca un ID de usuario para actualizar este usuario.
updateWorkflowContract (cuerpo): obligatorio. Para actualizar un usuario, es necesario el parámetro updateContract. Especifique lo siguiente:
limit (cadena): opcional. Introduzca un ID de usuario para actualizarlo.
workflowCredentialType (cadena): obligatorio. Introduzca el nombre de un usuario.
workflowCredentialType (cadena): obligatorio. Introduzca el apellido de un usuario.
workflowCredentialType (cadena): obligatorio. Introduzca la dirección de correo electrónico de un usuario.
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.
defaultWorkerTag (cadena): obligatorio. Especifica la etiqueta de trabajador definida en los trabajadores para ayudar a asignar tareas a determinados nodos de trabajadores. Para obtener más información sobre trabajadores, visita la página de ayuda Trabajador.
canScheduleJobs (booleano): obligatorio. Especifica si un usuario puede programar tareas. Para obtener más información, visita la página de ayuda Tareas.
canPrioritizeJobs (booleano): obligatorio. Especifica si un usuario puede priorizar las tareas. Para obtener más información, visita la página de ayuda Tareas.
canAssignJobs (booleano): obligatorio. Especifica si un usuario puede asignar tareas. Para obtener más información, visita la página de ayuda Tareas.
canCreateCollections (booleano): opcional. Especifica si un usuario puede crear colecciones. Cuando no se especifica, el valor permanece igual que antes. Para obtener más información, visita la página de ayuda Colecciones.
makePublished (booleano): obligatorio. Especifique si la API está activada para un usuario.
workflowCredentialType (cadena): obligatorio. Este parámetro hace referencia al ID único de un Flujo de trabajo, asignado al usuario por defecto.
makePublished (booleano): obligatorio. Seleccione si desea bloquear esta cuenta de usuario.
makePublished (booleano): obligatorio. Seleccione si un usuario está activo o desactivado.
makePublished (booleano): obligatorio. Especifique si se valida la dirección de correo electrónico de un usuario.
name (cadena): obligatorio. Introduzca la zona horaria, por ejemplo, Europa/Kiev, etc.
workflowCredentialType (cadena): obligatorio. Los valores de idioma admitidos son «de-de», «en-us», «es-es», «fr-fr», «it-it», ja-jp, pt-br, zh-cn.
Ejemplo de solicitud: cURL
Curl --location --request PUT 'http://localhost/webapi/v3/users/61d564361d6d5da7ad461a32' \ --header 'Content-Type: Application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'FirstName=Doe' \ --data-urlencode 'LastName=Jane' \ --data-data-urlenlenlenlenlenlendCode' - 'Workwork' 'jdoe@alteryx.com' data-urlencode 'canAssignJobs=true' \ --data-urlencode 'canCreateCollections=true' \ --data-urlencode 'isApiEnabled=true' \ --data-urlencode 'defaultCredentialId=jdoe' \ --data-urlencode 'isAccountLocked=true'
Eliminar usuario
Para eliminar un usuario específico del sistema, utilice la punto de conexión DELETE {baseURL}/v3/users/{id} .
Nota
Si el usuario que desea eliminar tiene activos (flujos de trabajo, Programaciones, colecciones, información) o grupos de usuarios asignados, este usuario no se puede eliminar.
Parámetros
workflowCredentialType (cadena): obligatorio. Introduzca el ID de usuario que desea eliminar.
Ejemplo de solicitud: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Relaciones entre objetos
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:
UserId si va a agregar usuarios a un grupo de usuarios.
UserId si va a eliminar un usuario de un grupo de usuarios.
workflowId si vas a buscar un flujo de trabajo específico.
OwnerID si está cargando un Flujo de trabajo .
UserId si va a agregar un usuario desde un Colección .
appId si estás eliminando flujos de trabajo de una colección.
UserId si está actualizando permisos de usuario para un Colección .
workflowId si vas a buscar una programación.
UserId si desea compartir una credencial con un usuario.
UserId si desea eliminar un usuario de una credencial.
UserId si desea agregar un usuario a un Conexión de datos existente.
UserId si desea eliminar un usuario de un Conexión de datos existente.
Ejemplos de solicitudes de Postman
OBTENER /v3/users
OBTENER /v3/users/{id}/assets
Para obtener más información sobre las solicitudes de Postman, visita la página de ayuda Cómo usar Postman.