permission#
Autogenerated API
- argus_api.lib.currentuser.v1.permission.permission.check_permission(function: str, customer: str, domain: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict #
Validate current user permission to perform function on specific customer. Use /authentication/v1/session/permission/{function}/{customer} instead. (PUBLIC)
- Parameters
function (str) – Function name
customer (str) – Customer ID or shortname
domain (str) – Domain ID or shortname for domain to lookup customer by shortname. Defaults to current users domain
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.Response
object will be returned.verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.
apiKey – Argus API key.
authentication – authentication override
server_url – API base URL override
body – body of the request. other parameters will override keys defined in the body.
api_session – session to use for this request. If not set, the global session will be used.
- Raises
AuthenticationFailedException – on 401
ForbiddenPermissionException – on 403
UserNotFoundException – on 404
ValidationFailedException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON