Skip to content

Latest commit

 

History

History
316 lines (248 loc) · 10.5 KB

GroupUsersApi.md

File metadata and controls

316 lines (248 loc) · 10.5 KB
Raw

GroupUsersApi

All URIs are relative to http://localhost

Method HTTP request Description
groupUsersAddUserToGroup PUT /api/manage/v1/Groups/{id}/Users/{userId} Add user to the group by identifier
groupUsersGetUsersInGroup GET /api/manage/v1/Groups/{id}/Users Returns users in the group by identifier
groupUsersLeaveFromGroup DELETE /api/manage/v1/Groups/{id}/leave Leave from the group
groupUsersRemoveFromGroup DELETE /api/manage/v1/Groups/{id}/Users/{userId} Remove user from the group by identifier

groupUsersAddUserToGroup

groupUsersAddUserToGroup(id, userId)

Add user to the group by identifier

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.GroupUsersApi;

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

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    GroupUsersApi apiInstance = new GroupUsersApi(defaultClient);
    String id = "id_example"; // String | Identifier of group
    String userId = "userId_example"; // String | Identifier of user
    try {
      apiInstance.groupUsersAddUserToGroup(id, userId);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupUsersApi#groupUsersAddUserToGroup");
      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 of group
userId String Identifier of user

Return type

null (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 Succesfully retured -
400 The reqeust is wrong -
402 subscription is outdated -
403 You don't have rights for the operation -
404 Group with this identifier, subscription or user is not found -
500 Exception thrown -

groupUsersGetUsersInGroup

GroupUsersVM groupUsersGetUsersInGroup(id, skip, take)

Returns users in the group by identifier

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.GroupUsersApi;

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

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    GroupUsersApi apiInstance = new GroupUsersApi(defaultClient);
    String id = "id_example"; // String | Identifier of group
    Integer skip = 0; // Integer | how many to skip
    Integer take = 10; // Integer | how many to take
    try {
      GroupUsersVM result = apiInstance.groupUsersGetUsersInGroup(id, skip, take);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupUsersApi#groupUsersGetUsersInGroup");
      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 of group
skip Integer how many to skip [optional] [default to 0]
take Integer how many to take [optional] [default to 10]

Return type

GroupUsersVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Succesfully retured -
400 The reqeust is wrong -
402 Subscription is outdated -
403 You don't have rights for the operation -
404 Group with this identifier or subscription is not found -
500 Exception thrown -

groupUsersLeaveFromGroup

groupUsersLeaveFromGroup(id)

Leave from the group

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.GroupUsersApi;

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

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    GroupUsersApi apiInstance = new GroupUsersApi(defaultClient);
    String id = "id_example"; // String | Identifier of group
    try {
      apiInstance.groupUsersLeaveFromGroup(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupUsersApi#groupUsersLeaveFromGroup");
      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 of group

Return type

null (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 Succesfully removed -
400 The reqeust is wrong -
402 subscription is outdated -
404 Group with this identifier or subscription is not found -
500 Exception thrown -

groupUsersRemoveFromGroup

groupUsersRemoveFromGroup(id, userId)

Remove user from the group by identifier

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.GroupUsersApi;

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

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    GroupUsersApi apiInstance = new GroupUsersApi(defaultClient);
    String id = "id_example"; // String | Identifier of group
    String userId = "userId_example"; // String | Identifier of user
    try {
      apiInstance.groupUsersRemoveFromGroup(id, userId);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupUsersApi#groupUsersRemoveFromGroup");
      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 of group
userId String Identifier of user

Return type

null (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 Succesfully removed -
400 The reqeust is wrong -
402 subscription is outdated -
403 You don't have rights for the operation -
404 Group with this identifier, subscription or user is not found -
500 Exception thrown -