Manage Users

To create a user by using the TestEngine API, you need to send the following request:

See details on SwaggerHub.

Example

ExampleHide example

• curl
• ReadyAPI

curl -H "Content-Type: application/json" -d @user.json -u user:password -X POST "http://localhost:8080/api/v1/users"

In this example:

-H "Content-Type: application/json"

Specifies the Content-Type header that tells TestEngine the type of the payload content.

-d @user.json

Specifies payload for the request. This example refers to the user.json file containing the required data.

-u user:password

Authenticates the request with the user’s credentials. This user must have admin permissions.

-X POST

Specifies the POST method.

"http://localhost:8080/api/v1/users"

The endpoint of the request.

Tip:	We recommend that you create a project using the TestEngine Swagger definition. It will make request creation easier. Otherwise, create the needed request from scratch.

1. Select the POST request to the /users resource:

   

   Click the image to enlarge it.

2. Specify payload for the request.

   

   Click the image to enlarge it.

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 admin credentials and select the Authenticate pre-emptively option:

   

   Click the image to enlarge it.

6. Send the request:

   

   Click the image to enlarge it.

1. Log in to the TestEngine web interface under a user account with administrator permissions.

2. Open the user menu and select Manage Users:

   

   Click the image to enlarge it.

3. Click Add User:

   

   Click the image to enlarge it.

4. Specify the username and password.

5. If you want to grant administrator permissions, select the Administrator option.

6. Click Save:

   

   Click the image to enlarge it.

To deactivate a user by using the TestEngine API, you need to send the following request:

See details on SwaggerHub.

Example

ExampleHide example

• curl
• ReadyAPI

curl -u user:password -X DEACTIVATE "http://localhost:8080/api/v1/users/john.smith"

In this example:

-u user:password

Authenticates the request with the user’s credentials. This user must have admin permissions.

-X DEACTIVATE

Specifies the DEACTIVATE method.

"http://localhost:8080/api/v1/users/john.smith"

The endpoint of the request. In this example, “john.smith” is the name of the user to deactivate.

Tip:	We recommend that you create a project using the TestEngine Swagger definition. It will make request creation easier. Otherwise, create the needed request from scratch.

1. Select the DEACTIVATE request to the /users/{username} resource:

   

   Click the image to enlarge it.

2. Specify the name of the user you want to deactivate as the value of the username parameter:

   

   Click the image to enlarge it.

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 admin credentials and select the Authenticate pre-emptively option:

   

   Click the image to enlarge it.

6. Send the request:

   

   Click the image to enlarge it.

1. Log in to the TestEngine web interface under a user account with administrator permissions.

2. Open the user menu and select Manage Users:

   

   Click the image to enlarge it.

3. Click :

   

   Click the image to enlarge it.

4. Click OK to confirm the deletion:

   

   Click the image to enlarge it.

To modify a user by using the TestEngine API, you need to send the following request:

PUT  http://<testengine-host>:8080/api/v1/users/{username}

{username}

The name of the user you want to edit.

Body

A JSON object containing data of the user. Skip the elements you do not want to change:

Element	Description
password	String. Specifies the new password of the user.
admin	Boolean. Specify true to grant the user administrator permissions. Otherwise, specify false.

For example:

{
    "password": "new-p@ssw0rd",
    "admin": true
}

Authentication

The request must be authenticated by a TestEngine administrator.

--or--

The request must be authenticated by a TestEngine user to change their own password.

See details on SwaggerHub.

Example

ExampleHide example

• curl
• ReadyAPI

curl -H "Content-Type: application/json" -d @user.json -u user:password -X PUT "http://localhost:8080/api/v1/users/john.smith"

In this example:

-H "Content-Type: application/json"

Specifies the Content-Type header that tells TestEngine the type of the payload content.

-d @user.json

Specifies payload for the request. This example refers to the user.json file containing the required data.

-u user:password

Authenticates the request with the user’s credentials. This user must have admin permissions.

-X PUT

Specifies the PUT method.

"http://localhost:8080/api/v1/users/john.smith"

The endpoint of the request. In this example, “john.smith” is the name of the user to be updated.

Tip:	We recommend that you create a project using the TestEngine Swagger definition. It will make request creation easier. Otherwise, create the needed request from scratch.

1. Select the PUT request to the /users/{username} resource:

   

   Click the image to enlarge it.

2. Specify the name of the user you want to modify as the value of the username parameter:

   

   Click the image to enlarge it.

3. Specify payload for the request:

   

   Click the image to enlarge it.

4. Open the Auth panel.

5. Select the Basic (Built-in) authorization type.

   Tip:	If you use the same credentials in several requests, use authorization profiles.

6. Specify admin credentials or the credentials of the user whose password you want to change. Select the Authenticate pre-emptively option:

   

   Click the image to enlarge it.

7. Send the request:

   

   Click the image to enlarge it.

1. Log in to the TestEngine web interface under a user account with administrator permissions.

2. Open the user menu and select Manage Users:

   

   Click the image to enlarge it.

3. Click :

   

   Click the image to enlarge it.

4. Change the password and/or the type of the user.

5. Click Save:

   

   Click the image to enlarge it.

To view TestEngine users, send the following request:

• To get a list of all users:

  GET  http://<testengine-host>:8080/api/v1/users

• To get data about a particular user:

  GET  http://<testengine-host>:8080/api/v1/users/{username}

{username}

The name of the user information about whom you want to get.

Authentication

The request must be authenticated by a TestEngine administrator.

--or--

The request must be authenticated by a TestEngine user to get their own information.

See details on SwaggerHub.

Example

ExampleHide Example

• curl
• ReadyAPI

curl -u user:password -X GET "http://localhost:8080/api/v1/users/john.smith"

In this example:

-u user:password

Authenticates the request with the user’s credentials. This user must have admin permissions or request its own data.

-X GET

Specifies the GET method.

"http://localhost:8080/api/v1/users/john.smith"

The endpoint of the request. In this example, “john.smith” is the name of the user to be updated.

Tip:	We recommend that you create a project using the TestEngine Swagger definition. It will make request creation easier. Otherwise, create the needed request from scratch.

1. Select the GET request to the /users/ or /users/{username} resource:

   

   Click the image to enlarge it.

2. If you select the /users/{username} resource, specify the name of the user you want to get:

   

   Click the image to enlarge it.

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 admin credentials or the credentials of the user whose data you want to get. Select the Authenticate pre-emptively option:

   

   Click the image to enlarge it.

6. Send the request:

   

   Click the image to enlarge it.