Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

User

class User

Users own datasets and workflows. Various methods allow you to construct and list the datasets, workflows, and secrets of a user.

Constructors

Method
Description

Return a User, given their username.

Return the currently authenticated User.

Examples

const user = redivis.user('jane');

const dataset = user.dataset('my_dataset'); // -> Returns a Dataset
const workflow = user.workflow('my_workflow'); // -> Returns a Workflow

await user.listDatasets(); // -> Returns an array of Datasets
await user.listWorkflows(); // -> Returns an array of Workflows

const me = await redivis.currentUser();
console.log(me.name);

Attributes

Name
Description

name

The user's username.

properties

An object containing the API resource representation of the user. This will be fully populated after calling get.

Methods

Method
Description

User.dataset(name[, options])

Return a Dataset owned by the user.

Check whether the user exists.

Fetch the user's metadata, populating user.properties.

User.listDatasets([maxResults])

List the user's Datasets.

User.listWorkflows([maxResults])

List the user's Workflows.

Return a Secret of the user.

Return a Workflow owned by the user.

Was this helpful?