session

Autogenerated API

argus_api.lib.authentication.v1.session.accept_session_transfer(seed: str = None, data: 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

Accept transfer of session token from other domain (PUBLIC)

Parameters

• seed (str) –

• data (str) –

• 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

• AuthenticationFailedException – on 401

• ArgusException – on other status codes

Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.session.check_session_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 (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 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

• AuthenticationFailedException – on 401

• ForbiddenPermissionException – on 403

• UserNotFoundException – on 404

• ValidationFailedException – on 412

• ArgusException – on other status codes

Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.session.clear_session_data(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

Clear the current sessions sessiondata (PUBLIC)

Parameters

• 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

• AuthenticationFailedException – on 401

• ArgusException – on other status codes

Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.session.constrain_session(customer: str = None, function: str = None, readOnly: 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

Request a constrained session (PUBLIC)

Parameters

• customer (list) – Set of customers the session should be valid for (default is all current customers). Cannot extend the current set of customers.

• function (list) – Set of functions/roles (by name) the session should be granted (default is all current functions). Cannot extend the current set of functions.

• readOnly (bool) – If true, this session will be constrained to read only (default false)

• 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.

Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.session.delete_session(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

Invalidate current user session (PUBLIC)

Parameters

• 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.

Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.session.evict_session(sessionIdentifier: str, 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

Delete a specific session. The session will be deleted from the authorative cache and flushed from all distributed caches (PUBLIC)

Parameters

• sessionIdentifier (str) – Session identifier for the session to delete.

• 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

• AuthenticationFailedException – on 401

• AccessDeniedException – on 403

• SessionNotFoundException – on 404

• InvalidArgumentsException – on 412

• ArgusException – on other status codes

Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.session.get_session(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

Get session information of current user. If the request specifies a domain, this will also ensure that thecurrent session is bound to the requested domain. (PUBLIC)

Parameters

• domain (str) – Expected domain for this session.

• 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

• AuthenticationFailed,OrSessionDoesNotBelongToExpectedDomainException – on 401

• ArgusException – on other status codes

Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.session.get_session_auth_methods(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

List the current users valid authentication methods (PUBLIC)

Parameters

• 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

• AuthenticationFailedException – on 401

• AccessDeniedException – on 403

• UserNotFoundException – on 404

• ValidationFailedException – on 412

• ArgusException – on other status codes

Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.session.get_session_customers(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

List customers available in this session (PUBLIC)

Parameters

• 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.

Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.session.get_session_functions(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

List functions available in this session (PUBLIC)

Parameters

• 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.

Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.session.impersonate_session(userName: str = None, domain: str = None, customer: str = None, function: 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

Request an impersonated session (INTERNAL)

Parameters

• userName (str) – Username of user to impersonate.

• domain (str) – Domain of user to impersonate (id or name)

• customer (list) – Set of customers the session should be valid for. If not specified, customers will be inherited from active permissions.

• function (list) – Set of functions/roles (by name) the session should be granted (default is all current functions). Cannot extend the current set of functions.

• 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.

Returns

dictionary translated from JSON