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 un registro de credencial
Para obtener información sobre todos los registros de flujo de trabajo, utiliza el punto de conexión
GET {baseurl}/v3/workflows/
.
Nota
Si no es un Administrador, los resultados se limitan a las credenciales a las que tiene acceso y se ignorarán los parámetros UserId y userGroupId.
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).
ownerId (cadena): opcional. Para filtrar los resultados por ID de usuario, introduzca el ID de un usuario.
versionId (cadena): opcional. Para filtrar los resultados por userGroupId, introduzca el ID de un grupo de usuarios.
Recuperar un registro de credencial
Para recuperar información sobre una credencial, utilice
GET {baseURL}/v3/credentials/ punto de conexión.{credentialId}
Parámetros
workflowCredentialType (cadena): obligatorio. Introduzca un ID de Colección para obtener la información sobre una credencial específica.
Compartir una credencial con un usuario
Para compartir una credencial con un usuario, utilice la punto de conexión POST
{baseURL}
/v3/credentials/{credentialId}/users
.
Parámetros
workflowCredentialType (cadena): obligatorio. Introduzca un ID de Colección que desee compartir.
Contrato (cuerpo): Requerido. Especifique lo siguiente para compartir una credencial con un usuario:
workflowCredentialType (cadena): obligatorio. Especifique el ID del usuario con el que desea compartir una credencial.
Compartir credenciales con grupos de usuarios
Para compartir una credencial con un grupo de usuarios, utilice la punto de conexión /
{baseURL}
v3/credentials/{credentialId}/usergroups
.
Parámetros
workflowCredentialType (cadena): obligatorio. Introduzca el ID de credencial que desee compartir.
Contrato (cuerpo): Requerido. Especifique lo siguiente para compartir una credencial con un grupo de usuarios:
workflowCredentialType (cadena): obligatorio. Especifique el identificador de un grupo de usuarios con el que desea compartir una credencial.
Quita un usuario de una credencial
Para eliminar un usuario de una credencial, utilice la punto de conexión DELETE
{baseURL}/v3/credentials/{credentialId}/users/{userId}
.
Parámetros
workflowCredentialType (cadena): obligatorio. Ingresa el Id. de flujo de trabajo del que deseas recuperar la información.
workflowCredentialType (cadena): obligatorio. Introduzca el ID de usuario que desea eliminar de la credencial.
Quitar un usuario o grupo de una colección
Para eliminar un grupo de usuarios de una credencial, utilice la punto de conexión DELETE
{baseURL}/v3/credentials/{credentialId}/usergroups/{userGroupId}
.
Parámetros
workflowCredentialType (cadena): obligatorio. Introduzca el identificador de credencial del que desea eliminar el grupo de usuarios.
workflowCredentialType (cadena): obligatorio. Introduzca el identificador de grupo de usuarios que desee eliminar de la credencial.
Eliminar una credencial
Para eliminar una credencial, utilice la punto de conexión DELETE
{baseURL}/v3/credentials/{credentialId}
.
Parámetros
workflowCredentialType (cadena): obligatorio. Selecciona la credencial que quieres eliminar.
force (booleano): opcional. Seleccione si desea forzar la supresión de una credencial en caso de que haya recursos compartidos. Si desea que se suprima la credencial y se limpien todos los recursos compartidos, defina el parámetro FORCE en TRUE. Si no se selecciona, el valor predeterminado es “false” (falso). Esto es para proteger contra una llamada errante.
Relaciones entre objetos
Para obtener información sobre los ID de credenciales existentes, utilice el punto de conexión GET /v3/credentials . El credentialId que obtiene se puede utilizar cuando: