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 = None, 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’: 605, ‘limit’: 553, ‘responseCode’: 200, ‘count’: 415, ‘data’: [{‘method’: ‘OTP’, ‘lastLoginTimestamp’: 1122220578, ‘lastLoginIP’: ‘Environment concern instead.’, ‘initialized’: False, ‘settings’: {‘additionalProperties’: {}}}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Body those old might performance Congress.’, ‘messageTemplate’: ‘To model protect indicate.’, ‘field’: ‘Agreement meet administration material me.’, ‘parameter’: {}, ‘timestamp’: 1382430863}], ‘currentPage’: 610, ‘size’: 525}
api.currentuser.v1.functions module¶
Autogenerated API
-
api.currentuser.v1.functions.
get_functions
(onlyRoles: bool = None, keywords: list = None, offset: int = None, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 339, ‘limit’: 871, ‘responseCode’: 200, ‘count’: 92, ‘data’: [{‘id’: 495, ‘name’: ‘Jeffrey Smith’, ‘description’: ‘Agreement week leg organization.’, ‘securityLevel’: ‘EXTERNAL’, ‘flags’: [‘ROLE’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Compare try candidate.’, ‘messageTemplate’: ‘Activity entire newspaper send tree answer form.’, ‘field’: ‘Class fight pay tree assume citizen kitchen.’, ‘parameter’: {}, ‘timestamp’: 838274844}], ‘currentPage’: 34, ‘size’: 654}
api.currentuser.v1.picture module¶
Autogenerated API
-
api.currentuser.v1.picture.
get_profile_picture
(json: bool = True, verify: bool = True, apiKey: str = None, 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 = None, 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’: 867, ‘limit’: 417, ‘responseCode’: 200, ‘count’: 96, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Let force center lot wrong pull.’, ‘messageTemplate’: ‘Improve tend major.’, ‘field’: ‘Type despite force because rich eight.’, ‘parameter’: {}, ‘timestamp’: 806781491}], ‘currentPage’: 155, ‘size’: 154}
api.currentuser.v1.prefs module¶
Autogenerated API
-
api.currentuser.v1.prefs.
delete_properties
(key: list = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 553, ‘limit’: 781, ‘responseCode’: 200, ‘count’: 181, ‘data’: {}, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘History hold forget.’, ‘messageTemplate’: ‘Show set drop entire.’, ‘field’: ‘Cultural particularly with professional lay.’, ‘parameter’: {}, ‘timestamp’: 1175625774}], ‘currentPage’: 321, ‘size’: 944}
-
api.currentuser.v1.prefs.
delete_property
(propertyKey: str, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 743, ‘limit’: 242, ‘responseCode’: 200, ‘count’: 266, ‘data’: {}, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Whole get many son fast.’, ‘messageTemplate’: ‘Citizen even teacher alone attorney rule sometimes game.’, ‘field’: ‘Interview speak member catch.’, ‘parameter’: {}, ‘timestamp’: 604054465}], ‘currentPage’: 894, ‘size’: 433}
-
api.currentuser.v1.prefs.
get_property
(propertyKey: str, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Fetch a specific current user’ preference value (PUBLIC) Returns a the specified preference value, or null if not set :rtype:
dict
:type authentication:dict
:type apiKey:str
:type verify:bool
:type json:bool
:type propertyKey:str
param str propertyKey: Preference value to fetch raises AuthenticationFailedException: on 401 raises KeyNotSetException: on 404 returns: {}
-
api.currentuser.v1.prefs.
list_properties
(json: bool = True, verify: bool = True, apiKey: str = None, 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’: 280, ‘limit’: 709, ‘responseCode’: 200, ‘count’: 986, ‘data’: {}, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Summer shoulder enough.’, ‘messageTemplate’: ‘Want understand then bit certainly.’, ‘field’: ‘Arm challenge white break will trip six.’, ‘parameter’: {}, ‘timestamp’: 131806097}], ‘currentPage’: 181, ‘size’: 411}
-
api.currentuser.v1.prefs.
set_properties
(body=None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Set the specified current user’s preferences (PUBLIC)
Return type: dict
Parameters: body – Map of preference values to update
Raises: - AuthenticationFailedException – on 401
- AccessDeniedException – on 403
Returns: {‘offset’: 531, ‘limit’: 414, ‘responseCode’: 200, ‘count’: 878, ‘data’: {}, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Subject we modern entire town.’, ‘messageTemplate’: ‘Wide serious upon sure.’, ‘field’: ‘Edge woman see adult maintain place crime.’, ‘parameter’: {}, ‘timestamp’: 1266634069}], ‘currentPage’: 909, ‘size’: 733}
api.currentuser.v1.user module¶
Autogenerated API
-
api.currentuser.v1.user.
get_current_user
(json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Get the object representation of the currently logged in user (PUBLIC)
Raises: AuthenticationFailedException – on 401 Returns: {‘offset’: 865, ‘limit’: 372, ‘responseCode’: 200, ‘count’: 23, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Rest system century suffer.’, ‘messageTemplate’: ‘Wife else child add.’, ‘field’: ‘Point case effect push four listen return.’, ‘parameter’: {}, ‘timestamp’: 1003750768}], ‘currentPage’: 637, ‘size’: 561}