Skip to content

Oauth2Api.md

Latest commit

 

History

History
141 lines (98 loc) · 4.82 KB

Oauth2Api.md

File metadata and controls

141 lines (98 loc) · 4.82 KB

OpenAPI\Client\Oauth2Api

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

Method HTTP request Description
getOauth2Token() POST /oauth2/token Request an access token using an existing grant
getOauth2TokenRevoke() POST /oauth2/token/revoke Revoke an existing access or refresh token

getOauth2Token()

getOauth2Token($grant_type, $code, $refresh_token): \OpenAPI\Client\Model\GetOauth2Token200Response

Request an access token using an existing grant

Supported grant types: authorization_code, and refresh_token. Must authenticate via HTTP Basic Authentication, using your OAuth2 client credentials.

Example

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


// Configure API key authorization: token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\Oauth2Api(
    // 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
);
$grant_type = 'grant_type_example'; // string
$code = 'code_example'; // string | Required if grant_type = `authorization_code`.
$refresh_token = 'refresh_token_example'; // string | Required if grant_type = `refresh_token`.

try {
    $result = $apiInstance->getOauth2Token($grant_type, $code, $refresh_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Oauth2Api->getOauth2Token: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
grant_type string
code string Required if grant_type = `authorization_code`. [optional]
refresh_token string Required if grant_type = `refresh_token`. [optional]

Return type

\OpenAPI\Client\Model\GetOauth2Token200Response

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

getOauth2TokenRevoke()

getOauth2TokenRevoke($authorization, $token, $token_hint): \OpenAPI\Client\Model\GetOauth2TokenRevoke200Response

Revoke an existing access or refresh token

Must authenticate via HTTP Basic Authentication, using your OAuth2 client credentials.

Example

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


// Configure API key authorization: token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\Oauth2Api(
    // 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
);
$authorization = 'authorization_example'; // string | OAuth2 client credentials in the Basic authorization format.
$token = 'token_example'; // string
$token_hint = 'token_hint_example'; // string

try {
    $result = $apiInstance->getOauth2TokenRevoke($authorization, $token, $token_hint);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Oauth2Api->getOauth2TokenRevoke: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
authorization string OAuth2 client credentials in the Basic authorization format.
token string
token_hint string [optional]

Return type

\OpenAPI\Client\Model\GetOauth2TokenRevoke200Response

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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