Class Run

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.run.deleteCustomDomain("profile-id-123");
console.log(result);
Copy

Example

If receive an error "Authorization Denied", check policy Profile / Edit TagoRun settings in Access Management.

const result = await Resources.run.edit({ name: "My Run Environment", logo: "https://example.com/logo.png" });
console.log(result); // TagoIO Run Successfully Updated
Copy

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.run.emailTest({ subject: "Test Email", body: "This is a test message" });
console.log(result); // E-mail sent to example@email.com
Copy

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.run.getCustomDomain("profile-id-123");
console.log(result);
Copy

Example

If receive an error "Authorization Denied", check policy Profile / Access TagoRun settings in Access Management.

const result = await Resources.run.info();
console.log(result); // { name: 'My Run Environment', logo: 'https://example.com/logo.png', ... }
Copy

Example

If receive an error "Authorization Denied", or return empty list check policy Run User / Access in Access Management.

const result = await Resources.run.listUsers({
  page: 1,
  fields: ["id", "name", "email"],
  amount: 20
});
console.log(result); // [ { id: 'user-id-123', name: 'John Doe', email: 'example@email.com' } ]
Copy

Example

If receive an error "Authorization Denied", check policy Run User / Login as user in Access Management.

const result = await Resources.run.loginAsUser("user-id-123");
console.log(result.token); // "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ..."
Copy

Example

If receive an error "Authorization Denied", check policy Run User / Create notification in Access Management.

const result = await Resources.run.notificationCreate("user-id-123", { title: "Update", message: "New feature available" });
console.log(result); // { id: 'notification-id-123' }
Copy

Example

If receive an error "Authorization Denied", check policy Run User / Delete notification in Access Management.

const result = await Resources.run.notificationDelete("notification-id-123");
console.log(result); // Successfully Removed
Copy

Example

If receive an error "Authorization Denied", check policy Run User / Edit notification in Access Management.

const result = await Resources.run.notificationEdit("notification-id-123", { title: "Updated Title" });
console.log(result); // TagoIO Notification User Successfully Updated
Copy

Example

If receive an error "Authorization Denied", check policy Run User / Access notification in Access Management.

const result = await Resources.run.notificationList("user-id-123");
console.log(result); // [ { id: 'notification-id-123', title: 'System Update', message: 'Features', ... } ]
Copy

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.run.regenerateCustomDomain("profile-id-123");
console.log(result);
Copy

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.run.ssoSAMLInfo();
console.log(result); // { sp: { entity_id: 'https://example.com', ... }, ... }
Copy

Example

If receive an error "Authorization Denied", check policy Run User / Create in Access Management.

const result = await Resources.run.userCreate({
  name: "John Doe",
  email: "john@example.com",
  timezone: "America/New_York",
  generate_password: true,
  send_email: true,
});
console.log(result); // { user: 'user-id-123' }
Copy

Example

If receive an error "Authorization Denied", check policy Run User / Delete in Access Management.

const result = await Resources.run.userDelete("user-id-123");
console.log(result); // Successfully Removed
Copy

Example

If receive an error "Authorization Denied", check policy Run User / Edit in Access Management.

const result = await Resources.run.userEdit("user-id-123", { name: "Updated Name", logout_sessions: true });
console.log(result); // TagoIO Run User Successfully Updated
Copy

Example

If receive an error "Authorization Denied", check policy Run User / Access in Access Management.

const result = await Resources.run.userInfo("user-id-123");
console.log(result); // { id: 'user-id-123', name: 'John Doe', email: 'example@email.com', ... }
Copy

Example

If receive an error "Authorization Denied", check policy Run User / Edit in Access Management.

const result = await Resources.run.userResendInvite("user-id-123", { invite_template: "invite" });
console.log(result); // Invite sent
Copy