Skip to content

Latest commit

 

History

History
261 lines (187 loc) · 8.06 KB

UserApi.md

File metadata and controls

261 lines (187 loc) · 8.06 KB

YouSign\Client\UserApi

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

Method HTTP request Description
usersGet GET /users List all Users
usersIdDelete DELETE /users/{id} Delete a User
usersIdGet GET /users/{id} Find a User by ID
usersIdPut PUT /users/{id} Update a User
usersPost POST /users Create a new User on Yousign application

usersGet

\YouSign\Client\Model\UserOutput[] usersGet($authorization)

List all Users

Example

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

$apiInstance = new YouSign\Client\Api\UserApi(
    // 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->usersGet($authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->usersGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
authorization string Authentication credentials for HTTP authentication

Return type

\YouSign\Client\Model\UserOutput[]

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]

usersIdDelete

usersIdDelete($id, $authorization)

Delete a User

Example

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

$apiInstance = new YouSign\Client\Api\UserApi(
    // 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 {
    $apiInstance->usersIdDelete($id, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->usersIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

void (empty response body)

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]

usersIdGet

\YouSign\Client\Model\UserOutput usersIdGet($id, $authorization)

Find a User by ID

Example

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

$apiInstance = new YouSign\Client\Api\UserApi(
    // 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->usersIdGet($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->usersIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\YouSign\Client\Model\UserOutput

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]

usersIdPut

\YouSign\Client\Model\UserOutput usersIdPut($id, $content_type, $authorization, $body)

Update a User

Example

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

$apiInstance = new YouSign\Client\Api\UserApi(
    // 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 | 
$content_type = "\"application/json\""; // string | The MIME type of the body of the request
$authorization = "\"Bearer {{access_token}}\""; // string | Authentication credentials for HTTP authentication
$body = new \YouSign\Client\Model\UserUpdateInput(); // \YouSign\Client\Model\UserUpdateInput | 

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

Parameters

Name Type Description Notes
id string
content_type string The MIME type of the body of the request
authorization string Authentication credentials for HTTP authentication
body \YouSign\Client\Model\UserUpdateInput

Return type

\YouSign\Client\Model\UserOutput

Authorization

No authorization required

HTTP request headers

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

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

usersPost

\YouSign\Client\Model\UserOutput usersPost($content_type, $authorization, $body)

Create a new User on Yousign application

Example

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

$apiInstance = new YouSign\Client\Api\UserApi(
    // 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()
);
$content_type = "\"application/json\""; // string | The MIME type of the body of the request
$authorization = "\"Bearer {{access_token}}\""; // string | Authentication credentials for HTTP authentication
$body = new \YouSign\Client\Model\UserInput(); // \YouSign\Client\Model\UserInput | 

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

Parameters

Name Type Description Notes
content_type string The MIME type of the body of the request
authorization string Authentication credentials for HTTP authentication
body \YouSign\Client\Model\UserInput

Return type

\YouSign\Client\Model\UserOutput

Authorization

No authorization required

HTTP request headers

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

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