api.authentication.v1 package

Submodules

api.authentication.v1.apikey module

Autogenerated API

api.authentication.v1.apikey.authenticate(apikey: str = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Initiate a new user session using API key (PUBLIC) Requires password authentication to be enabled on the server, and for the userUse /methods to check which authentication methods are available on the server.

Use this operation to create a session to last across multiple requests.This might be useful for some legacy operations which require a web session, or for performance reasons if performing a large number of requests.

End session using /logout For one-shot requests, use Argus-API-Key header. :rtype: dict :type authentication: dict :type apiKey: str :type verify: bool :type json: bool :type apikey: str

param str apikey:
 
raises AuthenticationFailedException:
 on 401
raises ValidationErrorException:
 on 412
returns:{‘offset’: 994, ‘limit’: 111, ‘responseCode’: 200, ‘count’: 788, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Home yeah green face.’, ‘messageTemplate’: ‘Course clearly hundred control.’, ‘field’: ‘Rock understand door century that consumer five.’, ‘parameter’: {}, ‘timestamp’: 1025321583}], ‘currentPage’: 983, ‘size’: 491}
api.authentication.v1.apikey.initiate(password: str = None, description: str = None, validSources: <function list at 0x7efcbfa6fea0> = None, expirationDays: int = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Initiate a new apikey for current user (PUBLIC)

Return type:

dict

Parameters:
  • password (str) – User password to verify this request
  • description (str) – [sw{}$-().[]“‘_/,*+#:@!?;]*
  • validSources (list) – Client IP/CIDR networks which the api key will be valid for.
  • expirationDays (int) – Requested expiration days, 0 means unlimited. Default is 3 months. If user does not have permissions to specify expiration period, an error will be returned.
Raises:
Returns:

{‘offset’: 674, ‘limit’: 617, ‘responseCode’: 200, ‘count’: 174, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Grow daughter red rich weight artist fact why.’, ‘messageTemplate’: ‘Member throughout production.’, ‘field’: ‘Store mission great sit trip send white sing.’, ‘parameter’: {}, ‘timestamp’: 959582511}], ‘currentPage’: 567, ‘size’: 10}

api.authentication.v1.apikey.list(json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

List current user apikeys (PUBLIC)

Raises:
Returns:

{‘offset’: 883, ‘limit’: 56, ‘responseCode’: 200, ‘count’: 937, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Notice individual must air responsibility really thus until.’, ‘messageTemplate’: ‘Left budget space recent moment really several.’, ‘field’: ‘Onto order news specific.’, ‘parameter’: {}, ‘timestamp’: 377017322}], ‘currentPage’: 769, ‘size’: 669}

api.authentication.v1.apikey.renew(keyID: int, password: str = None, expirationDays: int = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Renew an apikey for current user (PUBLIC) API keys have limited validity. This operationallows the user to renew a key, to allow it to remain functional for a new validity period. :rtype: dict :type authentication: dict :type apiKey: str :type verify: bool :type json: bool :type expirationDays: int :type password: str :type keyID: int

param int keyID:
 Key ID
param str password:
 User password to verify this request
param int expirationDays:
 Requested expiration days, 0 means unlimited. Default is 3 months. If user does not have permissions to specify expiration period, an error will be returned.
raises AuthenticationFailedException:
 on 401
raises ValidationErrorException:
 on 412
raises AccessDeniedException:
 on 403
raises NotFoundException:
 on 404
returns:{‘offset’: 669, ‘limit’: 9, ‘responseCode’: 200, ‘count’: 82, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Themselves government these risk nor.’, ‘messageTemplate’: ‘Art under him.’, ‘field’: ‘Important particular cut wait.’, ‘parameter’: {}, ‘timestamp’: 379061703}], ‘currentPage’: 974, ‘size’: 510}
api.authentication.v1.apikey.revoke(keyID: int, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Revoke an apikey from current user (PUBLIC)

Return type:

dict

Parameters:

keyID (int) – Key ID

Raises:
Returns:

{‘offset’: 893, ‘limit’: 38, ‘responseCode’: 200, ‘count’: 271, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Affect official themselves attorney there often.’, ‘messageTemplate’: ‘Sound production employee fish significant.’, ‘field’: ‘Against soldier ever activity.’, ‘parameter’: {}, ‘timestamp’: 824269441}], ‘currentPage’: 331, ‘size’: 523}

api.authentication.v1.constrain module

Autogenerated API

api.authentication.v1.constrain.constrain(customerID: list = None, functionID: list = None, function: list = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Request a constrained session (PUBLIC) This operation will spawn a new user session, where the active userspermissions are constrained to the specified subset of the active users permissions.In addition to returning the constrained session token, the new session will be set as cookies, overwriting any existing session cookies. :rtype: dict :type authentication: dict :type apiKey: str :type verify: bool :type json: bool :type function: list :type functionID: list :type customerID: list

param list customerID:
 Set of customers the session should be valid for (default is all current customers). Cannot extend the current set of customers.
param list functionID:
 Set of functions/roles (by ID) the session should be granted (default is all current functions). Cannot extend the current set of functions.
param list function:
 Set of functions/roles (by name) the session should be granted (default is all current functions). Cannot extend the current set of functions.
returns:{‘offset’: 718, ‘limit’: 660, ‘responseCode’: 200, ‘count’: 569, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Everything carry weight make operation new suffer.’, ‘messageTemplate’: ‘Out carry material right reach claim same.’, ‘field’: ‘Store reduce that recent again day.’, ‘parameter’: {}, ‘timestamp’: 215420883}], ‘currentPage’: 779, ‘size’: 256}

api.authentication.v1.impersonate module

Autogenerated API

api.authentication.v1.logout module

Autogenerated API

api.authentication.v1.logout.logout(json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Invalidate current user session (PUBLIC)

Returns:{}

api.authentication.v1.methods module

Autogenerated API

api.authentication.v1.methods.get_methods(argus_last_method: str = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

List authentication methods available on this server (PUBLIC) Returns a list of authentication methods available on the server. The last successful authentication performed on the client will be returned asmetaData.lastUsedAuthenticationMethod :rtype: dict :type authentication: dict :type apiKey: str :type verify: bool :type json: bool :type argus_last_method: str

param str argus_last_method:
 
returns:{}

api.authentication.v1.session module

Autogenerated API

api.authentication.v1.totp module

Autogenerated API

api.authentication.v1.totp.authenticate(userName: str = None, domain: str = None, password: str = None, tokenCode: str = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Initiate a new user session using TOTP authentication (PUBLIC) Requires TOTP authentication to be enabled on the server, and for the user. Use /methods to check which authentication methods are available on the server.

This is a 2-factor authentication method. The authentication request should carrythe username, the static password, and the TOTP token.. Tokens cannot be reused. Attempting to authenticate with a previously used token,will cause a challenge. Wait for the tokencode to change and resubmit. :rtype: dict :type authentication: dict :type apiKey: str :type verify: bool :type json: bool :type tokenCode: str :type password: str :type domain: str :type userName: str

param str userName:
 Username to authenticate
param str domain:
 User domain
param str password:
 Static Argus password
param str tokenCode:
 Current code from TOTP generator
raises AuthenticationFailedException:
 on 401
raises ValidationErrorException:
 on 412
raises AccessDeniedException:
 on 403
raises NotFoundException:
 on 404
returns:{‘offset’: 375, ‘limit’: 555, ‘responseCode’: 200, ‘count’: 280, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘White because American whose should project.’, ‘messageTemplate’: ‘Though rather protect.’, ‘field’: ‘Suffer economic which future example outside.’, ‘parameter’: {}, ‘timestamp’: 1044985641}], ‘currentPage’: 204, ‘size’: 770}
api.authentication.v1.totp.initialize(password: str = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Initiate a new TOTP generator for the user (PUBLIC) TOTP authentication requires a TOTP generator to be set up for the user.

This operation allows the user to set up a TOTP generator. This requires TOTP authentication to be enabled for the user. The TOTP initialization request also requires the user to providethe static Argus password for verification. The TOTP generator code retrieved cannot be retrieved again. It should be added directly to the TOTP generator, and should not be stored elsewhere.

After initializing, the new TOTP generator is in a pending state, and will notbe active until it is verified using the verification operation. :rtype: dict :type authentication: dict :type apiKey: str :type verify: bool :type json: bool :type password: str

param str password:
 User password to verify this request
raises AuthenticationFailedException:
 on 401
raises ValidationErrorException:
 on 412
raises AccessDeniedException:
 on 403
raises NotFoundException:
 on 404
returns:{‘offset’: 24, ‘limit’: 5, ‘responseCode’: 200, ‘count’: 422, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Kid fire agency walk.’, ‘messageTemplate’: ‘Require report check she.’, ‘field’: ‘Image run effort community production.’, ‘parameter’: {}, ‘timestamp’: 1386331995}], ‘currentPage’: 432, ‘size’: 0}
api.authentication.v1.totp.revoke(json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Revoke the current TOTP generator for the user (PUBLIC) This operation invalidates the current generator config for the user. The user will need to re-initialize the TOTP generator to be able to log inusing TOTP.

raises AuthenticationFailedException:
 on 401
raises ValidationErrorException:
 on 412
raises AccessDeniedException:
 on 403
raises NotFoundException:
 on 404
returns:{‘offset’: 174, ‘limit’: 377, ‘responseCode’: 200, ‘count’: 796, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Identify whom city PM western look far everyone.’, ‘messageTemplate’: ‘Hope space explain democratic official able.’, ‘field’: ‘East much generation couple court son traditional.’, ‘parameter’: {}, ‘timestamp’: 945863983}], ‘currentPage’: 280, ‘size’: 919}
api.authentication.v1.totp.verify(cookie: str = None, verificationCode: str = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Verify the pending TOTP generator for the user (PUBLIC) This operation will activate the pending generator.The verification request should contain the cookie returned from theinitialize command, as well as the current generated code.

If the user has an existing generator, successfully validatingthe pending generator will invalidate the existing generator. :rtype: dict :type authentication: dict :type apiKey: str :type verify: bool :type json: bool :type verificationCode: str :type cookie: str

param str cookie:
 The cookie returned by the TOTP initialization request
param str verificationCode:
 Current code from TOTP generator, to verify correctly generated TOTP code
raises AuthenticationFailedException:
 on 401
raises ValidationErrorException:
 on 412
raises AccessDeniedException:
 on 403
raises NotFoundException:
 on 404
returns:{‘offset’: 337, ‘limit’: 230, ‘responseCode’: 200, ‘count’: 43, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Spring should their again skin low.’, ‘messageTemplate’: ‘Class option somebody turn.’, ‘field’: ‘Month who chair Mr close meet.’, ‘parameter’: {}, ‘timestamp’: 1172167054}], ‘currentPage’: 48, ‘size’: 897}

Module contents