authorization_validate#

Autogenerated API

argus_api.lib.authentication.v1.authorization.authorization_validate.validate_user_authorization(operation: str = None, context: dict = None, authorization: str = None, allowReplay: bool = None, allowExpired: bool = 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 authorization token (PUBLIC)

Parameters

  • operation (str) – The name of the operation

  • context (dict) – Context variables to scope this authorization. All context variables must be present in the authorization token and their value must be equal to those provided here.

  • authorization (str) – The authorization JWT token

  • allowReplay (bool) – If true, previous validations of the same authorization is ignored. Defaults to false (will fail if token was previously validated)

  • allowExpired (bool) – If true, an expired authorization is ignored. Defaults to false (will fail if token is expired)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.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
Returns

dictionary translated from JSON