b1platform Class

class bloxone.b1platform(cfg_file='config.ini')[source]

Class now reused for BloxOne Platform Methods, e.g. Audit Log Management of BloxOne On Prem Hosts is via the b1oph Class b1oph class is inherited here for compatibility

audit_users(domains=[])[source]

Audit User Data for non compliant email domains

Parameters

domain (list) – List of valid email domains

Returns

List of User Data (json)

auditlog(**params)[source]

Get the audit log

Parameters

**params (dict) – Generic API parameters

Returns

audit_log (list); list of dict

create_join_token(name='', desc='', tags={})[source]

Create a new join token

Parameters
  • name (str) – Name of JT

  • desc (str) – Description

  • tages (dict) – Dictionary of tags to add

Returns

Requests response object

Return type

response object

create_user(name='', email='', type='interactive', authenticator='IDP', groups=['user', 'act_admin'], **params)[source]

Create User Account

Parameters

**params (dict) – Generic API parameters

Returns

Requests response object

Return type

response object

delete_user(email='', **params)[source]

Create User Account

Parameters

**params (dict) – Generic API parameters

Returns

Requests response object

Return type

response object

get_current_tenant(**params)[source]

Get name of current tenant

Parameters

**params (dict) – Generic API parameters

Returns

string containing name of tenant or ‘’ on failure

get_current_user(**params)[source]

Get Current User Data

Parameters

**params (dict) – Generic API parameters

Returns

Requests response object

Return type

response object

get_current_user_accounts(**params)[source]

Get Current Users Accounts Data

Parameters

**params (dict) – Generic API parameters

Returns

Requests response object

Return type

response object

get_full_auditlog(**params)[source]
get_group_ids(groups=['user'], **params)[source]

Get User Group IDs

Parameters
  • groups (list) – List of group names

  • **params (dict) – Generic API parameters

Returns

Requests response object

Return type

response object

get_groups(**params)[source]

Get User Groups

Parameters

**params (dict) – Generic API parameters

Returns

Requests response object

Return type

response object

get_join_token(name='', **params)[source]

Get Join Tokens

Parameters

name (str) – Optional name of JT

Returns

Requests response object

Return type

response object

get_join_token_id(name='')[source]

Get the ID of a Join Token by name

Parameters

name (str) – Name of the JT

Returns

id of the join token or “”

Return type

id (str)

get_user_id(email='', include_path=False)[source]

Get object id using key/value pair

Parameters
  • email (str) – email address of user account

  • include_path (bool) – Include path to object id

Returns

object id or “”

Return type

id (str)

get_users(**params)[source]

Get User Data

Parameters

**params (dict) – Generic API parameters

Returns

Requests response object

Return type

response object

Perform a global search

Parameters
  • query (str) – Search term

  • limit (int) – Max number of records to match

  • filters (list) – list of filter definitions

  • offset (int) – record offset

  • **params – Additional parameters

Returns

Requests response object

Return type

response object

global_search_version()[source]

Get the global search version information

Returns

Requests response object

Return type

response object

revoke_join_token(name='')[source]

Revoke a join token by name

Parameters

name (str) – Name of JT

Returns

Requests response object

Return type

response object

revoke_join_tokens(id_list=[])[source]

Revoke a set of join tokens

Parameters

id_list (list) – list of JT ids

Returns

Requests response object

Return type

response object

Simple form of global_search() returning list of objects with ids

Parameters

query (str) – Search term

Returns

List of dict of object ids and metadata

[ { ‘_id’: id, ‘metadata’: dict of metadata } ]

Return type

result (list)