Skip to content

DanglIdentityApi.md

Latest commit

 

History

History
421 lines (269 loc) · 11.9 KB

DanglIdentityApi.md

File metadata and controls

421 lines (269 loc) · 11.9 KB
Raw

Dangl\AVACloud\DanglIdentityApi

All URIs are relative to https://avacloud-api.dangl-it.com, except if the operation defines another base path.

Method HTTP request Description
danglIdentityGetUserInfo() GET /identity/user-info
danglIdentityLoginAndReturnToken() POST /identity/token-login
danglIdentityLoginWithCookie() POST /identity/login
danglIdentityRefreshToken() POST /identity/token-refresh
danglIdentityRegister() POST /identity/register
danglIdentityRequestPasswordReset() POST /identity/password-forgotten
danglIdentitySignOutWithSignInManager() DELETE /identity/login

danglIdentityGetUserInfo()

danglIdentityGetUserInfo(): \Dangl\AVACloud\Model\UserInfoGet

Example

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


// Configure OAuth2 access token for authorization: Dangl.Identity
$config = Dangl\AVACloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Dangl\AVACloud\Api\DanglIdentityApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Dangl\AVACloud\Model\UserInfoGet

Authorization

Dangl.Identity

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json, application/problem+json

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

danglIdentityLoginAndReturnToken()

danglIdentityLoginAndReturnToken($model): \Dangl\AVACloud\Model\TokenResponseGet

Example

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


// Configure OAuth2 access token for authorization: Dangl.Identity
$config = Dangl\AVACloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Dangl\AVACloud\Api\DanglIdentityApi(
    // 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
);
$model = new \Dangl\AVACloud\Model\TokenLoginPost(); // \Dangl\AVACloud\Model\TokenLoginPost

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

Parameters

Name Type Description Notes
model \Dangl\AVACloud\Model\TokenLoginPost

Return type

\Dangl\AVACloud\Model\TokenResponseGet

Authorization

Dangl.Identity

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json, application/problem+json

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

danglIdentityLoginWithCookie()

danglIdentityLoginWithCookie($model, $redirectUrl)

Example

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


// Configure OAuth2 access token for authorization: Dangl.Identity
$config = Dangl\AVACloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Dangl\AVACloud\Api\DanglIdentityApi(
    // 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
);
$model = new \Dangl\AVACloud\Model\LoginPost(); // \Dangl\AVACloud\Model\LoginPost
$redirectUrl = 'redirectUrl_example'; // string

try {
    $apiInstance->danglIdentityLoginWithCookie($model, $redirectUrl);
} catch (Exception $e) {
    echo 'Exception when calling DanglIdentityApi->danglIdentityLoginWithCookie: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
model \Dangl\AVACloud\Model\LoginPost
redirectUrl string [optional]

Return type

void (empty response body)

Authorization

Dangl.Identity

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: Not defined

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

danglIdentityRefreshToken()

danglIdentityRefreshToken($model): \Dangl\AVACloud\Model\TokenResponseGet

Example

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


// Configure OAuth2 access token for authorization: Dangl.Identity
$config = Dangl\AVACloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Dangl\AVACloud\Api\DanglIdentityApi(
    // 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
);
$model = new \Dangl\AVACloud\Model\TokenRefreshPost(); // \Dangl\AVACloud\Model\TokenRefreshPost

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

Parameters

Name Type Description Notes
model \Dangl\AVACloud\Model\TokenRefreshPost

Return type

\Dangl\AVACloud\Model\TokenResponseGet

Authorization

Dangl.Identity

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json, application/problem+json

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

danglIdentityRegister()

danglIdentityRegister($registerModel)

Example

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


// Configure OAuth2 access token for authorization: Dangl.Identity
$config = Dangl\AVACloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Dangl\AVACloud\Api\DanglIdentityApi(
    // 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
);
$registerModel = new \Dangl\AVACloud\Model\RegisterPost(); // \Dangl\AVACloud\Model\RegisterPost

try {
    $apiInstance->danglIdentityRegister($registerModel);
} catch (Exception $e) {
    echo 'Exception when calling DanglIdentityApi->danglIdentityRegister: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
registerModel \Dangl\AVACloud\Model\RegisterPost

Return type

void (empty response body)

Authorization

Dangl.Identity

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json, application/problem+json

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

danglIdentityRequestPasswordReset()

danglIdentityRequestPasswordReset($forgotPasswordModel)

Example

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


// Configure OAuth2 access token for authorization: Dangl.Identity
$config = Dangl\AVACloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Dangl\AVACloud\Api\DanglIdentityApi(
    // 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
);
$forgotPasswordModel = new \Dangl\AVACloud\Model\ForgotPasswordPost(); // \Dangl\AVACloud\Model\ForgotPasswordPost

try {
    $apiInstance->danglIdentityRequestPasswordReset($forgotPasswordModel);
} catch (Exception $e) {
    echo 'Exception when calling DanglIdentityApi->danglIdentityRequestPasswordReset: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
forgotPasswordModel \Dangl\AVACloud\Model\ForgotPasswordPost

Return type

void (empty response body)

Authorization

Dangl.Identity

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json, application/problem+json

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

danglIdentitySignOutWithSignInManager()

danglIdentitySignOutWithSignInManager()

Example

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


// Configure OAuth2 access token for authorization: Dangl.Identity
$config = Dangl\AVACloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new Dangl\AVACloud\Api\DanglIdentityApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

Dangl.Identity

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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