UserAttr.set - Python API

Creates a new user attribute or updates an already existing one, optionally encrypting it before it is saved in the database. It is also possible to set expiry for an attribute, upon reaching of which the attribute will be no longer available.

If an attribute of the input name does not exist, it will be created. If it does exist, it will be updated. This is akin to the MERGE statement in SQL (also known as upsert).

There are two versions of the call - .set is used with a single attribute and .set_many is used with multiple attributes. Performance-wise, it is more efficient to use .set_many if more than one attribute should be created or updated for a user.

set

user.attr.set(self, name, value, expiration=None, encrypt=False)

Creates or updates a user attribute.

Parameters:
  • name (string) – Name of the attribute to set
  • value (any) – An arbitrary value assigned to the name
  • expiration (integer) – After how many seconds, from current time, the attribute should expire
  • encrypt (bool) – Should the attribute’s value be stored encrypted or not

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# -*- coding: utf-8 -*-

from __future__ import absolute_import, division, print_function, unicode_literals

# Zato
from zato.server.service import Service

class UserAttrSet(Service):
    def handle(self):

        # Current user's data
        username = 'admin1'
        password = 'abxqDJpXMVXYEO8NOGx9nVZvv4xSew9'
        current_app = 'CRM'
        remote_addr = '127.0.0.1'
        user_agent = 'Firefox 139.0'

        # Log in current user
        session = self.sso.user.login(self.cid, username, password,
            current_app, remote_addr, user_agent)

        # Get UST
        ust = session.ust

        # Get user object
        user = self.sso.user.get_user_by_id(self.cid, session.user_id, ust, current_app, remote_addr)

        # Information about the attribute to be set
        name = 'my-attribute'
        value = 'my-value'

        # Create a new attribute
        user.attr.set(name, value)

set_many

user.attr.set_many(self, data, expiration=None, encrypt=False)

Creates or updates a series of user attributes.

Parameters:
  • data (dict) –

    A list of dictionaries, each describing an attribute to set. If any key is missing, the default value is taken from the method call’s parameters.

    Key Optional
    name
    value
    expiration Yes
    encrypt Yes
  • expiration (integer) – After how many seconds, from now, the attribute should expire (may be overridden in each dict)
  • encrypt (bool) – Should the attribute’s value be stored encrypted or not (may be overridden in each dict)

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# -*- coding: utf-8 -*-

from __future__ import absolute_import, division, print_function, unicode_literals

# Zato
from zato.server.service import Service

class UserAttrSetMany(Service):
    def handle(self):

        # Current user's data
        username = 'admin1'
        password = 'abxqDJpXMVXYEO8NOGx9nVZvv4xSew9'
        current_app = 'CRM'
        remote_addr = '127.0.0.1'
        user_agent = 'Firefox 139.0'

        # Log in current user
        session = self.sso.user.login(self.cid, username, password,
            current_app, remote_addr, user_agent)

        # Get UST
        ust = session.ust

        # Get user object
        user = self.sso.user.get_user_by_id(self.cid, session.user_id, ust, current_app, remote_addr)

        # Prepare a list of dictionaries with attributes to set
        data = [
            {'name':'my-attr1', 'value':'my-value1'},
            {'name':'my-attr2', 'value':'my-value2', 'encrypt':True},
            {'name':'my-attr3', 'value':'my-value3', 'expiration':3600},
        ]

        # Create new attributes
        user.attr.set_many(data)