Skip to main content

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 entre objetos, ve a la sección Relaciones entre 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, utiliza el punto de conexión POST {baseURL}/v3/users .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Este punto de conexión no 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. Especifica los siguientes parámetros:

    • firstName (cadena): obligatorio. Ingresa el nombre de un usuario.

    • lastName (cadena): obligatorio. Ingresa el apellido de un usuario.

    • email (cadena): obligatorio. Ingresa 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 Permisos y roles 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 .

    • isApiEnabled (booleano): opcional. Especifica si la API está habilitada para un usuario. Cuando no se especifica, el valor predeterminado es falso.

    • defaultCredentialId (cadena): opcional. Este parámetro se refiere al ID único de un flujo de trabajo, asignado al usuario como predeterminado. Cuando no se especifica, el valor predeterminado es "".

    • isActive (booleano): opcional. Selecciona si un usuario está activo o desactivado. Cuando no se especifica, el valor predeterminado es verdadero.

    • timeZone (cadena): opcional. Ingresa la zona horaria, por ejemplo, Europa/Kiev. Cuando no se especifica, el valor predeterminado es "".

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, utiliza el punto de conexión POST {baseURL}/v3/users/{userId}/deactivate .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Como respuesta, obtienes una matriz de ID de grupo de usuarios de los que se quita el usuario desactivado.

Parámetros

  • userId (cadena): obligatorio. Ingresa un ID de usuario para desactivar este usuario.

Ejemplo de solicitud: cURL

curl --location --request POST 'http://localhost/webapi/v3/users/61d57bea3c15317e1a48205b/deactivate' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Enviar un correo electrónico de restablecimiento de contraseña a un usuario

Para enviar un correo electrónico de restablecimiento de contraseña a un usuario existente, utiliza el punto de conexión POST {baseURL}/v3/users/{userId}/passwordReset .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Este punto de conexión no se puede usar para las instancias de Server configuradas con autenticación de Windows y SAML.

Parámetros

  • userId (cadena): obligatorio. Ingresa un ID de usuario para enviar un correo electrónico de restablecimiento al usuario.

Ejemplo de solicitud: cURL

curl --location --request POST 'http://localhost/webapi/v3/users/61d57bea3c15317e1a48205b/passwordReset' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Recuperar todos los registros de usuario

Para recuperar todos los registros de usuario accesibles, utiliza el punto de conexión GET {baseURL}/v3/users . Utiliza varios parámetros como filtro.

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Si searchContract.Verbose se establece como falso, entonces se devolverá un objeto de vista reducida.

Parámetros

  • view (cadena): opcional. Se puede dejar sin un valor. Puedes elegir 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).

  • active (booleano): opcional. Selecciona si un usuario está activo o desactivado.

  • email (cadena): opcional. Ingresa 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 Permisos y roles de usuarios .

  • firstName (cadena): opcional. Ingresa el nombre del usuario.

  • lastName (cadena): opcional. Ingresa el apellido del usuario.

  • createdAfter (fecha y hora): opcional. Ingresa la fecha y la hora después de la cual se creó el usuario. Ingresa la fecha y la hora en formato ISO8601.

  • createdBefore (fecha y hora): opcional. Ingresa la fecha y la hora antes de la cual se creó el usuario. 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 'Authorization: Bearer BearerTokenGoesHere'

Recuperar los detalles sobre un usuario específico

Para recuperar detalles sobre un usuario existente, utiliza el punto de conexión GET {baseURL}/v3/users/{userId} .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • userId (cadena): obligatorio. Ingresa un ID de usuario para recuperar detalles sobre este usuario.

Ejemplo de solicitud: cURL

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

Recuperar todos los activos que posee un usuario

Para obtener una lista completa de los activos accesibles que posee un usuario existente, utiliza el punto de conexión GET {baseURL}/v3/users/{userId}/assets .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • userId (cadena): obligatorio. Ingresa un ID de usuario para recuperar la lista de activos de este usuario.

  • assetType (cadena): opcional. Selecciona los tipos de activos que deseas devolver. De forma predeterminada, se establece en “Todos”.

Ejemplo de solicitud: cURL

curl --location --request GET 'http://localhost/webapi/v3/users/61d564361d6d5da7ad461a32/assets?assetType=Workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Transfer All Assets a User Owns to Another

To transfer all assets (workflows, schedules, and collections) owned by one user to another, use the PUT {baseURL}/v3/users/{userId}/assetTransfer endpoint.

Nota

  • Only Curators can use this API endpoint.

  • If any of the workflows require DCM connections, Server connections, or specific run as credentials to run, these items need to be updated before the workflow can run.

  • If users are not in the same studio and when a workflow is transferred to the new studio, all other users in the new owner's studio will also receive access to the workflow, and all users from the old studio will lose access.

  • Workflows can only be transferred to a user with the Artisan or Curator role.

  • If transferring schedules, the new owner must have access to the scheduled workflow, otherwise you won’t be able to transfer that workflow to the new owner.

  • If transferring schedules, the new owner must have permission to schedule workflows.

  • If the user is deleted, it returns a list of schedule Ids that will be broken or disabled after transfer.

Parameters

  • userId (string): Required. Id of the user to transfer assets from.

  • contract (body):

    • ownerId (string): Specify the Id of the user to transfer assets to (new owner).

    • transferWorkflows (Boolean): Specify whether the workflows should be transferred to the new owner.

    • transferSchedules (Boolean): Specify whether the schedules should be transferred to the new owner.

    • transferCollections (Boolean): Specify whether the collections should be transferred to the new owner.

Request Example: cURL

curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ "ownerId": "63d17f6cb049da66d0afd4e2", \ "transferWorkflows": true, \ "transferSchedules": true, \ "transferCollections": true \ }' 'http://localhost/webapi/v3/users/613a523df9199abfc446d19d/assetTransfer'

Actualizar un usuario existente

Para actualizar los detalles de un usuario existente, utiliza el punto de conexión PUT {baseURL}/v3/users/{userId} .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

El ID de updateContract se sobrescribirá por el valor de ID en la URL.

Parámetros

  • userId (cadena): obligatorio. Ingresa un ID de usuario para que este usuario se actualice.

  • updateContract (cuerpo): obligatorio. Para actualizar un usuario, se requiere el parámetro updateContract. Especifica lo siguiente:

    • id (cadena): opcional. Ingresa un ID de usuario para actualizarlo.

    • firstName (cadena): obligatorio. Ingresa el nombre de un usuario.

    • lastName (cadena): obligatorio. Ingresa el apellido de un usuario.

    • email (cadena): obligatorio. Ingresa 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 Permisos y roles 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 .

    • isApiEnabled (booleano): obligatorio. Especifica si la API está habilitada para un usuario.

    • defaultCredentialId (cadena): obligatorio. Este parámetro se refiere al ID único de un flujo de trabajo, asignado al usuario como predeterminado.

    • isAccountLocked (booleano): obligatorio. Selecciona si deseas bloquear esta cuenta de usuario.

    • isActive (booleano): obligatorio. Selecciona si un usuario está activo o desactivado.

    • isValidated (booleano): obligatorio. Especifica si la dirección de correo electrónico de un usuario está validada.

    • timeZone (cadena): obligatorio. Ingresa la zona horaria, por ejemplo, Europa/Kiev, etc.

    • language (cadena): obligatorio. Los valores de idioma compatibles 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-urlencode 'email=jdoe@alteryx.com' \ --data-urlencode 'role=Artisan' \ --data-urlencode 'defaultWorkerTag=worker' \ --data-urlencode 'canScheduleJobs=true' \ --data-urlencode 'canPrioritizeJobs=true' \ --data-urlencode 'canAssignJobs=true' \ --data-urlencode 'canCreateCollections=true' \ --data-urlencode 'isApiEnabled=true' \ --data-urlencode 'defaultCredentialId=jdoe' \ --data-urlencode 'isAccountLocked=true' \ --data-urlencode 'isActive=true' \ --data-urlencode 'isValidated=true' \ --data-urlencode 'timeZone=Europe/Prague' \ --data-urlencode 'language=en-us' \ --data-urlencode 'id=61d564361d6d5da7ad461a32'

Eliminar un usuario

Para eliminar un usuario existente del sistema, utiliza el punto de conexión DELETE {baseURL}/v3/users/{userId} .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Si el usuario que deseas eliminar tiene algún activo (flujos de trabajo, programaciones, colecciones, insights) o grupos de usuarios asignados, entonces este usuario no se puede eliminar.

Parámetros

  • userId (cadena): obligatorio. Ingresa el ID de usuario que deseas eliminar.

Ejemplo de solicitud: cURL

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

Relaciones entre objetos

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

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

Puedes usarlo como:

Ejemplos de solicitudes de Postman

GET /v3/users

Example of the GET request in Postman.

GET /v3/users/{id}/assets

Example of the GET request in Postman.

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

En esta sección: