Account

In order to modify information in the account, dashboard, bucket, device and any other settings, it is necessary to use the device functions.

To setup an account object, you need a token that you need to get in our admin website. Make sure to use tokens with the correct write/read previlegies for the current function that you want to use. For example, a token with only read previlegies can’t create, modify or delete anything from an account.

.info

Get all account information

Syntax

.info()

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')
account_info = my_account.info()

print(account_info)

.tokenList

Get all tokens from the account

Syntax

.tokenList(profile_id)

Arguments

profile_id(string) id of the profile.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

result = my_account.profiles.tokenList('PROFILE ID HERE')
print(result)

.tokenCreate

Generate and retrieve a new token for the account

Syntax

.tokenCreate()

Arguments

data(object) options for the new token.

*name(string): a name for the token;

*profile_id(string): profile_id from the profile where token will be created;

*email(string): account email;

*password(string): account password;

*expire_time(string): Relative time when token should expire. It will be randomly generated if not included.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

new_token = { 'name': 'My First Token',
            'profile_id': 'PROFILE ID HERE',
            'email': 'ACCOUNT EMAIL HERE',
            'password': 'ACCOUNT PASSWORD HERE',
            'expire_time': '1 day' }

result = my_account.tokenCreate(new_token)
print(result)

.tokenDelete

Delete current token of the account

.tokenDelete(profile_id, token)

Arguments

profile_id(string) id of the profile.

token(string) profile token.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

result = my_account.profiles.tokenDelete('PROFILE ID HERE', 'PROFILE TOKEN HERE')
print(result)

Devices

Across the account function, it is possible to manage all your devices. Make sure that you use an account token with “write” permission when using functions to create, edit and delete. The Device method is completly different from the class Device, since this one can only manage devices, and can’t do anything with data related to the device.

.list

Retrieve a list with all devices from account

Syntax

.list()

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')
my_devices = my_account.devices.list()

print(my_devices)

.create

Generate and retrieve a new device for the account

Syntax

.create(/data/)

Arguments

data(object) options for the new device.

*name(string): a name for the device;

*description(string): description for the device. (optional)

*active(bool): Set if the device will be active. Default True. (optional)

*visible(bool): Set if the device will be visible. Default True. (optional)

*configuration_params(array): An array of objects with sent(bool), key(string) and value(string). (optional)

*tags(array): An array of objects with key and value. (optional)

Returns

(Promise)

*token: token for the generated device;

*id: id of the new device;

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

new_device = {
    'name': 'My First Device',
    'description' : 'Creating my first device',
    'active': True,
    'visible': True,
    'tags': [
        {'key': 'Client', 'value': 'John'}
    ],
    'configuration_params': [
        {'sent': False, 'key': 'check_rate', 'value': 600},
        {'sent': False, 'key': 'measure_time', 'value': 0}
    ]
}

result = my_account.devices.create(new_device)
print(result)

.edit

Modify any property of the device.

Syntax

.edit(/id/, /data/)

Arguments

id(string) reference ID of the device.

data(object) options to be modified in the device.

*name(string): a name for the device; (optional)

*description(string): description for the device. (optional)

*active(bool): Set if the device will be active. Default True. (optional)

*visible(bool): Set if the device will be visible. Default True. (optional)

*tags(array): An array of objects with key and value. (optional)

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

data = {
    'name': 'New name for my device',
    'description' : 'In this way I can change the description too',
    'active': False,
    'visible': True,
    'tags': [
        {'key': 'Client', 'value': 'Mark'}
    ]
}

result = my_account.devices.edit('DEVICE_ID', data)
print(result)

.info

Get information about the device

Syntax

.info(/id/)

Arguments

id(string) reference ID of the device.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

device_info = my_account.devices.info('DEVICE_ID')
print(device_info)

.delete

Delete device for the account

Syntax

.delete(/id/)

Arguments

id(string) reference ID of the device.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

device_info = my_account.devices.delete('DEVICE_ID')
print(device_info)

.tokenList

Retrieve a list of all tokens of the device

Syntax

.tokenList(/id/)

Arguments

id(string) reference ID of the device.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

device_token_list = my_account.devices.tokenList('DEVICE_ID')
print(device_token_list)

.tokenCreate

Generate and retrieve a new token for the device

Syntax

.tokenCreate(/id/, /data/)

Arguments

id(string) reference ID of the device.

data(object) options for the new token.

*name(string): a name for the token;

*expire_time(string): Time when token should expire. It will be randomly generated if not included. Accept “never” as value.

*permission(string): Token permission, should be `write`, `read` or `full`.

*serie_number(string): Serial number of the device. (optional)

*verification_code(string): Verification code to validate middleware requests. (optional)

*middleware(string): Middleware or type of the device that will be added.. (optional)

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

new_token_data = {
    'name': 'My First Token',
    'expire_time': 'never',
    'permission': 'full'
}

result = my_account.devices.tokenCreate('DEVICE_ID', new_token_data)
print(result)

.tokenDelete

Delete an token of the Device

Syntax

.tokenDelete(/token/)

Arguments

token(string) reference token.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

result = my_account.devices.tokenDelete('TOKEN')
print(result)

Buckets

Across the account function, it is possible to manage all your buckets. Be sure to use an account token with “write” permissions when using functions like create, edit and delete.

.list

Retrieve a list with all buckets from account

Syntax

.list()

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

my_buckets = my_account.buckets.list()
print(my_buckets)

.create

Generate and retrieve a new bucket for the account

Syntax

.create(/data/)

Arguments

data(object) options for the new bucket.

*name(string): a name for the bucket;

*description(string): description for the bucket. (optional)

*visible(bool): Set if the bucket will be visible or not. Default True. (optional)

*tags(array): An array of objects with key and value. (optional)

Returns

(Promise)

*object.bucket: id of the new bucket;

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

new_bucket_data = {
    'name':'My first bucket',
    'description':'Creating my first bucket',
    'visible': True,
    'tags': [
        {'key': 'client', 'value': 'Francisco'}
    ]
}

result = my_account.buckets.create(new_bucket_data)
print(result)

.edit

Modify any property of the bucket.

Syntax

.edit(/id/, /data/)

Arguments

id(string) reference ID of the bucket.

data(object) options to be modified in the bucket.

*name(string): a name for the bucket; (optional)

*description(string): description for the bucket. (optional)

*visible(bool): Set if the bucket will be visible or not. Default True. (optional)

*tags(array): An array of objects with key and value. (optional)

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

data = {
    'name':'New name for my bucket',
    'description':'This way I can change the description too',
    'visible': True,
    'tags': [
        {'key': 'client', 'value': 'Leonard'}
    ]
}

result = my_account.buckets.edit('BUCKET_ID_HERE', data)
print(result)

.info

Get information about the bucket

Syntax

.info(/id/)

Arguments

id(string) reference ID of the bucket.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

result = my_account.buckets.info('BUCKET_ID_HERE')
print(result)

.delete

Delete bucket for the account

Syntax

.delete(/id/)

Arguments

id(string) reference ID of the bucket.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

result = my_account.buckets.delete('BUCKET_ID_HERE')
print(result)

Actions

Across the account function, it is possible to manage all your actions. Be sure to use an account token with “write” permissions when using functions like create, edit and delete.

.list

Retrieve a list with all actions from account

Syntax

.list()

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

my_actions = my_account.actions.list()
print(my_actions)

.create

Generate and retrieve a new action for the account

Syntax

.create(/data/)

Arguments

data(object) options for the new action.

*name(string): a name for the action;

*description(string): description for the action. (optional)

*active(bool): True if the action is active or not. Default is true(optional)

*when_set_bucket(string): ID reference of the bucket(optional)

*when_set_origin(string): ID reference of the origin(optional)

*when_set_variable(string): name of the variable to trigger when arrive(optional)

*when_set_condition(string): Condition to trigger the action. Can be * (Any), = (Equal), >= (Greater Equal) etc.. (optional)

*when_set_value(string): Value to be compared by condition. Set to Null if condition is * (Any). (optional)

*when_reset_bucket(string): ID reference of the bucket(optional)

*when_reset_origin(string): ID reference of the origin(optional)

*when_reset_variable(string): name of the variable to trigger when arrive(optional)

*when_reset_condition(string): Condition to trigger the action. Can be * (Any), = (Equal), >= (Greater Equal) etc.. (optional)

*when_reset_value(string): Value to be compared by condition. Set to Null if condition is * (Any). (optional)

*type(string): Type of the action. Can be ‘script’, ‘sms’, ‘email’ or ‘post’, (optional)

*tags(array): An array of objects with key and value. (optional)

If type is script

*script(string): Reference id of the analysis..(optional)

If type is sms

*to(string): Phone number to be sent.(optional)

*message(string): Message to be sent in sms.(optional)

If type is email

*to(string): E-mail addres to be sent.(optional)

*message(string): Message to be sent in e-mail.(optional)

*subject(string): Subject of the e-mail.(optional)

Returns

(Promise)

*id: id of the new action;

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

new_action_data = {
    'name': 'a simple action',
    'description': 'trigger when the variable test is higher than 2, and reset it when is less than 2',
    'when_reset_bucket': '571920982c452fa00c6af660',
    'when_reset_origin': '571920a5cc7d43a00c642ca1',
    'when_reset_variable': 'test',
    'when_reset_condition': '<',
    'when_reset_value': '2',
    'when_set_bucket': '571920982c452fa00c6af660',
    'when_set_origin': '571920a5cc7d43a00c642ca1',
    'when_set_variable': 'test',
    'when_set_condition': '>',
    'when_set_value': '2',
    'type': 'script',
    'script': '577d4c457ee399ef1a6e6cf6',
    'lock': False,
    'active': True,
    'tags': [
        {'key':'Trigger', 'value':'2'}
    ]
}

result = my_account.actions.create(new_action_data)
print(result)

.edit

Modify any property of the action.

Syntax

.edit(/id/, /data/)

Arguments

id(string) reference ID of the action.

data(object) properties to be changed. See `.create`_ to more reference..

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

data = {
    'name':'New name for my action',
    'description':'In this way I can change the description too',
    'visible': True,
    'tags': [
        {'key': 'client', 'value': 'Mark'}
    ]
}

result = my_account.actions.edit('ACTION_ID_HERE', data)
print(result)

.info

Get information about the action

Syntax

.info(/id/)

Arguments

id(string) reference ID of the action.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

action_info = my_account.actions.info('ACTION_ID_HERE')
print(action_info)

.delete

Delete action for the account

Syntax

.delete(/id/)

Arguments

id(string) reference ID of the action.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

result = my_account.actions.delete('ACTION_ID_HERE')
print(result)

Analysis

Across the account function, it is possible to manage all your analysis. Be sure to use an account token with “write” permissions when using functions like create, edit and delete. The analysis method is completly different from the class analysis, since it only manages the analysis information and not the code that it runs.

.list

Retrieve a list with all analysis from account

Syntax

.list()

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

my_analysis = my_account.analysis.list()
print(my_analysis)

.create

Generate and retrieve a new analysis for the account

Syntax

.create(/data/)

Arguments

data(object) options for the new analysis.

*name(string): a name for the analysis;

*description(string): description for the analysis. (optional)

*interval(string): time interval for analysis to run. Default is Never;

*active(bool): Set if the analysis will be active. Default True. (optional)

*variables(array): Environment variables to be passed when the analysis runs. (optional)

*tags(array): An array of objects with key and value. (optional)

Returns

(Promise)

*token: token for the generated analysis;

*id: id of the new analysis;

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

new_analysis_data = {
    'name':'My first analysis',
    'description':'Creating my first analysis',
    'active': True,
    'interval': '1 minute',
    'variables': [
        {'key': 'max_battery', 'value': '3100'}
    ],
    'tags': [
        {'key': 'client', 'value': 'Mark'}
    ]
}

result = my_account.analysis.create(new_analysis_data)
print(result)

.edit

Modify any property of the analysis.

Syntax

.edit(/id/, /data/)

Arguments

id(string) reference ID of the analysis.

data(object) options to be modified in the analysis.

*name(string): a name for the analysis; (optional)

*description(string): description for the analysis. (optional)

*interval(string): time interval for analysis to run. Default is Never;

*active(bool): Set if the analysis will be active. Default True. (optional)

*variables(array): Environment variables to be passed when the analysis runs. (optional)

*tags(array): An array of objects with key and value. (optional)

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

data = {
    'name':'New name for my analysis',
    'description':'In this way I can change the description too',
    'active':False,
    'interval': '2 minutes',
    'variables': [
        {'key': 'max_battery', 'value': '3000'}
    ],
    'tags': [
        {'key': 'client', 'value': 'Mark'}
    ]
}

result = my_account.analysis.create(data)
print(result)

.info

Get information about the analysis

Syntax

.info(/id/)

Arguments

id(string) reference ID of the analysis.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

analysis_info = my_account.analysis.info('ANALYSIS_ID_HERE')
print(analysis_info)

.delete

Delete analysis for the account

Syntax

.delete(/id/)

Arguments

id(string) reference ID of the analysis.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

result = my_account.analysis.delete('ANALYSIS_ID_HERE')
print(result)

.run

Force Analysis to run immediately

Syntax

.run(/id/)

Arguments

id(string) reference ID of the analysis.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

# Your scope can be an array with several objects
scope = [
    {
        'variable': 'alarm',
        'value:' 'On'
    }
]

result = my_account.analysis.run('ANALYSIS_ID_HERE', scope)
print(result)

Dashboards

Across the account function, it is possible to manage all your dashboards. Be sure to use an account token with “write” permissions when using functions like create, edit and delete.

.list

Retrieve a list with all dashboards from account

Syntax

.list()

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

my_dashboards = my_account.dashboards.list()
print(my_dashboards)

.create

Generate and retrieve a new dashboard for the account

Syntax

.create(/data/)

Arguments

data(object) options for the new dashboard.

*label(string): a label for the dashboards;

*arrangement(array): array of objects with arrangement of the widget inside the dashboard. (optional)

*widget_id(string): id of the widget

*x(number): position x of the widget. 1 to 4;

*y(number): position y of the widget. 1 to 20

*width(number): width of the widget. 1 to 4

*height(number): height of the widget. 1 to 20

*tags(array): An array of objects with key and value. (optional)

Returns

(Promise)

*token: token for the generated dashboard;

*id: id of the new dashboard;

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

new_dashboard_data = {
    'label':'My first dashboard',
    'arrangement': [
        {'widget_id': 'WIDGET_ID_HERE', 'x': 0, 'y': 0, 'width': 2, 'height': 3}
    ],
    'tags': [
        {'key': 'client', 'value': 'Mark'}
    ]
}

result = my_account.dashboards.create(new_dashboard_data)
print(result)

.edit

Modify any property of the dashboards.

Syntax

.edit(/id/, /data/)

Arguments

id(string) reference ID of the dashboards.

data(object) options to be modified in the dashboards.

*label(string): a label for the dashboards;

*arrangement(array): array of objects with arrangement of the widgest inside the dashboard. (optional)

*widget_id(string): id of the widget

*x(number): position x of the widget. 1 to 4;

*y(number): position y of the widget. 1 to 20

*width(number): width of the widget. 1 to 4

*height(number): height of the widget. 1 to 20

*tags(array): An array of objects with key and value. (optional)

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

data = {
    'label':'New name for my dashboard',
}

result = my_account.dashboards.edit('DASHBOARD_ID_HERE', data)
print(result)

.info

Get information about the dashboards

Syntax

.info(/id/)

Arguments

id(string) reference ID of the dashboards.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

dashboard_info = my_account.dashboards.info('DASHBOARD_ID_HERE')
print(dashboard_info)

.delete

Delete dashboards for the account

Syntax

.delete(/id/)

Arguments

id(string) reference ID of the dashboards.

Returns

(Promise)

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

result = my_account.dashboards.delete('DASHBOARD_ID_HERE')
print(result)

Widgets

Inside dashboards, you need widgets to show and control information inside buckets. Every widget have their data slighty different from each other, to know how do they work

.create

Generate and retrieve a new widget for the dashboard

Syntax

.create(/dashboard_id/, /data/)

Arguments

dashboard_id(string) dashboard id for the dashboard.

data(object) options for the new widget.

*label(string): a label for the dashboards;

*arrangement(array): array of objects with arrangement of the widget inside the dashboard. (optional)

*widget_id(string): id of the widget

*x(number): position x of the widget. 1 to 4;

*y(number): position y of the widget. 1 to 20

*width(number): width of the widget. 1 to 4

*height(number): height of the widget. 1 to 20

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

new_widget = {
    'label': 'My first widget',
    'type': 'step_button',
    'data': [{
        'bucket': '5d02be12cac6da0026398ed2',
        'origin': '5d02be12cac6da0026398ed1',
        'timezone': 'America/Sao_Paulo',
        'query': 'last_value',
        'variables': ['humidity']
    }]
}

result = my_account.dashboards.widgets.create('DASHBOARD_ID_HERE', new_widget)
print(result)

.edit

Modify any property of the widget.

Syntax

.edit(/dashboard_id/, /widge_id/, /data/)

Arguments

dashboard_id(string) dashboard id for the dashboard.

widge_id(string) widget id for the dashboard.

data(object) options for the new widget.

*label(string): a label for the dashboards;

*arrangement(array): array of objects with arrangement of the widget inside the dashboard. (optional)

*widget_id(string): id of the widget(optional)

*x(number): position x of the widget. 1 to 4; (optional)

*y(number): position y of the widget. 1 to 20(optional)

*width(number): width of the widget. 1 to 4(optional)

*height(number): height of the widget. 1 to 20(optional)

Returns

(Promise)

import tago

account_dashboards = tago.Account('MY_ACCOUNT_TOKEN').dashboards

data = {
    'label':'New name for my widget',
}

result = account_dashboards.widgets.edit('DASHBOARD_ID_HERE', 'WIDGET_ID_HERE', data)
print(result)

.info

Get information about the widget

Syntax

.info(/dashboard_id/, /widge_id/)

Arguments

id(string) reference ID of the dashboard.

id(string) reference ID of the widget.

Returns

(Promise)

import tago

account_dashboards = tago.Account('MY_ACCOUNT_TOKEN').dashboards

widget_info = account_dashboards.widgets.info('DASHBOARD_ID_HERE', 'WIDGET_ID_HERE')
print(widget_info)

.delete

Delete access widget for the dashboard

Syntax

.delete(/dashboard_id/, /widge_id/)

Arguments

id(string) reference ID of the dashboard.

id(string) reference ID of the widget.

Returns

(Promise)

import tago

account_dashboards = tago.Account('MY_ACCOUNT_TOKEN').dashboards

result = account_dashboards.widgets.delete('DASHBOARD_ID_HERE', 'WIDGET_ID_HERE')
print(result)

notifications to myself

All accounts have an notification system, where you can see alerts of account limit and accept/refuse share of dashboards, profiles.

.list

Retrieve a list with all notifications from account

Syntax

.list()

Returns

(Promise)

*result(array): Array list of notifications;

import tago

my_account = tago.Account('MY_ACCOUNT_TOKEN')

# Empty object as params retrive all notifications from account
params = {}

my_notifications = my_account.notifications.list(params)
print(my_notifications)

.markAsRead

Mark a notification as read/ignored.

Syntax

.markAsRead(/id_list/)

Arguments

*id_list(array): array of notification ids;

Returns

(Promise)

*result: Notifications marked as read;

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

# Array of notifications ids, this array can have several notifications ids
notifications_ids_list = ['NOTIFICATION_ID_HERE', 'ANOTHER_NOTIFICATION_ID_HERE']

result = my_account.notifications.markAsRead(notifications_ids_list)
print(result)

.accept

Accept the notification if it has a condition.

Syntax

.accept(/notification_id/)

Arguments

*notification_id(string): ID of the notification;

Returns

(Promise)

*result: Notification succesfully accepted;

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

result = my_account.notifications.accept('NOTIFICATION_ID_HERE')
print(result)

.refuse

Refuse the notification if it has a condition.

Syntax

.refuse(/notification_id/)

Arguments

*notification_id(array): ID of the notification;

Returns

(Promise)

*result: Notification succesfully refused;

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

result = my_account.notifications.accept('NOTIFICATION_ID_HERE')
print(result)

TagoRun Users

You can manage your TagoRun and Run Users. In order to modify, add, delete or do anything else with the data inside Run. See more about Tago Run here.

To setup an device object, you need a account-token (that you need to get in our website). Be sure to use tokens with the correct write/read previlegies for the current function that you want to use. For example, a token with only read previlegies can’t create, modify or delete anything from a Run.

.info

Get all information from the run

Syntax

.info()

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

tago_run_info = my_account.run.info()
print(tago_run_info)

.listUsers

Retrieve a list with all users from Run

Syntax

.listUsers()

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

tago_run_users = my_account.run.listUsers()
print(tago_run_users)

.getUserInfo

Get run user information

Syntax

.getUserInfo()

Arguments

*user_id(string): ID of the run user;

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

run_user_info = my_account.run.getUserInfo('RUN_USER_ID_HERE')
print(run_user_info)

.userEdit

Modify any property of the Run User.

Syntax

.userEdit(/id/, /data/)

Arguments

id(string) reference ID of the run user.

data(object) options to be modified in the run user.

*name(string): a name for the run user; (optional)

*email(string): email for the run user. (optional)

*phone(string): phone for the run user. (optional)

*timezone(string): email for the run user. (optional)

*company(string): company for the run user. (optional)

*active(bool): Set if the run user will be active. Default True. (optional)

*tags(array): An array of objects with key and value. (optional)

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

data = {
    'name':'New name for my Run User',
    'tags': [
        {'key': 'client', 'value': 'Mark'}
    ]
}

result = my_account.run.userEdit('RUN_USER_ID_HERE', data)
print(result)

.createUser

Create a new Run User.

Syntax

.createUser(/data/)

Arguments

data(object) options to be modified in the run user.

*name(string): a name for the run user.

*email(string): email for the run user.

*password(string): password for the run user.

*timezone(string): timezone for the run user.

*phone(string): phone for the run user. (optional)

*company(string): company for the run user. (optional)

*active(bool): Set if the run user will be active. Default True. (optional)

*tags(array): An array of objects with key and value. (optional)

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

new_user = {
    'name':'John Doe',
    'email': 'jhon@doe.com',
    'password': '123abc',
    'tags': [
        {'key': 'employee', 'value': 'Manager'}
    ],
    'timezone': 'America/Sao_Paulo'
}

result = my_account.run.createUser(new_user)
print(result)

.deleteUser

Delete run user

Syntax

.deleteUser()

Arguments

*user_id(string): ID of the run user;

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

result = my_account.run.deleteUser('5d7adfb1f03154001bbd9d78')
print(result)

Notification to users

You can push notification messages directly to the users registered in your Run. See more about notification for users here.

.notificationList

Retrieve a list with all notifications for the Run user

Syntax

.notificationList()

Arguments

*user_id(string): ID of the run user;

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

run_user_notifications_list = my_account.run.notificationList('RUN_USER_ID_HERE')
print(run_user_notifications_list)

.notificationEdit

Modify any property of the user push notification.

Syntax

.notificationEdit(/notification_id/, /data/)

Arguments

notification_id(string) reference ID of the notification.

data(object) options to be modified in the notification.

*title(string): a title for the notification. (optional)

*message(string): message for the notification. (optional)

*buttons(array of object): phone for the run user. (optional)

*label(string): label for notification button. (optional)

*analysis(string): analysis_id for notification button. This analysis is run when the button is pressed. (optional)

*url(string): url for notification button. Open a link when the button is pressed. (optional)

*color(string): color for notification button. Accept hexadecimal colors, like: ‘#bcbcbc’. (optional)

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

data = {
    'title': 'Temperature Alert',
    'message': 'The temperature is too high'
    'buttons': [{
        'label': 'Go to device dashboard',
        'url': 'https://admin.tago.io/dashboard/info/5d9c6e7945f7ab001b0a32c2',
        'color': 'red',
        # 'analysis': '5d9c6e7945f7ab001b0a32c2',
    }],
}

result = my_account.run.notificationEdit('NOTIFICATION_ID_HERE', data)
print(result)

.notificationCreate

Create a new push notification for the user.

Syntax

.notificationCreate(/data/)

Arguments

*user_id(string): ID of the run user;

data(object) options to be modified in the notification.

*title(string): a title for the notification.

*message(string): message for the notification.

*buttons(array of object): phone for the run user.

*label(string): label for notification button.

*analysis(string): analysis_id for notification button. This analysis is run when the button is pressed. (optional)

*url(string): url for notification button. Open a link when the button is pressed. (optional)

*color(string): color for notification button. Accept hexadecimal colors, like: ‘#bcbcbc’. (optional)

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

data = {
    'title': 'Temperature Alert',
    'message': 'The temperature is too high',
    'buttons': [{
        'label': 'Go to device dashboard',
        'url': 'https://admin.tago.io/dashboard/info/5d9c6e7945f7ab001b0a32c2',
        'color': 'red',
        # 'analysis': '5d9c6e7945f7ab001b0a32c2',
    }],
}

result = my_account.run.notificationCreate('RUN_USER_ID_HERE', data)
print(result)

.notificationDelete

Delete push notifcation for the run user

Syntax

.notificationDelete()

Arguments

*notification_id(string): ID of the notification;

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

result = my_account.run.notificationDelete('NOTIFICATION_ID_HERE')
print(result)

Access Management

Access Management (AM) is a module that helps you securely grant access to certain resources in your account. You create Targets (users or things) and determine which type of Permissions for the resources they will have. See more about Access Management here.

.list

Retrieve a list with all access management from account.

Syntax

.list()

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

access_management_list = my_account.accessManagement.list()
print(access_management_list)

.create

Generate and retrieve a new access management for the account.

Syntax

.create(/data/)

Arguments

data(object) options for the new access management.

*name(string): a name for the access management.

*permissions(array): permissions for the access management.

*effect(string): effect for the access management. access or deny.

*action(string): action for the access management.

*resource(string): resource for the access management.

*targets(array): targets for the access management.

*active(bool): Set if the access management will be visible. Default True. (optional)

*tags(array): An array of objects with key and value. (optional)

Returns

(Promise)

*am_id: id of the new access management;

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

user = {
    'id': '576dc932415f403531fd2cf6',
    'name': 'John Doe',
}

new_access_management = {
    'name': 'Dashboards for the user {}'.format(user['id']),
    'tags': [{ 'key': 'client_id', 'value': user['id'] }],
    'targets': [
    [
        'run_user',
        'id',
        user['id'],
    ],
    ],
    'permissions': [
    {
        'effect': 'allow',
        'action': [
        'access',
        ],
        'resource': [
        'dashboard',
        'tag.key',
        'client_id',
        'tag.value',
        user['id'],
        ],
    },
    ],
}

result = my_account.accessManagement.create(new_access_management)
print(result)

.edit

Modify any property of the access management.

Syntax

.edit(/am_id/, /data/)

Arguments

am_id(string) reference ID of the access management.

data(object) options for the new access management.

*name(string): a name for the access management.(optional)

*permissions(array of object): permissions for the access management.(optional)

*effect(string): effect for the access management. access or deny (optional)

*action(string): action for the access management.(optional)

*resource(string): resource for the access management.(optional)

*targets(array of arrays): targets for the access management.(optional)

*active(bool): Set if the access management will be visible. Default True. (optional)

*tags(array): An array of objects with key and value. (optional)

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

data = {
    'name': 'my new name of access management',
}

result = my_account.accessManagement.edit('ACCESS_MANAGEMENT_ID', data)
print(result)

.info

Get information about the access management

Syntax

.info(/id/)

Arguments

id(string) reference ID of the access management.

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

access_management_info = my_account.accessManagement.info('5dc0b9ab9955dd0026247ce6')
print(access_management_info)

.delete

Delete access management for the account

Syntax

.delete(/id/)

Arguments

id(string) reference ID of the access management.

Returns

(Promise)

import tago

my_account = tago.Account('54d83222-6837-4e9e-8f2e-67de8fce5a8b')

result = my_account.accessManagement.delete('5dc0b9ab9955dd0026247ce6')
print(result)