Authentication API
The authentication API provides an authentication token to ensure an authorized user has access permissions. To use the Configuration Profile APIs through a command line, you must have Qualys credentials and JSON Web Token (JWT).
To generate the JWT token, execute the Authentication API. The API response for Authentication API contains the required JWT token. Use this JWT token as an authentication criterion for configuration profile APIs.
Permissions required: Managers with full scope. Other users must have requested an asset in their scope and have these permissions: Access Permission API Access and create, view, and edit configuration profile permissions.
The JWT token generated using Authentication API is valid for only four hours. However, if the JWT token is expired, you can again execute the Authentication API.
Input ParametersInput Parameters
Provide the Qualys Credentials such as user ID and password to use this API.
Sample - Get JWT Token using Qualys CredentialsSample - Get JWT Token using Qualys Credentials
API Request
curl --location '<qualys_base_url>/auth' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=qualys_ab12' \
--data-urlencode 'password=pass_12' \
--data-urlencode 'token=true'
API Response
eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJxdWF5c19tazQ2IiwiaXNzIjoicWFzIiwicG9ydGFsVXNlcklkIjo3Mjg4MDM4NjEsImN1c3RvbWVyVXVpZCI6IjlkNWI1ZGQ2LWYzYmQtZGU1Zi04MDY4LTk5OWMyYzcyMWI3YSIsIm1vZHVsZXNBbGxvd2VkIjpbIkFTU0VUIElOVkVOVE9SWSIsIkVDMiIsIktCWCIsIlJFUE9SVCBDRU5URVIiLCJTV0NBIiwiQURNSU4iLCJBR0VOVF9DQVBTIiwiRklNIiwiUVdFQl9WTSIsIkNPTlRJTlVPVVMgTU9OSVRPUklORyIsIkZEQ0MiLCJGUkVFIEFHRU5UIiwiUEMgQUdFTlQiLCJQQyBTQ0FOTkVSIiwiUUNBUFMiLCJTRUNVUkVDT05GSUciLCJVRCIsIlZNIiwiQVNTRVRfTUFOQUdFTUVOVCIsIk9DQSIsIlBTIiwiU0VDVVJJVFlfQU5BTFlUSUNTIiwiVk0gSU5URVJOQUwiLCJDTE9VRFZJRVciLCJHTE9CQUxfQUlfQ01EQl9TWU5DIiwiUE0iLCJQT1JUQUwgVEFHR0lORyIsIlNDQU4gQlkgSE9TVE5BTUUiLCJTRU0iLCJWTSBQRVJJTUVURVIiLCJDT05UQUlORVJfU0VDVVJJVFkiLCJJQ1MiLCJJUHY2IiwiTE9HX0NPTExFQ1RPUiIsIlBDIiwiUUdTIiwiUU1JIiwiU0NBX0FHRU5UIiwiU00iLCJVTklGSUVEX0RBU0hCT0FSRCIsIlZMQU4iLCJWTSBBR0VOVCIsIklPQyIsIklUQU0iLCJQQ0kiLCJRV0VCX1BDIiwiVEhSRUFUIFBST1RFQ1QiLCJUSFJFQVRfUFJPVEVDVCIsIlZJUlRVQUwgU0NBTk5FUiIsIldBUyIsIkFQSSIsIkNBIiwiQ00iLCJDUyIsIkxNIiwiTE9HIE1BTkFHRU1FTlQiLCJQQVNTSVZFX1NDQU5ORVIiLCJWTSBTQ0FOTkVSIl0sImN1c3RvbWVySWQiOjE1OTQ0MjEsInNlc3Npb25FeHBpcmF0aW9uIjoiNjAiLCJqd3RFeHBpcnlNaW51dGUiOiIyNDAiLCJleHAiOjE3MTc0Mzk4NTQsImlhdCI6MTcxNzQyNTQ1NCwianRpIjoiVEdUMTMwMzUtR3ZxaGRsQkZLZmNMc2FiVFJpZXNSWkRWYWRTa0h5bWF2YllQS0xGS0hPakVxTlNUZ2t4T1JkdXZ3Z3FwRWJ0Ri1xYXMtNmNiOWY2NTdiNS1kN2M5aCIsImxvZ2luUmVzcG9uc2UiOiJTVUNDRVNTRlVMIiwiYXV0aGVudGljYXRpb25EYXRlIjpbMTcxNzQyNTQ1NDIxMF0sInN1Y2Nlc3NmdWxBdXRoZW50aWNhdGlvbkhhbmRsZXJzIjpbIkF1dGhIYW5kbGVyIl0sImlwQWRkcmVzcyI6IjEwLjExOS4yMTQuNDEiLCJ1c2VydHlwZSI6ImZvIiwicXdlYlVzZXJJZCI6OTc2NjAxLCJjcmVkZW50aWFsVHlwZSI6IlFVc2VybmFtZVBhc3N3b3JkQ3JlZGVudGlhbCIsImF1ZCI6InFhcyIsImF1dGhlbnRpY2F0aW9uTWV0aG9kIjoiQXV0aEhhbmRsZXIiLCJ1c2VyVXVpZCI6IjkyODBiOGRkLTE3YTEtNmExOS04MWYwLTI3YmJlMzA0OGNjNCIsInN1YnNjcmlwdGlvblV1aWQiOiI5ZDViNWRkNi1mM2JkLWRlNWYtODA2OC05OTljMmM3MjFiN2EiLCJpc1RndEV4cGlyZWQiOiJ0cnVlIiwic3Vic2NyaXB0aW9uSWQiOjEwNTc5MDZ9._CHy938at54f3wcB83gNEILQT70fDJHlpIpJ6QDfuV9X6zqYWz0jGHccpVRxux5zV89jPx5Y-NTjqUKCu9NGxQ