Skip to content

Latest commit

 

History

History
498 lines (359 loc) · 14.8 KB

UsergroupsApi.md

File metadata and controls

498 lines (359 loc) · 14.8 KB

UsergroupsApi

Method HTTP request Description
addUserGroup POST /usergroups Create a new user group
addUserToGroup POST /usergroups/{id}/users Add an existing user to the user group with the specified ID
deleteItem DELETE /usergroups/{id} Delete the user group with the specified ID
getGroup GET /usergroups/{id} Get the user group with the specified ID
getGroupUsers GET /usergroups/{id}/users Get all users for the user group with the specified ID
getUsers GET /usergroups Get all user groups
removeUserFromGroup DELETE /usergroups/{id}/users/{userId} Remove an existing user from the user group with the specified ID
updateUserGroup PUT /usergroups/{id} Update the user group with the specified ID

addUserGroup

CreatedResponse addUserGroup(body)

Create a new user group

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UsergroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

UsergroupsApi apiInstance = new UsergroupsApi();
RequestUserGroup body = new RequestUserGroup(); // RequestUserGroup | 
try {
    CreatedResponse result = apiInstance.addUserGroup(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsergroupsApi#addUserGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestUserGroup

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

addUserToGroup

CreatedResponse addUserToGroup(body, id)

Add an existing user to the user group with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UsergroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

UsergroupsApi apiInstance = new UsergroupsApi();
RequestGroupUser body = new RequestGroupUser(); // RequestGroupUser | 
Integer id = 56; // Integer | 
try {
    CreatedResponse result = apiInstance.addUserToGroup(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsergroupsApi#addUserToGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestGroupUser
id Integer

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteItem

AbstractRestResponse deleteItem(id)

Delete the user group with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UsergroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

UsergroupsApi apiInstance = new UsergroupsApi();
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.deleteItem(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsergroupsApi#deleteItem");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getGroup

UserGroupDataWrapper getGroup(id, include)

Get the user group with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UsergroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

UsergroupsApi apiInstance = new UsergroupsApi();
Integer id = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    UserGroupDataWrapper result = apiInstance.getGroup(id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsergroupsApi#getGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer
include List<String> Links to include as full objects in the linked map [optional]

Return type

UserGroupDataWrapper

Authorization

basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getGroupUsers

UserDataListWrapper getGroupUsers(id, startAt, maxResults, include)

Get all users for the user group with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UsergroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

UsergroupsApi apiInstance = new UsergroupsApi();
Integer id = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    UserDataListWrapper result = apiInstance.getGroupUsers(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsergroupsApi#getGroupUsers");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer
startAt Integer [optional]
maxResults Integer If not set, this defaults to 20. This cannot be larger than 50 [optional]
include List<String> Links to include as full objects in the linked map [optional]

Return type

UserDataListWrapper

Authorization

basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getUsers

UserGroupDataListWrapper getUsers(project, startAt, maxResults, include)

Get all user groups

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UsergroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

UsergroupsApi apiInstance = new UsergroupsApi();
Integer project = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    UserGroupDataListWrapper result = apiInstance.getUsers(project, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsergroupsApi#getUsers");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
project Integer [optional]
startAt Integer [optional]
maxResults Integer If not set, this defaults to 20. This cannot be larger than 50 [optional]
include List<String> Links to include as full objects in the linked map [optional]

Return type

UserGroupDataListWrapper

Authorization

basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

removeUserFromGroup

AbstractRestResponse removeUserFromGroup(userId, id)

Remove an existing user from the user group with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UsergroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

UsergroupsApi apiInstance = new UsergroupsApi();
Integer userId = 56; // Integer | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.removeUserFromGroup(userId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsergroupsApi#removeUserFromGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateUserGroup

AbstractRestResponse updateUserGroup(body, id)

Update the user group with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UsergroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

UsergroupsApi apiInstance = new UsergroupsApi();
RequestUserGroup body = new RequestUserGroup(); // RequestUserGroup | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.updateUserGroup(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsergroupsApi#updateUserGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestUserGroup
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json