Authentication

Most tasks in TestEngine require authentication. This topic describes how to authenticate.

Basic authentication

Basic authentication requires your Base64-encoded username and password in the Authorization header. For example:

Authorization: Basic <base64-encoded-credentials>

To apply the basic authentication, use the -u "<username>:<password>" argument. For example, to get a list of test jobs, use the following command:

curl -u "username: password" -X GET "http://localhost:8080/api/v1/testjobs"

Access token

An access token lets you authenticate requests with a token issued by TestEngine. This method is more secure because you do not provide your credentials with every request.

The access token has no expiration date. To reset the token, revoke it manually.

To authorize requests with an access token:

Get an access token by using the following operation:
```
POST  http://localhost:8080/api/v1/token
```
Authentication requires a TestEngine user. TestEngine issues the access token for the authenticated user.
TestEngine responds with a JSON object containing the access token:
JSON
```
{
    "token": "<access-token>"
}
```
Specify the Authorized: Bearer <access token> header to authenticate a request. See the examples below.

See the Generate Token section in the ReadyAPI TestEngine API on SwaggerHub for details..

To authenticate requests by using an access token:

Get an access token using the following command:
```
curl -u "username:password" -X POST "http://localhost:8080/api/v1/token"
```
In this example:
-u username:password
Your credentials, which are used to authenticate the request
-X POST
Specifies the POST method.
"http://localhost:8080/api/v1/token"
The endpoint that issues the access token.
The response contains the issued access token.
Specify the Authorization: Bearer header. For example, to get a list of test jobs, use the following command:
```
curl -H "Authorization: Bearer <access-token>" -X GET "http://localhost:8080/api/v1/testjobs"
```

To authenticate requests using an access token:

Get an access token:
1. Create a project using the TestEngine API definition. See Create Projects for details.
  Tip
  You can also create the needed request from scratch.
2. Select the POST request to the /api/v1/token resource.
3. Open the Auth panel and select the Basic (Built-in) authorization type.
  Tip
  If you use the same credentials in several requests, use authorization profiles.
4. Specify user credentials and select the Authenticate pre-emptively option.
5. Send the request.
  If successful, the response contains an access token.
Use the access token to send a request:
1. Open the request you want to send. For example, the GET request to the /api/v1/testjobs resource.
2. Add the Authorization parameter and set its type to HEADER.
3. Specify Bearer <access token> for the parameter’s value.
4. Send the request.

Revoke an access token

Revoke a single access token

Use the following operation:

DELETE  http://localhost:8080/api/v1/token/

See details on SwaggerHub in the ReadyAPI TestEngine API – Delete Token section.

Use the following command line:

curl -u "user:password" -X DELETE -d "{\"token\":\"<access-token>"}" "http://localhost:8080/api/v1/token"

In this example:

Create a project by using the TestEngine API definition. See Creating Project From OpenAPI/Swagger Definition to learn how to do it.
Tip
You can also create the needed request from scratch.
Select the DELETE request to the /api/v1/token resource.
Enter the new password in a JSON body.
```
{
  "password": "string",
}
```
Open the Auth panel.
Select the Basic (Built-in) authorization type.
Tip
If you use the same credentials in several requests, use authorization profiles.
Specify user credentials and select the Authenticate pre-emptively option:
Send the request.

Revoke all your access tokens