Skip to content

GroupApi.md

Latest commit

 

History

History
389 lines (266 loc) · 10.8 KB

GroupApi.md

File metadata and controls

389 lines (266 loc) · 10.8 KB

OpenAPI\Client\GroupApi

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

Method HTTP request Description
addMember() POST /v1.0/groups/{group-id}/members/$ref Add a member to a group
deleteGroup() DELETE /v1.0/groups/{group-id} Delete entity from groups
deleteMember() DELETE /v1.0/groups/{group-id}/members/{directory-object-id}/$ref Delete member from a group
getGroup() GET /v1.0/groups/{group-id} Get entity from groups by key
listMembers() GET /v1.0/groups/{group-id}/members Get a list of the group's direct members
updateGroup() PATCH /v1.0/groups/{group-id} Update entity in groups

addMember()

addMember($group_id, $member_reference)

Add a member to a group

Example

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



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


$apiInstance = new OpenAPI\Client\Api\GroupApi(
    // 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
);
$group_id = 'group_id_example'; // string | key: id of group
$member_reference = new \OpenAPI\Client\Model\MemberReference(); // \OpenAPI\Client\Model\MemberReference | Object to be added as member

try {
    $apiInstance->addMember($group_id, $member_reference);
} catch (Exception $e) {
    echo 'Exception when calling GroupApi->addMember: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
group_id string key: id of group
member_reference \OpenAPI\Client\Model\MemberReference Object to be added as member

Return type

void (empty response body)

Authorization

openId, basicAuth

HTTP request headers

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

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

deleteGroup()

deleteGroup($group_id, $if_match)

Delete entity from groups

Example

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



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


$apiInstance = new OpenAPI\Client\Api\GroupApi(
    // 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
);
$group_id = 'group_id_example'; // string | key: id of group
$if_match = 'if_match_example'; // string | ETag

try {
    $apiInstance->deleteGroup($group_id, $if_match);
} catch (Exception $e) {
    echo 'Exception when calling GroupApi->deleteGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
group_id string key: id of group
if_match string ETag [optional]

Return type

void (empty response body)

Authorization

openId, basicAuth

HTTP request headers

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

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

deleteMember()

deleteMember($group_id, $directory_object_id, $if_match)

Delete member from a group

Example

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



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


$apiInstance = new OpenAPI\Client\Api\GroupApi(
    // 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
);
$group_id = 'group_id_example'; // string | key: id of group
$directory_object_id = 'directory_object_id_example'; // string | key: id of group member to remove
$if_match = 'if_match_example'; // string | ETag

try {
    $apiInstance->deleteMember($group_id, $directory_object_id, $if_match);
} catch (Exception $e) {
    echo 'Exception when calling GroupApi->deleteMember: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
group_id string key: id of group
directory_object_id string key: id of group member to remove
if_match string ETag [optional]

Return type

void (empty response body)

Authorization

openId, basicAuth

HTTP request headers

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

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

getGroup()

getGroup($group_id, $select, $expand): \OpenAPI\Client\Model\Group

Get entity from groups by key

Example

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



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


$apiInstance = new OpenAPI\Client\Api\GroupApi(
    // 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
);
$group_id = 'group_id_example'; // string | key: id or name of group
$select = array('select_example'); // string[] | Select properties to be returned
$expand = array('expand_example'); // string[] | Expand related entities

try {
    $result = $apiInstance->getGroup($group_id, $select, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupApi->getGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
group_id string key: id or name of group
select string[] Select properties to be returned [optional]
expand string[] Expand related entities [optional]

Return type

\OpenAPI\Client\Model\Group

Authorization

openId, basicAuth

HTTP request headers

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

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

listMembers()

listMembers($group_id): \OpenAPI\Client\Model\CollectionOfUsers

Get a list of the group's direct members

Example

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



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


$apiInstance = new OpenAPI\Client\Api\GroupApi(
    // 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
);
$group_id = 86948e45-96a6-43df-b83d-46e92afd30de; // string | key: id or name of group

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

Parameters

Name Type Description Notes
group_id string key: id or name of group

Return type

\OpenAPI\Client\Model\CollectionOfUsers

Authorization

openId, basicAuth

HTTP request headers

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

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

updateGroup()

updateGroup($group_id, $group)

Update entity in groups

Example

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



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


$apiInstance = new OpenAPI\Client\Api\GroupApi(
    // 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
);
$group_id = 'group_id_example'; // string | key: id of group
$group = {"displayName":"GroupName"}; // \OpenAPI\Client\Model\Group | New property values

try {
    $apiInstance->updateGroup($group_id, $group);
} catch (Exception $e) {
    echo 'Exception when calling GroupApi->updateGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
group_id string key: id of group
group \OpenAPI\Client\Model\Group New property values

Return type

void (empty response body)

Authorization

openId, basicAuth

HTTP request headers

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

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