-
Notifications
You must be signed in to change notification settings - Fork 0
Securonix.CLI.Auth
Checks the validity of an API token with the Securonix Web API endpoint.
Confirm-SecuronixApiToken
[-Url] <string>
[-Token] <string>
Connection was set by Connect-SecuronixApi
Confirm-SecuronixApiToken
Confirm-SecuronixApiToken makes an API call to the AUTH/Validate Securonix Web API with the supplied token. If the token is valid, the API will respond with "Valid".
Request
Confirm-SecuronixApiToken -Url 'DunderMifflin.securonix.com/Snypr' -Token '12345678-90AB-CDEF-1234-567890ABCDEF'
Response
Valid
Confirm-SecuronixApiToken -Url 'DunderMifflin.securonix.com/Snypr' -Token '530bf219-5360-41d3-81d1-8b4d6f75956d'
Response
Invalid
Connect-SecuronixApi -Instance 'dundermifflin' `
-Username 'MichaelBolton' -Password 'PiEcEsOfFlAiR'
Confirm-SecuronixApiToken
Responses
Connected
Valid
Url endpoint for your Securonix instance. It must be in the following format:
https://<hostname or IPaddress>/Snypr
Valid authentication token.
Securonix 6.4 REST API Categories - Auth
Request a new API token from the Securonix Web API endpoint.
Connect-SecuronixApi
[-Url] <string>
[-Username] <string>
[-Password] <string>
[[-Validity] <int>]
Connect-SecuronixApi
[-Instance] <string>
[-Username] <string>
[-Password] <string>
[[-Validity] <int>]
Connect-SecuronixApi makes an API call to the AUTH/Generate Securonix Web API with the supplied credentials. If the user successfully authenticates, a token is provided and environment variables are set for later use.
Request
Connect-SecuronixApi -Instance 'dundermifflin' `
-Username 'MichaelBolton' -Password 'PiEcEsOfFlAiR'
Response
Connected
Url endpoint for your Securonix instance. It must be in the following format:
https://<hostname or IPaddress>/Snypr
Subdomain for your Securonix instance.
Username for the account.
Password for the account.
The number of days the token will be valid.
If unspecified, the default length is 365 days.
Securonix 6.4 REST API Categories - Auth
Request a new API token from the Securonix Web API endpoint.
New-SecuronixApiToken
[-Url] <string>
[-Username] <string>
[-Password] <string>
[[-Validity] <int>]
New-SecuronixApiToken makes an API call to the AUTH/Generate Securonix Web API with the supplied credentials. If the user successfully authenticates, a token is provided.
Request
New-SecuronixApiToken -Url 'DunderMifflin.securonix.com/Snypr' -Username 'JimHalpert' -Password 'sEcUrEpAsSwOrD'
Response
530bf219-5360-41d3-81d1-8b4d6f75956d
New-SecuronixApiToken -Url 'Initech.securonix.com/Snypr' -Username 'MichaelBolton' -Password 'PiEcEsOfFlAiR' -Validity 31
Response
12345678-90AB-CDEF-1234-567890ABCDEF
Url endpoint for your Securonix instance. It must be in the following format:
https://<hostname or IPaddress>/Snypr
Username for the account.
Password for the account.
The number of days the token will be valid.
If unspecified, the default length is 365 days.
Securonix 6.4 REST API Categories - Auth
Renews existing authentication token.
Update-SecuronixApiToken
[-Url] <string>
[-Token] <string>
Connection was set by Connect-SecuronixApi
Update-SecuronixApiToken
Update-SecuronixApiToken makes an API call to the AUTH/Renew Securonix Web API to renew the supplied token. If the token was renewed, the API will respond with "Success".
Request
Update-SecuronixApiToken -Url 'DunderMifflin.securonix.com/Snypr' -Token '12345678-90AB-CDEF-1234-567890ABCDEF'
Response
Success
Update-SecuronixApiToken -Url 'DunderMifflin.securonix.com/Snypr' -Token '530bf219-5360-41d3-81d1-8b4d6f75956d'
Response
Failure
Connect-SecuronixApi -Instance 'dundermifflin' `
-Username 'MichaelBolton' -Password 'PiEcEsOfFlAiR'
Update-SecuronixApiToken
Responses
Connected
Success
Url endpoint for your Securonix instance. It must be in the following format:
https://<hostname or IPaddress>/Snypr
Valid authentication token.