Skip to content

Latest commit

 

History

History
106 lines (74 loc) · 3.14 KB

UserGroupApi.md

File metadata and controls

106 lines (74 loc) · 3.14 KB

YouSign\Client\UserGroupApi

All URIs are relative to https://api.yousign.com

Method HTTP request Description
userGroupsGet GET /user_groups Get User Group list
userGroupsIdGet GET /user_groups/{id} Find a User Group by ID

userGroupsGet

\YouSign\Client\Model\UserGroup[] userGroupsGet($authorization)

Get User Group list

Example

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

$apiInstance = new YouSign\Client\Api\UserGroupApi(
    // 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()
);
$authorization = "\"Bearer {{access_token}}\""; // string | Authentication credentials for HTTP authentication

try {
    $result = $apiInstance->userGroupsGet($authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserGroupApi->userGroupsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
authorization string Authentication credentials for HTTP authentication

Return type

\YouSign\Client\Model\UserGroup[]

Authorization

No authorization required

HTTP request headers

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

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

userGroupsIdGet

\YouSign\Client\Model\UserGroup userGroupsIdGet($id, $authorization)

Find a User Group by ID

Example

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

$apiInstance = new YouSign\Client\Api\UserGroupApi(
    // 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()
);
$id = "id_example"; // string | 
$authorization = "\"Bearer {{access_token}}\""; // string | Authentication credentials for HTTP authentication

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

Parameters

Name Type Description Notes
id string
authorization string Authentication credentials for HTTP authentication

Return type

\YouSign\Client\Model\UserGroup

Authorization

No authorization required

HTTP request headers

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

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