AccountGroupsApi

All URIs are relative to https://api.thousandeyes.com/v7

Method	HTTP request	Description
createAccountGroup	POST /account-groups	Create account group
createAccountGroupWithHttpInfo	POST /account-groups	Create account group
deleteAccountGroup	DELETE /account-groups/{id}	Delete account group
deleteAccountGroupWithHttpInfo	DELETE /account-groups/{id}	Delete account group
getAccountGroup	GET /account-groups/{id}	Retrieve account group
getAccountGroupWithHttpInfo	GET /account-groups/{id}	Retrieve account group
getAccountGroups	GET /account-groups	List account groups
getAccountGroupsWithHttpInfo	GET /account-groups	List account groups
updateAccountGroup	PUT /account-groups/{id}	Update account group
updateAccountGroupWithHttpInfo	PUT /account-groups/{id}	Update account group

createAccountGroup

CreatedAccountGroup createAccountGroup(accountGroupRequest, expand)

Create account group

Creates a new account group. This operation requires the `Edit all account groups` permission. Note: Any user assigned to `All Account Groups` is automatically assigned to the new account group.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        AccountGroupRequest accountGroupRequest = new AccountGroupRequest(); // AccountGroupRequest | 
        List<ExpandAccountGroupOptions> expand = Arrays.asList(); // List<ExpandAccountGroupOptions> | Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
        try {
            CreatedAccountGroup result = apiInstance.createAccountGroup(accountGroupRequest, expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#createAccountGroup");
            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
accountGroupRequest	AccountGroupRequest
expand	List<ExpandAccountGroupOptions>	Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.	[optional]

Return type

CreatedAccountGroup

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
201	Created	* Location -
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

createAccountGroupWithHttpInfo

ApiResponse createAccountGroup createAccountGroupWithHttpInfo(accountGroupRequest, expand)

Create account group

Creates a new account group. This operation requires the `Edit all account groups` permission. Note: Any user assigned to `All Account Groups` is automatically assigned to the new account group.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.common.ApiResponse;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        AccountGroupRequest accountGroupRequest = new AccountGroupRequest(); // AccountGroupRequest | 
        List<ExpandAccountGroupOptions> expand = Arrays.asList(); // List<ExpandAccountGroupOptions> | Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
        try {
            ApiResponse<CreatedAccountGroup> response = apiInstance.createAccountGroupWithHttpInfo(accountGroupRequest, expand);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#createAccountGroup");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
accountGroupRequest	AccountGroupRequest
expand	List<ExpandAccountGroupOptions>	Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.	[optional]

Return type

ApiResponse<CreatedAccountGroup>

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
201	Created	* Location -
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

deleteAccountGroup

void deleteAccountGroup(id)

Delete account group

Deletes an account group using its ID. This operation requires the following permissions: * Assign management permissions * Delete account * Edit all account groups

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        String id = "1234"; // String | Identifier for the account group.
        try {
            apiInstance.deleteAccountGroup(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#deleteAccountGroup");
            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
id	String	Identifier for the account group.

Return type

null (empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
204	No content	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

deleteAccountGroupWithHttpInfo

ApiResponse deleteAccountGroup deleteAccountGroupWithHttpInfo(id)

Delete account group

Deletes an account group using its ID. This operation requires the following permissions: * Assign management permissions * Delete account * Edit all account groups

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.common.ApiResponse;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        String id = "1234"; // String | Identifier for the account group.
        try {
            ApiResponse<Void> response = apiInstance.deleteAccountGroupWithHttpInfo(id);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#deleteAccountGroup");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	Identifier for the account group.

Return type

ApiResponse

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
204	No content	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

getAccountGroup

AccountGroupDetail getAccountGroup(id, expand)

Retrieve account group

Retrieves detailed information about an account group using its ID. This operation requires the `View all account groups settings` permission.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        String id = "1234"; // String | Identifier for the account group.
        List<ExpandAccountGroupOptions> expand = Arrays.asList(); // List<ExpandAccountGroupOptions> | Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
        try {
            AccountGroupDetail result = apiInstance.getAccountGroup(id, expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#getAccountGroup");
            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
id	String	Identifier for the account group.
expand	List<ExpandAccountGroupOptions>	Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.	[optional]

Return type

AccountGroupDetail

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

getAccountGroupWithHttpInfo

ApiResponse getAccountGroup getAccountGroupWithHttpInfo(id, expand)

Retrieve account group

Retrieves detailed information about an account group using its ID. This operation requires the `View all account groups settings` permission.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.common.ApiResponse;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        String id = "1234"; // String | Identifier for the account group.
        List<ExpandAccountGroupOptions> expand = Arrays.asList(); // List<ExpandAccountGroupOptions> | Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
        try {
            ApiResponse<AccountGroupDetail> response = apiInstance.getAccountGroupWithHttpInfo(id, expand);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#getAccountGroup");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	Identifier for the account group.
expand	List<ExpandAccountGroupOptions>	Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.	[optional]

Return type

ApiResponse<AccountGroupDetail>

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

getAccountGroups

AccountGroups getAccountGroups()

List account groups

Retrieves a list of account groups available to the current user.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        try {
            AccountGroups result = apiInstance.getAccountGroups();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#getAccountGroups");
            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

AccountGroups

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

getAccountGroupsWithHttpInfo

ApiResponse getAccountGroups getAccountGroupsWithHttpInfo()

List account groups

Retrieves a list of account groups available to the current user.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.common.ApiResponse;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        try {
            ApiResponse<AccountGroups> response = apiInstance.getAccountGroupsWithHttpInfo();
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#getAccountGroups");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

ApiResponse<AccountGroups>

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

updateAccountGroup

AccountGroupDetail updateAccountGroup(id, accountGroupRequest, expand)

Update account group

Updates an account group using its ID. You can modify the account group’s name or the list of agents assigned to the account group.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        String id = "1234"; // String | Identifier for the account group.
        AccountGroupRequest accountGroupRequest = new AccountGroupRequest(); // AccountGroupRequest | 
        List<ExpandAccountGroupOptions> expand = Arrays.asList(); // List<ExpandAccountGroupOptions> | Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
        try {
            AccountGroupDetail result = apiInstance.updateAccountGroup(id, accountGroupRequest, expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#updateAccountGroup");
            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
id	String	Identifier for the account group.
accountGroupRequest	AccountGroupRequest
expand	List<ExpandAccountGroupOptions>	Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.	[optional]

Return type

AccountGroupDetail

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

updateAccountGroupWithHttpInfo

ApiResponse updateAccountGroup updateAccountGroupWithHttpInfo(id, accountGroupRequest, expand)

Update account group

Updates an account group using its ID. You can modify the account group’s name or the list of agents assigned to the account group.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.common.ApiResponse;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        String id = "1234"; // String | Identifier for the account group.
        AccountGroupRequest accountGroupRequest = new AccountGroupRequest(); // AccountGroupRequest | 
        List<ExpandAccountGroupOptions> expand = Arrays.asList(); // List<ExpandAccountGroupOptions> | Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.
        try {
            ApiResponse<AccountGroupDetail> response = apiInstance.updateAccountGroupWithHttpInfo(id, accountGroupRequest, expand);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#updateAccountGroup");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	Identifier for the account group.
accountGroupRequest	AccountGroupRequest
expand	List<ExpandAccountGroupOptions>	Optional parameter that specifies whether or not account group related resources should be expanded. By default, no expansion takes place if the query parameter is not passed. For example, to expand the `users` resource, pass the `?expand=user` query.	[optional]

Return type

ApiResponse<AccountGroupDetail>

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

Files

AccountGroupsApi.md

Latest commit

History

AccountGroupsApi.md

File metadata and controls

AccountGroupsApi

createAccountGroup

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createAccountGroupWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteAccountGroup

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteAccountGroupWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAccountGroup

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAccountGroupWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAccountGroups

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAccountGroupsWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateAccountGroup

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateAccountGroupWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details