Class Profile

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.profiles.addTeamMember("profile-id-123", "user@example.com");
console.log(result); // User invited
Copy

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.profiles.auditLog("profile-id-123", {
  start_date: new Date("2024-12-01"),
  end_date: new Date("2024-12-07")
});
console.log(result);
Copy

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await Resources.profiles.auditLogQuery("profile-id-123", "query-id-456");
console.log(result);
Copy

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.profiles.create({ name: "New Profile" }, { allocate_free_resources: true });
console.log(result); // { id: 'profile-id-123' }
Copy

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
// The “pin_code” field is required when 2FA is activated
const result = await resources.profiles.delete("profile-id-123", { password: "your-password", pin_code: "123456" });
console.log(result); // Successfully Removed
Copy

Example

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

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.profiles.deleteTeamMember("profile-id-123", "account-id-456");
console.log(result); // Account Successfully Removed
Copy

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.profiles.edit("profile-id-123", { name: "Updated Profile Name" });
console.log(result); // Successfully Updated
Copy

Example

If receive an error "Authorization Denied", check policy Account / Access profile in Access Management.

const profileInfo = await Resources.profiles.info("profile-id-123");
// Or get current profile
const currentProfile = await Resources.profiles.info("current");
console.log(profileInfo); // { info { id: 'profile-id-123', account: 'account-id-123', ...}, ... }
Copy

Example

If receive an error "Authorization Denied", check policy Account / Access profile in Access Management.

const result = await Resources.profiles.list();
console.log(result); // [ { id: 'profile-id-123', name: 'Profile Test', ... } ]
Copy

Example

If receive an error "Authorization Denied", check policy Account / Access profile in Access Management.

const result = await Resources.profiles.summary("profile-id-123");
console.log(result); // { amount: { device: 10, bucket: 10, dashboard: 5, ... }, ... }
Copy

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.profiles.teamList("profile-id-123");
console.log(result); // [ { id: 'account-id-123', active: false, name: 'John Doe', ... }, ... ]
Copy

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
// The “pin_code” / "otp_type" field is required when 2FA is activated
const result = await resources.profiles.tokenCreate("profile-id-123", {
  name: "API Access",
  permission: "full",
  email: "example@email.com",
  password: "your-password"
 });
console.log(result); // { token: 'token-value', name: 'API Access', ... }
Copy

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.profiles.tokenDelete("profile-id-123", "token-xyz");
console.log(result); // Token Successfully Removed
Copy

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.profiles.tokenList("profile-id-123", {
  page: 1,
  amount: 20,
  fields: ["name", "token", "permission"]
});
console.log(result); // [ { name: 'Token #1', token: 'token-value', permission: 'full', ... }, ... ]
Copy

Example

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

Example

If receive an error "Authorization Denied", check policy Account / Access profile statistics in Access Management.

const result = await Resources.profiles.usageStatisticList("profile-id-123", {
  start_date: "2024-09-01",
  end_date: "2024-12-31",
  periodicity: "day"
});
console.log(result); // [ { time: '2024-09-02T00:01:29.749Z', analysis: 0.07, data_records: 67254, ... }, ... ]
Copy