OpenAPI\Client\GroupsApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method	HTTP request	Description
groupsCreateGroup()	POST /api/manage/v1/Groups	Create a new user group
groupsDeleteGroup()	DELETE /api/manage/v1/Groups/{id}	Delete group by identifier
groupsGetGroup()	GET /api/manage/v1/Groups/{id}	Gets group by identifier
groupsGetGroupList()	GET /api/manage/v1/Groups	Returns a list of current user's groups<br /> This method will return following data about groups : <br /> Id, Name, Created time (UTC), Edited time (UTC), creator id, <br /> editor id, subscription id
groupsGetPermissions()	GET /api/manage/v1/Groups/{id}/permissions	Gets group permissions by identifier
groupsRenameGroup()	PUT /api/manage/v1/Groups/{id}/rename	Rename group by identifier
groupsUpdatePermissions()	POST /api/manage/v1/Groups/{id}/permissions	Update permissions

`groupsCreateGroup()`

groupsCreateGroup($create_group_vm): \OpenAPI\Client\cloud\fastreport\model\GroupVM

Create a new user group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\GroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$create_group_vm = new \OpenAPI\Client\cloud\fastreport\model\CreateGroupVM(); // \OpenAPI\Client\cloud\fastreport\model\CreateGroupVM | Model for creating

try {
    $result = $apiInstance->groupsCreateGroup($create_group_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsCreateGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
create_group_vm	\OpenAPI\Client\cloud\fastreport\model\CreateGroupVM	Model for creating	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\GroupVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`groupsDeleteGroup()`

groupsDeleteGroup($id)

Delete group by identifier

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\GroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | Identifier of group

try {
    $apiInstance->groupsDeleteGroup($id);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsDeleteGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of group

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`groupsGetGroup()`

groupsGetGroup($id): \OpenAPI\Client\cloud\fastreport\model\GroupVM

Gets group by identifier

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\GroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | Identifier of group

try {
    $result = $apiInstance->groupsGetGroup($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsGetGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of group

Return type

\OpenAPI\Client\cloud\fastreport\model\GroupVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`groupsGetGroupList()`

groupsGetGroupList($skip, $take): \OpenAPI\Client\cloud\fastreport\model\GroupsVM

Returns a list of current user's groups
This method will return following data about groups :
Id, Name, Created time (UTC), Edited time (UTC), creator id,
editor id, subscription id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\GroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$skip = 0; // int | How many groups need to skip
$take = 10; // int | How many groups need to take

try {
    $result = $apiInstance->groupsGetGroupList($skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsGetGroupList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
skip	int	How many groups need to skip	[optional] [default to 0]
take	int	How many groups need to take	[optional] [default to 10]

Return type

\OpenAPI\Client\cloud\fastreport\model\GroupsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`groupsGetPermissions()`

groupsGetPermissions($id): \OpenAPI\Client\cloud\fastreport\model\GroupPermissionsVM

Gets group permissions by identifier

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\GroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | Identifier of group

try {
    $result = $apiInstance->groupsGetPermissions($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsGetPermissions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of group

Return type

\OpenAPI\Client\cloud\fastreport\model\GroupPermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`groupsRenameGroup()`

groupsRenameGroup($id, $rename_group_vm): \OpenAPI\Client\cloud\fastreport\model\GroupVM

Rename group by identifier

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\GroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | Identifier of group
$rename_group_vm = new \OpenAPI\Client\cloud\fastreport\model\RenameGroupVM(); // \OpenAPI\Client\cloud\fastreport\model\RenameGroupVM | Model for renaming

try {
    $result = $apiInstance->groupsRenameGroup($id, $rename_group_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsRenameGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of group
rename_group_vm	\OpenAPI\Client\cloud\fastreport\model\RenameGroupVM	Model for renaming

Return type

\OpenAPI\Client\cloud\fastreport\model\GroupVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`groupsUpdatePermissions()`

groupsUpdatePermissions($id, $update_group_permissions_vm)

Update permissions

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\GroupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | 
$update_group_permissions_vm = new \OpenAPI\Client\cloud\fastreport\model\UpdateGroupPermissionsVM(); // \OpenAPI\Client\cloud\fastreport\model\UpdateGroupPermissionsVM | 

try {
    $apiInstance->groupsUpdatePermissions($id, $update_group_permissions_vm);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsUpdatePermissions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string
update_group_permissions_vm	\OpenAPI\Client\cloud\fastreport\model\UpdateGroupPermissionsVM		[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

GroupsApi.md

Latest commit

History

GroupsApi.md

File metadata and controls

OpenAPI\Client\GroupsApi

groupsCreateGroup()

Example

Parameters

Return type

Authorization

HTTP request headers

groupsDeleteGroup()

Example

Parameters

Return type

Authorization

HTTP request headers

groupsGetGroup()

Example

Parameters

Return type

Authorization

HTTP request headers

groupsGetGroupList()

Example

Parameters

Return type

Authorization

HTTP request headers

groupsGetPermissions()

Example

Parameters

Return type

Authorization

HTTP request headers

groupsRenameGroup()

Example

Parameters

Return type

Authorization

HTTP request headers

groupsUpdatePermissions()

Example

Parameters

Return type

Authorization

HTTP request headers

`groupsCreateGroup()`

`groupsDeleteGroup()`

`groupsGetGroup()`

`groupsGetGroupList()`

`groupsGetPermissions()`

`groupsRenameGroup()`

`groupsUpdatePermissions()`