Authentication

To do most tasks in TestEngine, you must authenticate yourself. This topic describes how you can do this.

Basic authentication

In basic authentication, you must provide your Base64-encoded login and password in the Authorization header. For example:

Authorization: Basic dXNlcjpwYXNzd29yZA==

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 "user:password" -X GET "http://localhost:8080/api/v1/testjobs"

Access token

When you use an access token, you authenticate your requests with a token issued by TestEngine. This authentication is more secure since you do not provide your credentials with every request.

The access token does not have an expiration date. If you need 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://<testengine-host>:8080/api/v1/token
```
Authentication
The request must be authenticated by a TestEngine user. TestEngine will issue the access token for the authenticated user.
TestEngine responds with a JSON object containing the access token:
JSON
```
{
    "token": "37YkM3l4KQijXxv320HD_n4G2Dc"
}
```
Specify the Authorized: Bearer <access token> header to authenticate a request. See the examples below.

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

To authenticate requests by using an access token:

Request an access token by using the following command:
```
curl -u "user:password" -X POST "http://localhost:8080/api/v1/token"
```
In this example:
-u user:password
Authenticates the request using the user's credentials.
-X POST
Specifies the POST method.
"http://localhost:8080/api/v1/token"
The endpoint of the request.
The response will contain the issued access token.
Specify the Authorization header with the access token. For example, to get a list of test jobs, use the following command:
```
curl -H "Authorization: Bearer 37YkM3l4KQijXxv320HD_n4G2Dc" -X GET "http://localhost:8080/api/v1/testjobs"
```

To authenticate requests by using an access token:

Get an access token:
1. 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.
2. Select the POST request to the /api/v1/token resource:
3. Open the Auth panel.
4. Select the Basic (Built-in) authorization type.
  Tip
  If you use the same credentials in several requests, use authorization profiles.
5. Specify user credentials and select the Authenticate pre-emptively option:
6. Send the request:
7. If the operation was successful, the response will contain 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://<testengine-host>: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\":\"37YkM3l4KQijXxv320HD_n4G2Dc\"}" "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