Skip to main content

Puntos de conexión de credenciales

Parámetros y puntos de conexión de las credenciales

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 las credenciales, visita la página de ayuda Credenciales .

Nota

No permitimos que se creen credenciales a través de la API. Para crear una credencial como administrador, utiliza la Interfaz de usuario de Alteryx Server .

Recuperar todos los registros de credenciales

Para recuperar todos los registros de credenciales accesibles, utiliza el punto de conexión GET {baseURL}/v3/credentials .

Nota

Si no eres un administrador, los resultados se limitan a credenciales a las que tienes acceso, y los parámetros view, userId y userGroupId no se tendrán en cuenta.

Parámetros

  • view (cadena): opcional. Se puede dejar sin un valor. Puedes elegir entre los siguientes valores: “Predeterminado” y “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).

  • userId (cadena): opcional. Para filtrar los resultados por userId, ingresa el ID de un usuario.

  • userGroupId (cadena): opcional. Para filtrar los resultados por userGroupId, ingresa el ID de un grupo de usuarios.

Recuperar un registro de credencial

Para obtener detalles sobre una credencial existente, utiliza el punto de conexión GET {baseURL}/v3/credentials/{credentialId} .

Parámetros

  • credentialId (cadena): obligatorio. Ingresa un ID de colección para obtener información acerca de una credencial específica.

Compartir una credencial con un usuario

Para compartir una credencial existente con un usuario existente, utiliza el punto de conexión POST {baseURL} /v3/credentials/{credentialId}/users .

Nota

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

Parámetros

  • credentialId (cadena): obligatorio. Ingresa un ID de colección que desees compartir.

  • contract (cuerpo): obligatorio. Especifica lo siguiente para compartir una credencial con un usuario:

    • userId (cadena): obligatorio. Especifica el ID de un usuario con el que deseas compartir una credencial.

Compartir una credencial con un grupo de usuarios

Para compartir una credencial existente con un grupo de usuarios existente, utiliza el punto de conexión POST {baseURL} /v3/credentials/{credentialId}/userGroups .

Nota

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

Parámetros

  • credentialId (cadena): obligatorio. Ingresa un ID de credencial que desees compartir.

  • contract (cuerpo): obligatorio. Especifica lo siguiente para compartir una credencial con un grupo de usuarios:

    • userGroupId (cadena): obligatorio. Especifica el ID de un grupo de usuarios con el que desees compartir una credencial.

Quitar el permiso de un usuario para usar una credencial

A fin de quitar el permiso de un usuario para usar una credencial existente, utiliza el punto de conexión DELETE {baseURL}/v3/credentials/{credentialId}/users/{userId} .

Nota

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

Parámetros

  • credentialId (cadena): obligatorio. Ingresa el ID de credencial del que deseas quitar el usuario.

  • userId (cadena): obligatorio. Ingresa un ID de usuario que desees quitar de la credencial.

Quitar el permiso de un grupo de usuarios para usar una credencial

A fin de quitar el permiso de un grupo de usuarios para usar una credencial existente, utiliza el punto de conexión DELETE {baseURL}/v3/credentials/{credentialId}/userGroups/{userGroupId} .

Nota

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

Parámetros

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

  • userGroupId (cadena): obligatorio. Ingresa un ID de grupo de usuarios que desees quitar de la credencial.

Eliminar una credencial

Para eliminar una credencial existente, utiliza el punto de conexión DELETE {baseURL}/v3/credentials/{credentialId} .

Nota

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

Parámetros

  • credentialId (cadena): obligatorio. Ingresa el ID de credencial que deseas eliminar.

  • force (booleano): opcional. Selecciona si deseas forzar la eliminación de una credencial en caso de que haya algún recurso compartido. Si deseas eliminar la credencial y limpiar todos los recursos compartidos, establece el parámetro force en verdadero. Si no se selecciona, el valor predeterminado es falso. Esto es para protegerse contra una llamada errante.

Relaciones entre objetos

Para obtener información sobre los ID de credencial existentes, utiliza el punto de conexión GET /v3/credentials . El credentialId que obtienes se puede utilizar en las siguientes situaciones: