Removes the custom domain configuration from a Run profile.
https://help.tago.io/portal/en/kb/articles/custom-domain-configuration Custom Domain Configuration
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.run.deleteCustomDomain("profile-id-123");
console.log(result);
Updates the Run environment configuration settings.
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
Tests the email configuration by sending a test message.
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
Retrieves the custom domain configuration for a Run profile.
https://help.tago.io/portal/en/kb/articles/custom-domain-configuration Custom Domain Configuration
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.run.getCustomDomain("profile-id-123");
console.log(result);
Retrieves information about the current Run environment configuration.
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', ... }
Retrieves a paginated list of Run users with customizable fields and filtering options.
https://help.tago.io/portal/en/kb/articles/191-tagorun TagoRun
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' } ]
Optional options: LoginAsUserOptionsGenerates a login token to authenticate as a specific Run user.
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..."
Creates a new notification for a Run user.
https://help.tago.io/portal/en/kb/articles/223-notifications-for-users Notifications for Users
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' }
Deletes a notification from the Run environment.
https://help.tago.io/portal/en/kb/articles/223-notifications-for-users Notifications for Users
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
Updates an existing notification in the Run environment.
https://help.tago.io/portal/en/kb/articles/223-notifications-for-users Notifications for Users
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
Retrieves a list of notifications for a specific Run user.
https://help.tago.io/portal/en/kb/articles/223-notifications-for-users Notifications for Users
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', ... } ]
Regenerates the custom domain configuration for a Run profile.
https://help.tago.io/portal/en/kb/articles/custom-domain-configuration Custom Domain Configuration
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.run.regenerateCustomDomain("profile-id-123");
console.log(result);
Updates the SAML SSO configuration for the Run environment.
Retrieves the SAML Single Sign-On configuration information for the Run environment.
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.run.ssoSAMLInfo();
console.log(result); // { sp: { entity_id: 'https://example.com', ... }, ... }
Creates a new user in the Run environment.
https://help.tago.io/portal/en/kb/articles/191-tagorun TagoRun
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",
password: "secure123",
timezone: "America/New_York",
});
console.log(result); // { user: 'user-id-123' }
Permanently deletes a user from the Run environment.
https://help.tago.io/portal/en/kb/articles/191-tagorun TagoRun
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
Updates information for an existing Run user.
https://help.tago.io/portal/en/kb/articles/191-tagorun TagoRun
If receive an error "Authorization Denied", check policy Run User / Edit in Access Management.
const userData = ;
const result = await Resources.run.userEdit("user-id-123", { name: "Updated Name" });
console.log(result); // TagoIO Run User Successfully Updated
Retrieves detailed information about a specific Run user.
https://help.tago.io/portal/en/kb/articles/191-tagorun TagoRun
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', ... }
Description
Creates a custom domain configuration for the Run environment.
See
https://help.tago.io/portal/en/kb/articles/custom-domain-configuration Custom Domain Configuration