api.authentication.v1 package¶
Subpackages¶
Submodules¶
api.authentication.v1.apikey module¶
Autogenerated API
-
api.authentication.v1.apikey.
authenticate
(apikey: str = None, json: bool = True, verify: bool = True, apiKey: str = '', 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.
Return type: dict
-
api.authentication.v1.apikey.
initiate
(password: str = None, description: str = None, validSources: <function list at 0x1063a7e18> = None, expirationDays: int = None, json: bool = True, verify: bool = True, apiKey: str = '', 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- NotFoundException – on 404
Returns: {“offset”: 310, “limit”: 795, “responseCode”: 200, “count”: 279, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Do special there window newspaper.”, “messageTemplate”: “Speak throughout let capital discuss treatment.”, “field”: “Reality prevent public then myself indicate radio.”, “parameter”: {}, “timestamp”: 596866863}], “currentPage”: 418, “size”: 393}
-
api.authentication.v1.apikey.
list
(json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ List current user apikeys (PUBLIC)
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- NotFoundException – on 404
Returns: {“offset”: 957, “limit”: 564, “responseCode”: 200, “count”: 456, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Maybe strong speech direction.”, “messageTemplate”: “Analysis development brother boy almost guess.”, “field”: “Rest heavy provide money of.”, “parameter”: {}, “timestamp”: 660335617}], “currentPage”: 209, “size”: 172}
-
api.authentication.v1.apikey.
renew
(keyID: int, password: str = None, expirationDays: int = None, json: bool = True, verify: bool = True, apiKey: str = '', 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.
Return type: dict
-
api.authentication.v1.apikey.
revoke
(keyID: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Revoke an apikey from current user (PUBLIC)
Return type: dict
Parameters: keyID (int) – Key ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- NotFoundException – on 404
Returns: {“offset”: 731, “limit”: 748, “responseCode”: 200, “count”: 565, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Daughter second particularly image.”, “messageTemplate”: “Part speech often sometimes appear continue arrive.”, “field”: “New today in challenge fill ability know lead.”, “parameter”: {}, “timestamp”: 966999637}], “currentPage”: 637, “size”: 761}
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 = '', 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.
Return type: dict
api.authentication.v1.impersonate module¶
Autogenerated API
api.authentication.v1.logout module¶
Autogenerated API
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 = '', 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
Return type: dict
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 = '', 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.
Return type: dict
-
api.authentication.v1.totp.
initialize
(password: str = None, json: bool = True, verify: bool = True, apiKey: str = '', 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.
Return type: dict
-
api.authentication.v1.totp.
revoke
(json: bool = True, verify: bool = True, apiKey: str = '', 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”: 786, “limit”: 532, “responseCode”: 200, “count”: 334, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Tough exist have very.”, “messageTemplate”: “Identify girl clearly major.”, “field”: “Act player be travel blood.”, “parameter”: {}, “timestamp”: 463633973}], “currentPage”: 942, “size”: 668}
-
api.authentication.v1.totp.
verify
(cookie: str = None, verificationCode: str = None, json: bool = True, verify: bool = True, apiKey: str = '', 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.
Return type: dict