api.currentuser.v1 package¶
Subpackages¶
Submodules¶
api.currentuser.v1.authmethods module¶
Autogenerated API
-
api.currentuser.v1.authmethods.
get_current_user_methods
(json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ List the current users valid authentication methods (PUBLIC)
Raises: - AuthenticationFailedException – on 401
- ValidationFailedException – on 412
- AccessDeniedException – on 403
- UserNotFoundException – on 404
Returns: {“offset”: 340, “limit”: 343, “responseCode”: 200, “count”: 902, “data”: [{“method”: “TOTP”, “lastLoginTimestamp”: 1149830669, “lastLoginIP”: “Remember him threat mouth available score into.”, “initialized”: false, “settings”: {“additionalProperties”: {}}}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Look seek lose job enjoy think realize agreement.”, “messageTemplate”: “Federal reach some agree far.”, “field”: “Business easy artist.”, “parameter”: {}, “timestamp”: 673110346}], “currentPage”: 305, “size”: 544}
api.currentuser.v1.functions module¶
Autogenerated API
-
api.currentuser.v1.functions.
get_functions
(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 the current user’s permission functions regardless of customer (PUBLIC)
Return type: dict
Parameters: - 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: - AuthenticationFailedException – on 401
- ForbiddenPermissionException – on 403
Returns: {“offset”: 615, “limit”: 993, “responseCode”: 200, “count”: 564, “data”: [{“id”: 94, “name”: “Jermaine Miller”, “description”: “Most represent responsibility.”, “securityLevel”: “EXTERNAL”, “flags”: [“ROLE”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Someone teach always.”, “messageTemplate”: “Mean until move cultural week rather.”, “field”: “Cultural mention tax bit.”, “parameter”: {}, “timestamp”: 431400117}], “currentPage”: 846, “size”: 145}
api.currentuser.v1.picture module¶
Autogenerated API
-
api.currentuser.v1.picture.
get_profile_picture
(json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Get current user’s profile picture (PUBLIC)
Raises: - AuthenticationFailedException – on 401
- AccessDeniedException – on 403
- ProfilePictureNotFoundException – on 404
Returns: {}
-
api.currentuser.v1.picture.
update_profile_picture
(picture: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Set current user’s profile picture (PUBLIC)
Return type: dict
Parameters: picture (str) – Image data url
Raises: - AuthenticationFailedException – on 401
- AccessDeniedException – on 403
Returns: {“offset”: 898, “limit”: 701, “responseCode”: 200, “count”: 537, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Middle admit audience significant.”, “messageTemplate”: “Deep before four explain.”, “field”: “Let vote culture wide.”, “parameter”: {}, “timestamp”: 909194264}], “currentPage”: 298, “size”: 108}
api.currentuser.v1.prefs module¶
Autogenerated API
-
api.currentuser.v1.prefs.
delete_properties
(key: list = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Delete multiple current user’s preferences (PUBLIC)
Return type: dict
Parameters: key (list) – Keys to delete
Raises: - AuthenticationFailedException – on 401
- AccessDeniedException – on 403
Returns: {“offset”: 103, “limit”: 686, “responseCode”: 200, “count”: 100, “data”: {}, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Land carry these ability tonight seek.”, “messageTemplate”: “Certain describe say practice might statement morning.”, “field”: “Word time consumer method work relationship.”, “parameter”: {}, “timestamp”: 1102587370}], “currentPage”: 897, “size”: 982}
-
api.currentuser.v1.prefs.
delete_property
(propertyKey: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Delete the specified current user’s preference (PUBLIC)
Return type: dict
Parameters: propertyKey (str) – Preference key to delete
Raises: - AuthenticationFailedException – on 401
- AccessDeniedException – on 403
Returns: {“offset”: 608, “limit”: 737, “responseCode”: 200, “count”: 420, “data”: {}, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Pass forward between work.”, “messageTemplate”: “Artist program news rate avoid owner.”, “field”: “Community address each loss full church expert.”, “parameter”: {}, “timestamp”: 1240381678}], “currentPage”: 706, “size”: 265}
-
api.currentuser.v1.prefs.
get_property
(propertyKey: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Fetch a specific current user’ preference value (PUBLIC) Returns a the specified preference value, or null if not set
Return type: dict
-
api.currentuser.v1.prefs.
list_properties
(json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ List all current user’s preferences (PUBLIC) Returns a dictionary of key/value pairs, defining all the users preferences
raises AuthenticationFailedException: on 401 returns: {“offset”: 624, “limit”: 827, “responseCode”: 200, “count”: 241, “data”: {}, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Whether discover rich all.”, “messageTemplate”: “Body though mention far water.”, “field”: “Why open church available their whatever news.”, “parameter”: {}, “timestamp”: 498531015}], “currentPage”: 597, “size”: 717}
-
api.currentuser.v1.prefs.
set_properties
(body: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Set the specified current user’s preferences (PUBLIC)
Return type: dict
Parameters: body (
str
) – Map of preference values to updateRaises: - AuthenticationFailedException – on 401
- AccessDeniedException – on 403
Returns: {“offset”: 158, “limit”: 136, “responseCode”: 200, “count”: 751, “data”: {}, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Sense learn law deal.”, “messageTemplate”: “Inside explain throw impact guy.”, “field”: “Adult company decide spring dinner.”, “parameter”: {}, “timestamp”: 301109939}], “currentPage”: 766, “size”: 338}
api.currentuser.v1.user module¶
Autogenerated API
-
api.currentuser.v1.user.
get_current_user
(json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Get the object representation of the currently logged in user (PUBLIC)
Raises: AuthenticationFailedException – on 401 Returns: {“offset”: 399, “limit”: 450, “responseCode”: 200, “count”: 743, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Hear prevent may modern.”, “messageTemplate”: “Indeed far attention its almost score coach.”, “field”: “Happen senior month risk loss room.”, “parameter”: {}, “timestamp”: 363855383}], “currentPage”: 5, “size”: 58}