Fetch Authentication Token

POST/auth

You must authenticate to the Qualys Cloud Platform using Qualys account credentials (username and password) and get the JSON Web Token (JWT) before you can start using the OCA APIs.

The Authentication API returns a JSON Web Token (JWT) which you can use for authentication during OCA API calls. The token expires in 4 hours. You must regenerate the token to continue using the OCA API.

HTTP Status Code

- 201: Created

- 401: Unauthorized user

- 404: Not Found

Input ParametersInput Parameters

Parameter	Mandatory /Optional	Data Type	Description
username	Mandatory	String	The username of the Qualys user account for which you want to fetch OCA data.
password	Mandatory	String	The password of the Qualys user account for which you want to fetch OCA data.
token	Mandatory	Boolean	The value must be set to True, to get the generated token.
ContentType	Mandatory	Text	It must be "application/x-www-form-urlencoded".
gateway.qg1.apps.qualys.com	Mandatory	URL	The API gateway URL to the Qualys API server where your account is located.

SampleSample

Request

curl -X POST 'https://<api_gateway_url>/auth' -d 'username=username&password=password&token=true' -H 'ContentType: application/x-www-form-urlencoded'

Response

kyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJxdWF5c19hdzM5IiwibG9naW5SZXNwb25zZSI6IlNVQ0NFU1NGVUwiLCJzdWNjZXNzZnVsQXV0aGVudGljYXRpb25IYW5kbGVycyI6WyJBdXRoSGFuZGxlcjJdLCJpc3MiOiJxYXMiLCJpcEFkZHJlc3MiOiIxMC4wLjIwMy4xODQiLCJwb3J0YWxVc2VySWQiOjIzODczNDU1NCwidXNlcnR5cGUiOiJmbyIsInF3ZWJVc2VySWQiOjM0NzkwMjYsImNyZWRlbnRpYWxUeXBlIjoiPRRzZXJuYW1lUGFzc3dvcmRDcmVkZW50aWFsIiwiYXVkIjoicWFzIiwibW9kdWxlc0FsbG93ZWQiOlsiQURNSV4iLCJBU1NFVCBJTlZFTlRPUlkiLCJDRVJUVklFVyItIkZSRUUgQUdFTlQiLCJQQyBTQ0FOTkVSIiwiUFMiLCJRR1MiLCJDQSIsIkNFUlRfVklFVyIsIktCWCIsIk9DQSIsIlBPUlRBTCBUQUdHSU5HIiwiVEhSRUFUIFBST1RFQ1QiLCJWTEFOIiwiVk0gQUdFTlQiLCJQQVNTSVZFX1NDQU5ORVIiLAJSRVBPUlQgQ0VOVEVSIiwiU0NBX0FHRU5UIiwiVk0gU0NBTk5FUiIsIkNTIiwiVEhSRUFUX1BST1RFQ1QiLCJWSVJUVUFMIFNDQU5ORVIiLCJWTSIsIkFQSSIsIkNPTlRBSU5FUl9TRUAVUklUWSIsIkVDMiIsIkdMT0JBTF9BSV9DTURCX1NZTkMiLCJDTE9VRFZKRVciLCJDTSJsIlBNIiwiU0NBTiBCWSBIT1NUTkFNRSIsIkFTU0VUX01BTkFHRU1FTlQiLCJDT05USU5VT1VTIE1PTklUT1JJTkciLCJJVEFNIiwiUEMiLCJQQ0kiLCJRV0VCX1ZNIiwiU0VNIiwiU0VDVVJFQ09ORklHIl0sImF1dGhlbnRpY2F0aW9uTWV0aG9kIjoiQXV0aEhhbmRsZXIiLCJjdXN0d21lcklkIjoxNDAzMjIyLCJzZXNzaW9uRXhwaXJhdGlvbiI6IjYwIiwidXNlclV1aWQiOiI0YzhhMmYzNi1hZGNlLTU3NmYtODE1ZC1jNDFlZjUwOGNlNzAiLCJzdWJzY3JpcHRpb25Vd3lkIjoiNmUyZjAwZDQtNGY2NS1jYjU2LTgyYjctNDk2NzlkMGFmMjRhIiwiaXNUZ3RFeHBpcmVkIjoidHJ1ZSIsInN1YnNjcmlwdGlvbklkIjoxODYwOTgzLCJleHAiOjE1ODk4OTYyMjRsImlhdCI6MTU4OTg4MTgyMSwianRpIjoiVEdULTEtenQ5N20wVjlwZWlPSk1COENYT0ttamZHSENNelZHdE9icGdOaEZpWGE0UHpaSmpPSm9KSjBKSC1obDRCdXBSaHFYRS1xYXMwMSK9.xbJrVhgdxj8A0LkiPMRWNgGiuqtI954ccpNBx1CvZVEcvIFUJ43kdw81KZIoL8Mm8qrq0f1DjhIDDz83gClZWw