Skip to content

UserService

UserService(rest)

Bases: ObjectService

Source code in TM1py/Services/UserService.py 
13
14
def __init__(self, rest: RestService):
    super().__init__(rest)

disconnect(user_name, **kwargs)

Disconnect User

Parameters:

Name Type Description Default
user_name str
required

Returns:

Type Description
Response
Source code in TM1py/Services/UserService.py 
46
47
48
49
50
51
52
53
54
def disconnect(self, user_name: str, **kwargs) -> Response:
    """Disconnect User

    :param user_name:
    :return:
    """
    url = format_url("/Users('{}')/tm1.Disconnect", user_name)
    response = self._rest.POST(url, **kwargs)
    return response

disconnect_all(**kwargs)

Source code in TM1py/Services/UserService.py 
56
57
58
59
60
61
62
63
64
65
@require_admin
def disconnect_all(self, **kwargs) -> list:
    current_user = self.get_current(**kwargs)
    active_users = self.get_active(**kwargs)
    disconnected_users = list()
    for active_user in active_users:
        if not case_and_space_insensitive_equals(current_user.name, active_user.name):
            self.disconnect(active_user.name, **kwargs)
            disconnected_users += [active_user.name]
    return disconnected_users

get_active(**kwargs)

Get the activate users in TM1

Returns:

Type Description
List[User]

List of TM1py.User instances
Source code in TM1py/Services/UserService.py 
26
27
28
29
30
31
32
33
34
def get_active(self, **kwargs) -> List[User]:
    """Get the activate users in TM1

    :return: List of TM1py.User instances
    """
    url = "/Users?$filter=IsActive eq true&$expand=Groups"
    response = self._rest.GET(url, **kwargs)
    users = [User.from_dict(user) for user in response.json()["value"]]
    return users

get_all(**kwargs)

Get all users

Returns:

Type Description
List[User]

List of TM1py.User instances
Source code in TM1py/Services/UserService.py 
16
17
18
19
20
21
22
23
24
def get_all(self, **kwargs) -> List[User]:
    """Get all users

    :return: List of TM1py.User instances
    """
    url = "/Users?$expand=Groups"
    response = self._rest.GET(url, **kwargs)
    users = [User.from_dict(user) for user in response.json()["value"]]
    return users

get_current(**kwargs)

Source code in TM1py/Services/UserService.py 
67
68
69
70
71
def get_current(self, **kwargs):
    from TM1py import SecurityService

    security_service = SecurityService(self._rest)
    return security_service.get_current_user(**kwargs)

is_active(user_name, **kwargs)

Check if user is currently active in TM1

Parameters:

Name Type Description Default
user_name str
required

Returns:

Type Description
bool

Boolean
Source code in TM1py/Services/UserService.py 
36
37
38
39
40
41
42
43
44
def is_active(self, user_name: str, **kwargs) -> bool:
    """Check if user is currently active in TM1

    :param user_name:
    :return: Boolean
    """
    url = format_url("/Users('{}')/IsActive", user_name)
    response = self._rest.GET(url, **kwargs)
    return bool(response.json()["value"])