Class Profile

Hierarchy

TagoIOModule<GenericModuleParams>
- Profile

Constructors

constructor

new Profile(params): Profile
Parameters
- params: GenericModuleParams
Returns Profile
Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in common/TagoIOModule.ts:79

Methods

addTeamMember

addTeamMember(id, email): Promise<string>
Parameters
- id: string
- email: string
Returns Promise<string>
Description
Adds a new team member to the profile using their email address.

See
https://help.tago.io/portal/en/kb/articles/106-sharing-your-profile Team Management - Sharing your 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
```
- Defined in modules/Resources/Profile.ts:425

addonEdit

addonEdit(profileID, addonObj): Promise<string>
Parameters
- profileID: string
- addonObj: Partial<AddonInfo>
Returns Promise<string>
Description
Updates the add-on configuration for a profile.

Deprecated
This route is deprecated.
- Defined in modules/Resources/Profile.ts:271

addonList

addonList(profileID): Promise<AddonInfo>
Parameters
- profileID: string
Returns Promise<AddonInfo>
Description
Retrieves a list of all add-ons associated with the profile.

Deprecated
This route is deprecated.
- Defined in modules/Resources/Profile.ts:257

auditLog

auditLog(profileID, filterObj?): Promise<AuditLog>
Parameters
- profileID: string
- Optional filterObj: AuditLogFilter
Returns Promise<AuditLog>
Description
Creates a new audit log query for tracking profile activities.

See
https://help.tago.io/portal/en/kb/articles/audit-log Audit Log

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);
```
- Defined in modules/Resources/Profile.ts:219

auditLogQuery

auditLogQuery(profileID, queryId?): Promise<AuditLog>
Parameters
- profileID: string
- Optional queryId: string
Returns Promise<AuditLog>
Description
Retrieves audit log entries using a previously created query.

See
https://help.tago.io/portal/en/kb/articles/audit-log Audit Log

Example
```
const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await Resources.profiles.auditLogQuery("profile-id-123", "query-id-456");
console.log(result);
```
- Defined in modules/Resources/Profile.ts:242

create

create(profileObj, options?): Promise<{
id: string;
}>
Parameters
- profileObj: {
  name: string;
  }
  - name: string
- Optional options: {
  allocate_free_resources?: boolean;
  }
  - Optional allocate_free_resources?: boolean
Returns Promise<{
id: string;
}>
Description
Creates a new profile with the specified name and optional resource allocation settings.

See
https://help.tago.io/portal/en/kb/articles/198-profiles#Adding_Profiles Adding Profiles

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' }
```
- Defined in modules/Resources/Profile.ts:109

delete

delete(profileID, credentials): Promise<string>
Parameters
- profileID: string
- credentials: {
  password: string;
  pin_code?: string;
  }
  - password: string
  - Optional pin_code?: string
Returns Promise<string>
Description
Permanently removes a profile from the account.

See
https://help.tago.io/portal/en/kb/articles/526-two-factor-authentication Two-Factor Authentication (2FA)

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
```
- Defined in modules/Resources/Profile.ts:163

deleteTeamMember

deleteTeamMember(id, accountId): Promise<string>
Parameters
- id: string
- accountId: string
Returns Promise<string>
Description
Removes a team member from the profile.

See
https://help.tago.io/portal/en/kb/articles/106-sharing-your-profile Team Management - Sharing your Profile

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
```
- Defined in modules/Resources/Profile.ts:471

edit

edit(profileID, profileObj): Promise<string>
Parameters
- profileID: string
- profileObj: Partial<ProfileInfo>
Returns Promise<string>
Description
Updates profile information with the provided data.

See
https://help.tago.io/portal/en/kb/articles/198-profiles#Renaming_your_Profiles Renaming your Profiles

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
```
- Defined in modules/Resources/Profile.ts:140

info

info(profileID): Promise<ProfileInfo>
Parameters
- profileID: string
Returns Promise<ProfileInfo>
Description
Retrieves detailed information about a specific profile using its ID or 'current' for the active profile.

See
https://help.tago.io/portal/en/kb/articles/198-profiles Profiles

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', ...}, ... }
```
- Defined in modules/Resources/Profile.ts:62

list

list(): Promise<ProfileListInfo[]>
Returns Promise<ProfileListInfo[]>
Description
Retrieves a list of all profiles associated with the current account.

See
https://help.tago.io/portal/en/kb/articles/198-profiles Profiles

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', ... } ]
```
- Defined in modules/Resources/Profile.ts:39

removeAddOn

removeAddOn(profileId, addon): Promise<string>
Parameters
- profileId: string
- addon: BillingAddOn
Returns Promise<string>
Description
Removes an add-on from the profile at the end of the current billing cycle.

Deprecated
This route is deprecated.
- Defined in modules/Resources/Profile.ts:404

serviceEdit

serviceEdit(profileID, serviceObj): Promise<string>
Parameters
- profileID: string
- serviceObj: object
Returns Promise<string>
Description
Updates service configuration and resource limits for a profile.
- Defined in modules/Resources/Profile.ts:284

summary

summary(profileID, options?): Promise<ProfileSummary>
Parameters
- profileID: string
- Optional options: {
  onlyAmount?: boolean;
  }
  - Optional onlyAmount?: boolean
Returns Promise<ProfileSummary>
Description
Retrieves a summary of the profile's usage and statistics.

See
https://help.tago.io/portal/en/kb/articles/198-profiles Profiles

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, ... }, ... }
```
- Defined in modules/Resources/Profile.ts:85

teamList

teamList(id): Promise<ProfileTeam[]>
Parameters
- id: string
Returns Promise<ProfileTeam[]>
Description
Retrieves a list of all team members that have access to the specified profile.

See
https://help.tago.io/portal/en/kb/articles/106-sharing-your-profile Team Management - Sharing your Profile

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', ... }, ... ]
```
- Defined in modules/Resources/Profile.ts:449

tokenCreate

tokenCreate(profileID, tokenParams): Promise<Types.TokenCreateResponse>

Parameters

profileID: string
tokenParams: TokenData & Authenticator

Returns Promise<Types.TokenCreateResponse>

Description

Creates a new authentication token for the specified profile.

See

https://help.tago.io/portal/en/kb/articles/495-account-token Account Token
https://help.tago.io/portal/en/kb/articles/526-two-factor-authentication Two-Factor Authentication (2FA)

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', ... }

tokenDelete

tokenDelete(profileId, token): Promise<string>
Parameters
- profileId: string
- token: string
Returns Promise<string>
Description
Revokes and removes an authentication token from the profile.

See
https://help.tago.io/portal/en/kb/articles/495-account-token Account Token

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
```
- Defined in modules/Resources/Profile.ts:390

tokenList

tokenList(profileID, queryObj?): Promise<Partial<TokenDataList>[]>

Parameters

profileID: string
Optional queryObj: ListTokenQuery

Returns Promise<Partial<TokenDataList>[]>

Description

Retrieves a list of all tokens associated with a specific profile.

See

https://help.tago.io/portal/en/kb/articles/495-account-token Account Token

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', ... }, ... ]

transferTokenToAnotherProfile

transferTokenToAnotherProfile(targetProfileID): Promise<string>

Parameters

targetProfileID: string

Returns Promise<string>

Description

Transfers the current authentication token to another profile.

Example

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

usageStatisticList

usageStatisticList(profileID, dateObj?): Promise<UsageStatistic[]>
Parameters
- profileID: string
- Optional dateObj: StatisticsDate
Returns Promise<UsageStatistic[]>
Description
Retrieves usage statistics for a profile within a specified time period.

Usage statistics are cumulative: if a service was not used in a time period, the statistics for that time period will not be in the object.

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, ... }, ... ]
```
- Defined in modules/Resources/Profile.ts:190

Class Profile

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Profile

Methods

addTeamMember

Parameters

Returns Promise<string>

Description

See

Example

addonEdit

Parameters

Returns Promise<string>

Description

Deprecated

addonList

Parameters

Returns Promise<AddonInfo>

Description

Deprecated

auditLog

Parameters

Returns Promise<AuditLog>

Description

See

Example

auditLogQuery

Parameters

Returns Promise<AuditLog>

Description

See

Example

create

Parameters

name: string

Optional allocate_free_resources?: boolean

Returns Promise<{ id: string; }>

Description

See

Example

delete

Parameters

password: string

Optional pin_code?: string

Returns Promise<string>

Description

See

Example

deleteTeamMember

Parameters

Returns Promise<string>

Description

See

Example

edit

Parameters

Returns Promise<string>

Description

See

Example

info

Parameters

Returns Promise<ProfileInfo>

Description

See

Example

list

Returns Promise<ProfileListInfo[]>

Description

See

Example

removeAddOn

Parameters

Returns Promise<string>

`Optional` allocate_free_resources?: boolean

Returns Promise<{
id: string;
}>

`Optional` pin_code?: string

`Optional` onlyAmount?: boolean