"""Autogenerated API"""
import requests
from argus_cli.plugin import register_command
[docs]@register_command(extending=('users','v1','user'))
def list_users(subjectID: list = None, offset: int = None, limit: int = 25,json: bool = True, verify: bool = True, apiKey: str = "", authentication: dict = {}) -> dict:
"""Get user profiles (PUBLIC)
:param list subjectID: IDs of users
:param int offset: Offset results
:param int limit: Limit results
:raises AuthenticationFailedException: on 401
:raises ValidationErrorException: on 412
:raises AccessDeniedException: on 403
: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}
"""
from requests import get
from argus_api.exceptions import http
url = "https://osl-argus-trunk-web1.mnemonic.no/web/api/users/v1/user".format()
headers = {
'Content-Type': 'application/json',
'User-Agent': 'ArgusToolbelt/1.0'
}
if apiKey:
headers["Argus-API-Key"] = apiKey
elif authentication and isinstance(authentication, dict):
headers.update(authentication)
elif callable(authentication):
headers.update(authentication(url))
body = {}
if limit:
body.update({"limit": limit})
if subjectID:
body.update({"subjectID": subjectID})
if offset:
body.update({"offset": offset})
response = get(url, json=body if body else None, verify=verify, headers=headers)
errors = []
if response.status_code == 401:
raise http.AuthenticationFailedException(response)
elif response.status_code == 403:
raise http.AccessDeniedException(response)
elif response.status_code == 412:
raise http.ValidationErrorException(response)
elif response.status_code == 404:
raise http.ObjectNotFoundException(response)
return response.json() if json else response
[docs]@register_command(extending=('users','v1','user'))
def 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:
"""Search user profiles (PUBLIC)
:param int limit: Set this value to set max number of results. By default, no restriction on result set size.
:param int offset: Set this value to skip the first (offset) objects. By default, return result from first object.
:param int includeFlags: Only include objects which have includeFlags set.
:param int excludeFlags: Exclude objects which have excludeFlags set.
:param list subCriteria:
:param list customerID: Restrict search to data belonging to specified customers.
:param list domain:
:param str type:
:param list subjectID:
:param list excludeSubjectID:
:param list parentID:
:param list ancestorID:
:param list get_aclAncestorID:
:param list get_aclCustomerID:
:param list excludeAncestorID:
:param list userName:
:param list email:
:param list mobile:
:param str searchString:
:param list languageID:
:param list requiredFunctionID:
:param int requiredFunctionCustomerID:
:param bool includeDeleted: Set to true to include deleted objects. By default, exclude deleted objects.
:param bool exclude: Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
:param bool required: Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
:param bool requireAllFunctions:
:raises AuthenticationFailedException: on 401
:raises ValidationErrorException: on 412
:raises AccessDeniedException: on 403
: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}
"""
from requests import post
from argus_api.exceptions import http
url = "https://osl-argus-trunk-web1.mnemonic.no/web/api/users/v1/user/search".format()
headers = {
'Content-Type': 'application/json',
'User-Agent': 'ArgusToolbelt/1.0'
}
if apiKey:
headers["Argus-API-Key"] = apiKey
elif authentication and isinstance(authentication, dict):
headers.update(authentication)
elif callable(authentication):
headers.update(authentication(url))
body = {}
if limit:
body.update({"limit": limit})
if offset:
body.update({"offset": offset})
if includeDeleted:
body.update({"includeDeleted": includeDeleted})
if includeFlags:
body.update({"includeFlags": includeFlags})
if excludeFlags:
body.update({"excludeFlags": excludeFlags})
if subCriteria:
body.update({"subCriteria": subCriteria})
if exclude:
body.update({"exclude": exclude})
if required:
body.update({"required": required})
if customerID:
body.update({"customerID": customerID})
if domain:
body.update({"domain": domain})
if type:
body.update({"type": type})
if subjectID:
body.update({"subjectID": subjectID})
if excludeSubjectID:
body.update({"excludeSubjectID": excludeSubjectID})
if parentID:
body.update({"parentID": parentID})
if ancestorID:
body.update({"ancestorID": ancestorID})
if get_aclAncestorID:
body.update({"get_aclAncestorID": get_aclAncestorID})
if get_aclCustomerID:
body.update({"get_aclCustomerID": get_aclCustomerID})
if excludeAncestorID:
body.update({"excludeAncestorID": excludeAncestorID})
if userName:
body.update({"userName": userName})
if email:
body.update({"email": email})
if mobile:
body.update({"mobile": mobile})
if searchString:
body.update({"searchString": searchString})
if languageID:
body.update({"languageID": languageID})
if requiredFunctionID:
body.update({"requiredFunctionID": requiredFunctionID})
if requiredFunctionCustomerID:
body.update({"requiredFunctionCustomerID": requiredFunctionCustomerID})
if requireAllFunctions:
body.update({"requireAllFunctions": requireAllFunctions})
response = post(url, json=body if body else None, verify=verify, headers=headers)
errors = []
if response.status_code == 401:
raise http.AuthenticationFailedException(response)
elif response.status_code == 403:
raise http.AccessDeniedException(response)
elif response.status_code == 412:
raise http.ValidationErrorException(response)
elif response.status_code == 404:
raise http.ObjectNotFoundException(response)
return response.json() if json else response
[docs]@register_command(extending=('users','v1','user'))
def get_profile(userId: int,json: bool = True, verify: bool = True, apiKey: str = "", authentication: dict = {}) -> dict:
"""Get user profile by ID (PUBLIC)
:param int userId: ID of user
:raises AuthenticationFailedException: on 401
:raises ValidationErrorException: on 412
:raises AccessDeniedException: on 403
:raises ObjectNotFoundException: on 404
: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}
"""
from requests import get
from argus_api.exceptions import http
url = "https://osl-argus-trunk-web1.mnemonic.no/web/api/users/v1/user/{userId}".format(userId=userId)
headers = {
'Content-Type': 'application/json',
'User-Agent': 'ArgusToolbelt/1.0'
}
if apiKey:
headers["Argus-API-Key"] = apiKey
elif authentication and isinstance(authentication, dict):
headers.update(authentication)
elif callable(authentication):
headers.update(authentication(url))
body = {}
response = get(url, json=body if body else None, verify=verify, headers=headers)
errors = []
if response.status_code == 401:
raise http.AuthenticationFailedException(response)
elif response.status_code == 403:
raise http.AccessDeniedException(response)
elif response.status_code == 412:
raise http.ValidationErrorException(response)
elif response.status_code == 404:
raise http.ObjectNotFoundException(response)
return response.json() if json else response
[docs]@register_command(extending=('users','v1','user'))
def 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:
"""List a user's permission functions regardless of customer (PUBLIC)
:param int userId: ID of user
:param bool onlyRoles: Only return functions marked as roles
:param list keywords: Filter functions by keywords on name and description
:param int offset: Skip a number of functions
:param int limit: Maximum number of returned functions
:raises AuthenticationFailedException: on 401
:raises ValidationErrorException: on 412
:raises AccessDeniedException: on 403
:raises UserNotFoundException: on 404
: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}
"""
from requests import get
from argus_api.exceptions import http
url = "https://osl-argus-trunk-web1.mnemonic.no/web/api/users/v1/user/{userId}/functions".format(userId=userId)
headers = {
'Content-Type': 'application/json',
'User-Agent': 'ArgusToolbelt/1.0'
}
if apiKey:
headers["Argus-API-Key"] = apiKey
elif authentication and isinstance(authentication, dict):
headers.update(authentication)
elif callable(authentication):
headers.update(authentication(url))
body = {}
if offset:
body.update({"offset": offset})
if limit:
body.update({"limit": limit})
if onlyRoles:
body.update({"onlyRoles": onlyRoles})
if keywords:
body.update({"keywords": keywords})
response = get(url, json=body if body else None, verify=verify, headers=headers)
errors = []
if response.status_code == 401:
raise http.AuthenticationFailedException(response)
elif response.status_code == 403:
raise http.AccessDeniedException(response)
elif response.status_code == 412:
raise http.ValidationErrorException(response)
elif response.status_code == 404:
raise http.ObjectNotFoundException(response)
return response.json() if json else response
[docs]@register_command(extending=('users','v1','user'))
def check_permission(userId: int, function: str,json: bool = True, verify: bool = True, apiKey: str = "", authentication: dict = {}) -> dict:
"""Validate user permission to perform function (PUBLIC)
:param int userId: ID of user
:param str function: Function name
:raises AuthenticationFailedException: on 401
:raises ValidationFailedException: on 412
:raises ForbiddenPermissionException: on 403
:raises UserNotFoundException: on 404
:returns: {}
"""
from requests import get
from argus_api.exceptions import http
url = "https://osl-argus-trunk-web1.mnemonic.no/web/api/users/v1/user/{userId}/permission/{function}".format(userId=userId, function=function)
headers = {
'Content-Type': 'application/json',
'User-Agent': 'ArgusToolbelt/1.0'
}
if apiKey:
headers["Argus-API-Key"] = apiKey
elif authentication and isinstance(authentication, dict):
headers.update(authentication)
elif callable(authentication):
headers.update(authentication(url))
body = {}
response = get(url, json=body if body else None, verify=verify, headers=headers)
errors = []
if response.status_code == 401:
raise http.AuthenticationFailedException(response)
elif response.status_code == 403:
raise http.AccessDeniedException(response)
elif response.status_code == 412:
raise http.ValidationErrorException(response)
elif response.status_code == 404:
raise http.ObjectNotFoundException(response)
return response.json() if json else response
[docs]@register_command(extending=('users','v1','user'))
def update_profile_picture_for_user(userId: int, picture: str = None,json: bool = True, verify: bool = True, apiKey: str = "", authentication: dict = {}) -> dict:
"""Upload and modify the user image (PUBLIC)
:param int userId: ID of user to change image for
:param str picture: Image data URL
:raises AuthenticationFailedException: on 401
:raises ValidationErrorException: on 412
:raises AccessDeniedException: on 403
:raises ObjectNotFoundException: on 404
: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}
"""
from requests import put
from argus_api.exceptions import http
url = "https://osl-argus-trunk-web1.mnemonic.no/web/api/users/v1/user/{userId}/picture".format(userId=userId)
headers = {
'Content-Type': 'application/json',
'User-Agent': 'ArgusToolbelt/1.0'
}
if apiKey:
headers["Argus-API-Key"] = apiKey
elif authentication and isinstance(authentication, dict):
headers.update(authentication)
elif callable(authentication):
headers.update(authentication(url))
body = {}
if picture:
body.update({"picture": picture})
response = put(url, json=body if body else None, verify=verify, headers=headers)
errors = []
if response.status_code == 401:
raise http.AuthenticationFailedException(response)
elif response.status_code == 403:
raise http.AccessDeniedException(response)
elif response.status_code == 412:
raise http.ValidationErrorException(response)
elif response.status_code == 404:
raise http.ObjectNotFoundException(response)
return response.json() if json else response
[docs]@register_command(extending=('users','v1','user'))
def get_user_by_username(userName: str,json: bool = True, verify: bool = True, apiKey: str = "", authentication: dict = {}) -> dict:
"""Get user profile by username (PUBLIC)
:param str userName: Username
:raises AuthenticationFailedException: on 401
:raises ValidationErrorException: on 412
:raises AccessDeniedException: on 403
:raises ObjectNotFoundException: on 404
: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}
"""
from requests import get
from argus_api.exceptions import http
url = "https://osl-argus-trunk-web1.mnemonic.no/web/api/users/v1/user/{userName}".format(userName=userName)
headers = {
'Content-Type': 'application/json',
'User-Agent': 'ArgusToolbelt/1.0'
}
if apiKey:
headers["Argus-API-Key"] = apiKey
elif authentication and isinstance(authentication, dict):
headers.update(authentication)
elif callable(authentication):
headers.update(authentication(url))
body = {}
response = get(url, json=body if body else None, verify=verify, headers=headers)
errors = []
if response.status_code == 401:
raise http.AuthenticationFailedException(response)
elif response.status_code == 403:
raise http.AccessDeniedException(response)
elif response.status_code == 412:
raise http.ValidationErrorException(response)
elif response.status_code == 404:
raise http.ObjectNotFoundException(response)
return response.json() if json else response