sisense.admin package

Submodules

sisense.admin.grafana module

class sisense.admin.grafana.Grafana(api: sisense.api.API, rjson: dict = None)[source]

Bases: sisense.resource.Resource

query(expression: str, start: int = None, end: int = None, step: int = 30) → dict[source]

Execute a query in Grafana.

Parameters:
  • expression – (str) A Grafana’s expression.
  • start – (int, default None) Timestamp in seconds. If start is None, start = time.now().
  • end – (int, default None) Timestamp in seconds. If end is None, end = start.
  • step – (int, default 30) Sample the data every “step” seconds.
Returns:

(dict) The Grafana’s result. Example: {

”status”: “success”, “data”: {

”resultType”: “matrix”, “result”: [ # one for each node

{
“metric”: {

“container”: <str>, “endpoint”: <str>, “instance”: <str>, “job”: <str>, “namespace”: <str>, “pod”: <str>, “service”: <str>

}, “values”: [

[<timestamp>, <str (expected value)>], …

]

]

}

}

sisense.admin.group module

class sisense.admin.group.Group(api: sisense.api.API, rjson: dict = None)[source]

Bases: sisense.resource.Resource

add_user(user: sisense.admin.user.User)[source]

Add a user to the current group. If user is already in the group, do nothing.

Parameters:user – (User) User to be added.
all(**kwargs) → list[source]

Get all groups.

Parameters:kwargs – Positional optional arguments used to filter users: - name: (str) Group’s name. - mail: (str) Group’s email. - roleId: (str) Role ID. - origin: (‘ad’, ‘sisense’) User’s origin. - ids: (list) Groups’ IDs. - fields: (list) Which fields to return. - sort: (str) Field in which the results should be sorted. - skip: (int) Number of results to skip from start. - limit: (int) Number of results returned. - expand: (list) Fields that should be expanded (substitutes their IDs with actual objects).
Returns:(list) of Group objects.
create(name: str) → sisense.resource.Resource[source]

Create a new group.

Parameters:name – (str) Group’s name.
Returns:(Group) Newly created group.
delete()[source]

Delete the current group.

get(name: str = None, oid: str = None) → sisense.resource.Resource[source]

Get group by name. At least one parameter should be set.

Parameters:
  • name – (str, default None) Group’s name.
  • oid – (str, default None) Group’s ID.
Returns:

Group, if found. None, otherwise.
remove_user(user: sisense.admin.user.User)[source]

Remove a user from the current group. If user isn’t in the group, do nothing.

Parameters:user – (User) User to be removed.

sisense.admin.user module

class sisense.admin.user.User(api: sisense.api.API, rjson: dict = None)[source]

Bases: sisense.resource.Resource

all(**kwargs) → list[source]

Get all users.

Parameters:kwargs – Positional optional arguments used to filter users: - userName: (str) Username. - email: (str) User’s email. - firstName: (str) User’s first name. - lastName: (str) User’s last name. - roleId: (str) Role ID. - groupId: (str) Group ID. - active: (bool) Whether to get active users (True) or not (False). - origin: (‘ad’, ‘sisense’) User’s origin. - ids: (list) Users’ IDs. - fields: (list) Which fields to return. - sort: (str) Field in which the results should be sorted. - skip: (int) Number of results to skip from start. - limit: (int) Number of results returned. - expand: (list) Fields that should be expanded (substitutes their IDs with actual objects).
Returns:(list)
create(email: str, **kwargs) → sisense.resource.Resource[source]

Create a new user.

Parameters:
  • email – (str) User’s email.
  • kwargs – (dict) Optional keyword arguments: - userName: (str) Username. - firstName: (str) First name. - lastName: (str) Last name. - roleId: (str) Role’s ID. - groups: (list) Group’s ID in which user is part of.
Returns:

(User) Newly created user.
delete()[source]

Delete the current user.

get(email: str = None, oid: str = None) → sisense.resource.Resource[source]

Get user by e-mail. At least one parameter should be set.

Parameters:
  • email – (str, default None) User’s e-mail.
  • oid – (str, default None) User’s ID.
Returns:

User, if found. None, otherwise.
update(**kwargs)[source]

Update the current user.

At least one argument must be set.

Parameters:kwargs – Positional optional arguments: - email: (str), - userName: (str) Username. - firstName: (str) First name. - lastName: (str) Last name. - roleId: (str) Role’s ID. - groups: (list) Group’s ID in which user is part of. - preferences: (dict) User’s preferences such as ‘localeId’. - uiSettings: (dict) User’s UI settings.

Module contents