QaCONNECT REST API :: Access Keys to pass as inputs to your REST calls
When you make calls to the REST API, you must pass a secure “access key”.
The access key is generated at your domain level. In one of the upcoming future releases, we will allow for each user within your domain to have a separate access key.
The access key is generated at your domain level. In one of the upcoming future releases, we will allow for each user within your domain to have a separate access key.
Access Key needs to be passed as one of the inputs to your REST calls instead of a user’s Worksoft SaaS password, for security reasons (The password for logging into Worksoft SaaS application does not have to be used within apps/CI tools that integrate with QaCONNECT REST API).
All users within your domain that have a role of ‘Customer Admin’’ will be able to copy the ‘access key’ from a screen that is accessible the main menu item “More” and sub-menu item captioned “Domain Info” [when you are in the context of “Administration” module within your domain (Project Selector dropdown on the top right is set to “Administration”)].
How can you get/generate the access to to be used for your Domain?
If you currently use an external Selenium Cloud Platform like Sauce Labs, you can enter the access key that you currently use with Sauce Labs.
If you do NOT use an external Selenium Cloud Platform like Sauce Labs, but use Worksoft SaaS Cloud, for all your executions, Worksoft SaaS will automatically pre-generate and store the access key for your domain. The access can be copied from the 'Domain Info' screen.
One of your domain’s ‘Customer Admin’ role users must:
How can you get/generate the access to to be used for your Domain?
If you currently use an external Selenium Cloud Platform like Sauce Labs, you can enter the access key that you currently use with Sauce Labs.
If you do NOT use an external Selenium Cloud Platform like Sauce Labs, but use Worksoft SaaS Cloud, for all your executions, Worksoft SaaS will automatically pre-generate and store the access key for your domain. The access can be copied from the 'Domain Info' screen.
One of your domain’s ‘Customer Admin’ role users must:
1. Visit the “Domain Info” screen and copy the 'Access Key'.
2. Share the “access key” with other users within your domain, especially those that will be tasked to use QaCONNECT REST APIs, so that they can use the access key when accessing REST API.
How can you change the access that is be used within your Domain when QaCONNECT REST API calls are used?
2. Share it with users within your domain, especially those that will be tasked to use QaCONNECT REST APIs, so that they can use the access key when accessing REST API.
How can you change the access that is be used within your Domain when QaCONNECT REST API calls are used?
If you need to regenerate the access key for some reason (for example one your employees leaves the company and you want to make sure that that employee cannot continue to use the access key when he leaves your company), you can follow the same steps to regenerate the key.
1. On the 'Domain Info' screen, click on the “Generate new access key” to generate a key, and2. Share it with users within your domain, especially those that will be tasked to use QaCONNECT REST APIs, so that they can use the access key when accessing REST API.