api.users.v1 package

Submodules

api.users.v1.group module

Autogenerated API

api.users.v1.group.find_groups(limit: int = None, offset: int = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: list = None, customerID: list = None, domain: list = None, type: str = None, subjectID: list = None, excludeSubjectID: list = None, parentID: list = None, ancestorID: list = None, get_aclAncestorID: list = None, get_aclCustomerID: list = None, excludeAncestorID: list = None, userName: list = None, email: list = None, mobile: list = None, searchString: str = None, languageID: list = None, requiredFunctionID: list = None, requiredFunctionCustomerID: int = None, includeDeleted: bool = 'False', exclude: bool = 'False', required: bool = 'False', requireAllFunctions: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Search group profiles (PUBLIC)

Return type:

dict

Parameters:
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • includeFlags (int) – Only include objects which have includeFlags set.
  • excludeFlags (int) – Exclude objects which have excludeFlags set.
  • subCriteria (list) –
  • customerID (list) – Restrict search to data belonging to specified customers.
  • domain (list) –
  • type (str) –
  • subjectID (list) –
  • excludeSubjectID (list) –
  • parentID (list) –
  • ancestorID (list) –
  • get_aclAncestorID (list) –
  • get_aclCustomerID (list) –
  • excludeAncestorID (list) –
  • userName (list) –
  • email (list) –
  • mobile (list) –
  • searchString (str) –
  • languageID (list) –
  • requiredFunctionID (list) –
  • requiredFunctionCustomerID (int) –
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
  • requireAllFunctions (bool) –
Raises:
Returns:

{“offset”: 703, “limit”: 827, “responseCode”: 200, “count”: 912, “data”: [{“id”: 153, “userName”: “tina97”, “name”: “Cory Sanders”, “createdTimestamp”: 548123974, “createdByUser”: {“id”: 625, “customerID”: 933, “userName”: “figueroaeric”, “name”: “Victoria Stone”}, “lastUpdatedTimestamp”: 1394459918, “lastUpdatedByUser”: {“id”: 616, “customerID”: 978, “userName”: “adamsgregory”, “name”: “Amanda Roberts”}, “properties”: {“additionalProperties”: “Voice general risk water doctor control.”}, “groupName”: “Budget friend animal my current new of.”, “description”: “Discussion short available break.”, “ascendantIDs”: [1000], “flags”: [“AUTH_APIKEY”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Yard morning nature just great hard else.”, “messageTemplate”: “Those dream structure stop president to type.”, “field”: “Collection position notice make else.”, “parameter”: {}, “timestamp”: 1493877256}], “currentPage”: 658, “size”: 489}

api.users.v1.group.get_gropu_by_id(groupId: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Get group profile by ID (PUBLIC)

Return type:

dict

Parameters:

groupId (int) – ID of group

Raises:
Returns:

{“offset”: 576, “limit”: 185, “responseCode”: 200, “count”: 727, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Standard method station professor writer radio voice.”, “messageTemplate”: “Instead reach purpose live at front.”, “field”: “Agent much moment time.”, “parameter”: {}, “timestamp”: 826550696}], “currentPage”: 665, “size”: 402}

api.users.v1.group.get_group_by_name(groupName: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Get group profile by name (PUBLIC)

Return type:

dict

Parameters:

groupName (str) – Group shortname

Raises:
Returns:

{“offset”: 230, “limit”: 948, “responseCode”: 200, “count”: 56, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Maybe blue will majority.”, “messageTemplate”: “None fine memory.”, “field”: “Chair skill fly.”, “parameter”: {}, “timestamp”: 1021234115}], “currentPage”: 688, “size”: 580}

api.users.v1.group.list_groups(subjectID: list = None, offset: int = None, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Get group information (PUBLIC)

Return type:

dict

Parameters:
  • subjectID (list) – IDs of groups
  • offset (int) – Offset results
  • limit (int) – Limit results
Raises:
Returns:

{“offset”: 587, “limit”: 966, “responseCode”: 200, “count”: 722, “data”: [{“id”: 786, “customerID”: 872, “description”: “Different daughter economic black less coach.”, “name”: “Terry Lewis”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Court time policy claim physical minute let.”, “messageTemplate”: “Simply his consumer since really receive before affect.”, “field”: “Describe there somebody after board recent over.”, “parameter”: {}, “timestamp”: 1245309271}], “currentPage”: 942, “size”: 450}

api.users.v1.subject module

Autogenerated API

api.users.v1.subject.find_subjects(limit: int = None, offset: int = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: list = None, customerID: list = None, domain: list = None, type: str = None, subjectID: list = None, excludeSubjectID: list = None, parentID: list = None, ancestorID: list = None, get_aclAncestorID: list = None, get_aclCustomerID: list = None, excludeAncestorID: list = None, userName: list = None, email: list = None, mobile: list = None, searchString: str = None, languageID: list = None, requiredFunctionID: list = None, requiredFunctionCustomerID: int = None, includeDeleted: bool = 'False', exclude: bool = 'False', required: bool = 'False', requireAllFunctions: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Search user or group profiles (PUBLIC)

Return type:

dict

Parameters:
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • includeFlags (int) – Only include objects which have includeFlags set.
  • excludeFlags (int) – Exclude objects which have excludeFlags set.
  • subCriteria (list) –
  • customerID (list) – Restrict search to data belonging to specified customers.
  • domain (list) –
  • type (str) –
  • subjectID (list) –
  • excludeSubjectID (list) –
  • parentID (list) –
  • ancestorID (list) –
  • get_aclAncestorID (list) –
  • get_aclCustomerID (list) –
  • excludeAncestorID (list) –
  • userName (list) –
  • email (list) –
  • mobile (list) –
  • searchString (str) –
  • languageID (list) –
  • requiredFunctionID (list) –
  • requiredFunctionCustomerID (int) –
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
  • requireAllFunctions (bool) –
Raises:
Returns:

{“offset”: 399, “limit”: 604, “responseCode”: 200, “count”: 322, “data”: [{“id”: 142, “customerID”: 489, “name”: “Travis Macdonald”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Service if let purpose campaign no trial dinner.”, “messageTemplate”: “Year manage treatment Democrat happy seat provide.”, “field”: “Method itself bill imagine his.”, “parameter”: {}, “timestamp”: 136391178}], “currentPage”: 623, “size”: 839}

api.users.v1.subject.get_subject_by_id(subjectID: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Get user or group profile by ID (PUBLIC)

Return type:

dict

Parameters:

subjectID (int) – ID of subject

Raises:
Returns:

{“offset”: 638, “limit”: 679, “responseCode”: 200, “count”: 755, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Where project light hard fly.”, “messageTemplate”: “Last before degree whom go.”, “field”: “Suffer weight finish affect take law point recently.”, “parameter”: {}, “timestamp”: 1470849620}], “currentPage”: 107, “size”: 452}

api.users.v1.subject.get_subject_by_name(subjectName: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Get user or group profile by name (PUBLIC)

Return type:

dict

Parameters:

subjectName (str) – Username or group shortname

Raises:
Returns:

{“offset”: 405, “limit”: 847, “responseCode”: 200, “count”: 799, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Animal large might his.”, “messageTemplate”: “Cost president order according.”, “field”: “Cause yet animal seek between floor travel.”, “parameter”: {}, “timestamp”: 408297905}], “currentPage”: 553, “size”: 160}

api.users.v1.subject.list_subjects(subjectID: list = None, offset: int = None, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Get user or group profiles (PUBLIC)

Return type:

dict

Parameters:
  • subjectID (list) – IDs of subjects
  • offset (int) – Offset results
  • limit (int) – Limit results
Raises:
Returns:

{“offset”: 276, “limit”: 770, “responseCode”: 200, “count”: 226, “data”: [{“id”: 296, “customerID”: 380, “name”: “Rachel Butler”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Fine draw bad minute live.”, “messageTemplate”: “To production among over girl couple during.”, “field”: “Mission finally produce than face thousand our any.”, “parameter”: {}, “timestamp”: 1314780568}], “currentPage”: 190, “size”: 606}

api.users.v1.user module

Autogenerated API

api.users.v1.user.check_permission(userId: int, function: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Validate user permission to perform function (PUBLIC)

Return type:

dict

Parameters:
  • userId (int) – ID of user
  • function (str) – Function name
Raises:
  • AuthenticationFailedException – on 401
  • ValidationFailedException – on 412
  • ForbiddenPermissionException – on 403
  • UserNotFoundException – on 404
Returns:

{}

api.users.v1.user.find_users(limit: int = None, offset: int = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: list = None, customerID: list = None, domain: list = None, type: str = None, subjectID: list = None, excludeSubjectID: list = None, parentID: list = None, ancestorID: list = None, get_aclAncestorID: list = None, get_aclCustomerID: list = None, excludeAncestorID: list = None, userName: list = None, email: list = None, mobile: list = None, searchString: str = None, languageID: list = None, requiredFunctionID: list = None, requiredFunctionCustomerID: int = None, includeDeleted: bool = 'False', exclude: bool = 'False', required: bool = 'False', requireAllFunctions: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Search user profiles (PUBLIC)

Return type:

dict

Parameters:
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • includeFlags (int) – Only include objects which have includeFlags set.
  • excludeFlags (int) – Exclude objects which have excludeFlags set.
  • subCriteria (list) –
  • customerID (list) – Restrict search to data belonging to specified customers.
  • domain (list) –
  • type (str) –
  • subjectID (list) –
  • excludeSubjectID (list) –
  • parentID (list) –
  • ancestorID (list) –
  • get_aclAncestorID (list) –
  • get_aclCustomerID (list) –
  • excludeAncestorID (list) –
  • userName (list) –
  • email (list) –
  • mobile (list) –
  • searchString (str) –
  • languageID (list) –
  • requiredFunctionID (list) –
  • requiredFunctionCustomerID (int) –
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
  • requireAllFunctions (bool) –
Raises:
Returns:

{“offset”: 921, “limit”: 306, “responseCode”: 200, “count”: 341, “data”: [{“id”: 433, “customerID”: 345, “userName”: “brittany33”, “name”: “Spencer Martin”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Scientist impact nearly meeting appear nature.”, “messageTemplate”: “Change tough visit write agreement.”, “field”: “You security partner effort.”, “parameter”: {}, “timestamp”: 1102432711}], “currentPage”: 60, “size”: 186}

api.users.v1.user.get_functions(userId: int, onlyRoles: bool = None, keywords: list = None, offset: int = 0, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

List a user’s permission functions regardless of customer (PUBLIC)

Return type:

dict

Parameters:
  • userId (int) – ID of user
  • onlyRoles (bool) – Only return functions marked as roles
  • keywords (list) – Filter functions by keywords on name and description
  • offset (int) – Skip a number of functions
  • limit (int) – Maximum number of returned functions
Raises:
Returns:

{“offset”: 39, “limit”: 131, “responseCode”: 200, “count”: 735, “data”: [{“id”: 526, “name”: “Charles Dixon”, “description”: “Vote crime produce to.”, “securityLevel”: “DEFAULT”, “flags”: [“ROLE”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Necessary within direction look indicate culture.”, “messageTemplate”: “Keep social car natural.”, “field”: “Among move stand material anyone join.”, “parameter”: {}, “timestamp”: 252038504}], “currentPage”: 224, “size”: 534}

api.users.v1.user.get_profile(userId: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Get user profile by ID (PUBLIC)

Return type:

dict

Parameters:

userId (int) – ID of user

Raises:
Returns:

{“offset”: 169, “limit”: 841, “responseCode”: 200, “count”: 655, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “This indeed day growth focus difficult.”, “messageTemplate”: “Money positive from exist party role lot.”, “field”: “A wife audience member official house they whether.”, “parameter”: {}, “timestamp”: 1215477559}], “currentPage”: 613, “size”: 878}

api.users.v1.user.get_user_by_username(userName: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Get user profile by username (PUBLIC)

Return type:

dict

Parameters:

userName (str) – Username

Raises:
Returns:

{“offset”: 809, “limit”: 231, “responseCode”: 200, “count”: 473, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Speech in one individual.”, “messageTemplate”: “Even cell response treat or trial.”, “field”: “Field positive nor clear note blood whom.”, “parameter”: {}, “timestamp”: 219649903}], “currentPage”: 174, “size”: 200}

api.users.v1.user.list_users(subjectID: list = None, offset: int = None, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Get user profiles (PUBLIC)

Return type:

dict

Parameters:
  • subjectID (list) – IDs of users
  • offset (int) – Offset results
  • limit (int) – Limit results
Raises:
Returns:

{“offset”: 827, “limit”: 967, “responseCode”: 200, “count”: 747, “data”: [{“id”: 254, “customerID”: 369, “userName”: “trobertson”, “name”: “Danielle Myers”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Term between really something miss not.”, “messageTemplate”: “Including land those prove consumer.”, “field”: “Project hotel pattern strategy help street.”, “parameter”: {}, “timestamp”: 683912332}], “currentPage”: 807, “size”: 831}

api.users.v1.user.update_profile_picture_for_user(userId: int, picture: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Upload and modify the user image (PUBLIC)

Return type:

dict

Parameters:
  • userId (int) – ID of user to change image for
  • picture (str) – Image data URL
Raises:
Returns:

{“offset”: 539, “limit”: 631, “responseCode”: 200, “count”: 163, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Will western with politics.”, “messageTemplate”: “Discuss range laugh quite suddenly soldier.”, “field”: “Understand condition field staff.”, “parameter”: {}, “timestamp”: 1204751072}], “currentPage”: 984, “size”: 671}

Module contents