UserApi

All URIs are relative to http://localhost:8443

Method	HTTP request	Description
assignUserTeam	POST /api/v1/users/add	Adds users to a Team. Returns the added User detail.
changeAvatar	POST /api/v1/users/avatar	Change the avatar of the current User. Returns the updated User detail.
changeName	POST /api/v1/users	Change name for current user.
createOrUpdate2	POST /api/v1/user-settings	Updates the User Settings detail. Returns the updated User Settings detail.
downloadAvatar	GET /api/v1/users/avatar	Downloads the avatar of the current User. Returns the current avatar file.
get10	GET /api/v1/user-settings	Returns the User Settings detail.
getMe	GET /api/v1/users/me	Returns the current User detail.
removeUser	DELETE /api/v1/users/remove	Removes a User from a Team. Returns the removed User detail.

assignUserTeam

List<UserResource> assignUserTeam(teamId, newUserIds)

Adds users to a Team. Returns the added User detail.

The user issuing this request must be the Admin of the team.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.UserApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        UserApi apiInstance = new UserApi(defaultClient);
        Long teamId = 56L; // Long | 
        List<Long> newUserIds = Arrays.asList(); // List<Long> | 
        try {
            List<UserResource> result = apiInstance.assignUserTeam(teamId, newUserIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#assignUserTeam");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
teamId	Long
newUserIds	List<Long>

Return type

List<UserResource>

Authorization

basicScheme

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

changeAvatar

UserResource changeAvatar(uploadedPath)

Change the avatar of the current User. Returns the updated User detail.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.UserApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        UserApi apiInstance = new UserApi(defaultClient);
        String uploadedPath = "uploadedPath_example"; // String | 
        try {
            UserResource result = apiInstance.changeAvatar(uploadedPath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#changeAvatar");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
uploadedPath	String

Return type

UserResource

Authorization

basicScheme

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

changeName

UserResource changeName(firstName, lastName)

Change name for current user.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.UserApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        UserApi apiInstance = new UserApi(defaultClient);
        String firstName = "firstName_example"; // String | 
        String lastName = "lastName_example"; // String | 
        try {
            UserResource result = apiInstance.changeName(firstName, lastName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#changeName");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
firstName	String
lastName	String

Return type

UserResource

Authorization

basicScheme

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

createOrUpdate2

UserSettingResource createOrUpdate2(userSettingResource)

Updates the User Settings detail. Returns the updated User Settings detail.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.UserApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        UserApi apiInstance = new UserApi(defaultClient);
        UserSettingResource userSettingResource = new UserSettingResource(); // UserSettingResource | 
        try {
            UserSettingResource result = apiInstance.createOrUpdate2(userSettingResource);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#createOrUpdate2");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
userSettingResource	UserSettingResource

Return type

UserSettingResource

Authorization

basicScheme

HTTP request headers

Content-Type: application/json
Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

downloadAvatar

downloadAvatar()

Downloads the avatar of the current User. Returns the current avatar file.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.UserApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        UserApi apiInstance = new UserApi(defaultClient);
        try {
            apiInstance.downloadAvatar();
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#downloadAvatar");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

basicScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

get10

UserSettingResource get10()

Returns the User Settings detail.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.UserApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        UserApi apiInstance = new UserApi(defaultClient);
        try {
            UserSettingResource result = apiInstance.get10();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#get10");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

UserSettingResource

Authorization

basicScheme

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

getMe

UserResource getMe()

Returns the current User detail.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.UserApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        UserApi apiInstance = new UserApi(defaultClient);
        try {
            UserResource result = apiInstance.getMe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getMe");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

UserResource

Authorization

basicScheme

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

removeUser

UserResource removeUser(teamId, userId)

Removes a User from a Team. Returns the removed User detail.

The user issuing this request must be the Admin of the team.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.UserApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        UserApi apiInstance = new UserApi(defaultClient);
        Long teamId = 56L; // Long | 
        Long userId = 56L; // Long | 
        try {
            UserResource result = apiInstance.removeUser(teamId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#removeUser");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
teamId	Long
userId	Long

Return type

UserResource

Authorization

basicScheme

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	OK	-

Uh oh!

FilesExpand file tree

UserApi.md

Latest commit

History

UserApi.md

File metadata and controls

UserApi

assignUserTeam

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

changeAvatar

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

changeName

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createOrUpdate2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

downloadAvatar

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get10

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getMe

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

removeUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details