Skip to content

Latest commit

 

History

History
320 lines (232 loc) · 11.2 KB

AuthenticationsApi.md

File metadata and controls

320 lines (232 loc) · 11.2 KB

YouSign\Client\AuthenticationsApi

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

Method HTTP request Description
authenticationsEmailIdGet GET /authentications/email/{id} Find an Authentication by ID
authenticationsEmailIdPut PUT /authentications/email/{id} Update an Email Authentication
authenticationsInweboIdGet GET /authentications/inwebo/{id} Get an Authentication
authenticationsInweboIdPut PUT /authentications/inwebo/{id} Update an inwebo Authentication
authenticationsSmsIdGet GET /authentications/sms/{id} Find an Authentication by ID
authenticationsSmsIdPut PUT /authentications/sms/{id} Update an SMS Authentication

authenticationsEmailIdGet

\YouSign\Client\Model\AuthenticationEmailOutput authenticationsEmailIdGet($id, $authorization)

Find an Authentication by ID

Example

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

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

Parameters

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

Return type

\YouSign\Client\Model\AuthenticationEmailOutput

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]

authenticationsEmailIdPut

\YouSign\Client\Model\AuthenticationEmailOutput authenticationsEmailIdPut($id, $authorization, $content_type, $body)

Update an Email Authentication

Example

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

$apiInstance = new YouSign\Client\Api\AuthenticationsApi(
    // 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
$content_type = "\"application/json\""; // string | The MIME type of the body of the request
$body = new \YouSign\Client\Model\Body3(); // \YouSign\Client\Model\Body3 | 

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

Parameters

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

Return type

\YouSign\Client\Model\AuthenticationEmailOutput

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]

authenticationsInweboIdGet

\YouSign\Client\Model\AuthenticationInweboOutput authenticationsInweboIdGet($id, $authorization)

Get an Authentication

Example

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

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

Parameters

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

Return type

\YouSign\Client\Model\AuthenticationInweboOutput

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]

authenticationsInweboIdPut

\YouSign\Client\Model\AuthenticationInweboOutput authenticationsInweboIdPut($id, $content_type, $authorization, $body)

Update an inwebo Authentication

Example

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

$apiInstance = new YouSign\Client\Api\AuthenticationsApi(
    // 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\Body1(); // \YouSign\Client\Model\Body1 | 

try {
    $result = $apiInstance->authenticationsInweboIdPut($id, $content_type, $authorization, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationsApi->authenticationsInweboIdPut: ', $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\Body1

Return type

\YouSign\Client\Model\AuthenticationInweboOutput

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]

authenticationsSmsIdGet

\YouSign\Client\Model\AuthenticationSmsOutput authenticationsSmsIdGet($id, $authorization)

Find an Authentication by ID

Example

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

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

Parameters

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

Return type

\YouSign\Client\Model\AuthenticationSmsOutput

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]

authenticationsSmsIdPut

\YouSign\Client\Model\AuthenticationSmsOutput authenticationsSmsIdPut($id, $authorization, $content_type, $body)

Update an SMS Authentication

Example

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

$apiInstance = new YouSign\Client\Api\AuthenticationsApi(
    // 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
$content_type = "\"application/json\""; // string | The MIME type of the body of the request
$body = new \YouSign\Client\Model\Body2(); // \YouSign\Client\Model\Body2 | 

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

Parameters

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

Return type

\YouSign\Client\Model\AuthenticationSmsOutput

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]