Documentation

ApiMcpOAuthControllerApi
in package

ApiMcpOAuthControllerApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['authorizationServerMetadata' => ['application/json'], 'authorizationServerMetadata1' => ['application/json'], 'authorize' => ['application/json'], 'protectedResourceMetadata' => ['application/json'], 'protectedResourceMetadata1' => ['application/json'], 'register' => ['application/json'], 'token' => ['application/x-www-form-urlencoded']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
__construct()  : mixed
authorizationServerMetadata()  : array<string, object>
Operation authorizationServerMetadata
authorizationServerMetadata1()  : array<string, object>
Operation authorizationServerMetadata1
authorizationServerMetadata1Async()  : PromiseInterface
Operation authorizationServerMetadata1Async
authorizationServerMetadata1AsyncWithHttpInfo()  : PromiseInterface
Operation authorizationServerMetadata1AsyncWithHttpInfo
authorizationServerMetadata1Request()  : Request
Create request for operation 'authorizationServerMetadata1'
authorizationServerMetadata1WithHttpInfo()  : array<string|int, mixed>
Operation authorizationServerMetadata1WithHttpInfo
authorizationServerMetadataAsync()  : PromiseInterface
Operation authorizationServerMetadataAsync
authorizationServerMetadataAsyncWithHttpInfo()  : PromiseInterface
Operation authorizationServerMetadataAsyncWithHttpInfo
authorizationServerMetadataRequest()  : Request
Create request for operation 'authorizationServerMetadata'
authorizationServerMetadataWithHttpInfo()  : array<string|int, mixed>
Operation authorizationServerMetadataWithHttpInfo
authorize()  : object
Operation authorize
authorizeAsync()  : PromiseInterface
Operation authorizeAsync
authorizeAsyncWithHttpInfo()  : PromiseInterface
Operation authorizeAsyncWithHttpInfo
authorizeRequest()  : Request
Create request for operation 'authorize'
authorizeWithHttpInfo()  : array<string|int, mixed>
Operation authorizeWithHttpInfo
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
protectedResourceMetadata()  : array<string, object>
Operation protectedResourceMetadata
protectedResourceMetadata1()  : array<string, object>
Operation protectedResourceMetadata1
protectedResourceMetadata1Async()  : PromiseInterface
Operation protectedResourceMetadata1Async
protectedResourceMetadata1AsyncWithHttpInfo()  : PromiseInterface
Operation protectedResourceMetadata1AsyncWithHttpInfo
protectedResourceMetadata1Request()  : Request
Create request for operation 'protectedResourceMetadata1'
protectedResourceMetadata1WithHttpInfo()  : array<string|int, mixed>
Operation protectedResourceMetadata1WithHttpInfo
protectedResourceMetadataAsync()  : PromiseInterface
Operation protectedResourceMetadataAsync
protectedResourceMetadataAsyncWithHttpInfo()  : PromiseInterface
Operation protectedResourceMetadataAsyncWithHttpInfo
protectedResourceMetadataRequest()  : Request
Create request for operation 'protectedResourceMetadata'
protectedResourceMetadataWithHttpInfo()  : array<string|int, mixed>
Operation protectedResourceMetadataWithHttpInfo
register()  : object
Operation register
registerAsync()  : PromiseInterface
Operation registerAsync
registerAsyncWithHttpInfo()  : PromiseInterface
Operation registerAsyncWithHttpInfo
registerRequest()  : Request
Create request for operation 'register'
registerWithHttpInfo()  : array<string|int, mixed>
Operation registerWithHttpInfo
setHostIndex()  : void
Set the host index
token()  : object
Operation token
tokenAsync()  : PromiseInterface
Operation tokenAsync
tokenAsyncWithHttpInfo()  : PromiseInterface
Operation tokenAsyncWithHttpInfo
tokenRequest()  : Request
Create request for operation 'token'
tokenWithHttpInfo()  : array<string|int, mixed>
Operation tokenWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option

Constants

contentTypes

public array<string|int, string> contentTypes = ['authorizationServerMetadata' => ['application/json'], 'authorizationServerMetadata1' => ['application/json'], 'authorize' => ['application/json'], 'protectedResourceMetadata' => ['application/json'], 'protectedResourceMetadata1' => ['application/json'], 'register' => ['application/json'], 'token' => ['application/x-www-form-urlencoded']]

Properties

Methods

__construct()

public __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

Return values
mixed —

authorizationServerMetadata()

Operation authorizationServerMetadata

public authorizationServerMetadata([string $contentType = self::contentTypes['authorizationServerMetadata'][0] ]) : array<string, object>
Parameters
$contentType : string = self::contentTypes['authorizationServerMetadata'][0]

The value for the Content-Type header. Check self::contentTypes['authorizationServerMetadata'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string, object> —

authorizationServerMetadata1()

Operation authorizationServerMetadata1

public authorizationServerMetadata1([string $contentType = self::contentTypes['authorizationServerMetadata1'][0] ]) : array<string, object>
Parameters
$contentType : string = self::contentTypes['authorizationServerMetadata1'][0]

The value for the Content-Type header. Check self::contentTypes['authorizationServerMetadata1'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string, object> —

authorizationServerMetadata1Async()

Operation authorizationServerMetadata1Async

public authorizationServerMetadata1Async([string $contentType = self::contentTypes['authorizationServerMetadata1'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['authorizationServerMetadata1'][0]

The value for the Content-Type header. Check self::contentTypes['authorizationServerMetadata1'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authorizationServerMetadata1AsyncWithHttpInfo()

Operation authorizationServerMetadata1AsyncWithHttpInfo

public authorizationServerMetadata1AsyncWithHttpInfo([string $contentType = self::contentTypes['authorizationServerMetadata1'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['authorizationServerMetadata1'][0]

The value for the Content-Type header. Check self::contentTypes['authorizationServerMetadata1'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authorizationServerMetadata1Request()

Create request for operation 'authorizationServerMetadata1'

public authorizationServerMetadata1Request([string $contentType = self::contentTypes['authorizationServerMetadata1'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['authorizationServerMetadata1'][0]

The value for the Content-Type header. Check self::contentTypes['authorizationServerMetadata1'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

authorizationServerMetadata1WithHttpInfo()

Operation authorizationServerMetadata1WithHttpInfo

public authorizationServerMetadata1WithHttpInfo([string $contentType = self::contentTypes['authorizationServerMetadata1'][0] ]) : array<string|int, mixed>
Parameters
$contentType : string = self::contentTypes['authorizationServerMetadata1'][0]

The value for the Content-Type header. Check self::contentTypes['authorizationServerMetadata1'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of array<string,object>, HTTP status code, HTTP response headers (array of strings)

authorizationServerMetadataAsync()

Operation authorizationServerMetadataAsync

public authorizationServerMetadataAsync([string $contentType = self::contentTypes['authorizationServerMetadata'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['authorizationServerMetadata'][0]

The value for the Content-Type header. Check self::contentTypes['authorizationServerMetadata'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authorizationServerMetadataAsyncWithHttpInfo()

Operation authorizationServerMetadataAsyncWithHttpInfo

public authorizationServerMetadataAsyncWithHttpInfo([string $contentType = self::contentTypes['authorizationServerMetadata'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['authorizationServerMetadata'][0]

The value for the Content-Type header. Check self::contentTypes['authorizationServerMetadata'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authorizationServerMetadataRequest()

Create request for operation 'authorizationServerMetadata'

public authorizationServerMetadataRequest([string $contentType = self::contentTypes['authorizationServerMetadata'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['authorizationServerMetadata'][0]

The value for the Content-Type header. Check self::contentTypes['authorizationServerMetadata'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

authorizationServerMetadataWithHttpInfo()

Operation authorizationServerMetadataWithHttpInfo

public authorizationServerMetadataWithHttpInfo([string $contentType = self::contentTypes['authorizationServerMetadata'][0] ]) : array<string|int, mixed>
Parameters
$contentType : string = self::contentTypes['authorizationServerMetadata'][0]

The value for the Content-Type header. Check self::contentTypes['authorizationServerMetadata'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of array<string,object>, HTTP status code, HTTP response headers (array of strings)

authorize()

Operation authorize

public authorize(string $client_id, string $redirect_uri, string $response_type, string $code_challenge, string $code_challenge_method, string $resource[, string $scope = null ][, string $state = null ][, string $contentType = self::contentTypes['authorize'][0] ]) : object
Parameters
$client_id : string

client_id (required)

$redirect_uri : string

redirect_uri (required)

$response_type : string

response_type (required)

$code_challenge : string

code_challenge (required)

$code_challenge_method : string

code_challenge_method (required)

$resource : string

resource (required)

$scope : string = null

scope (optional)

$state : string = null

state (optional)

$contentType : string = self::contentTypes['authorize'][0]

The value for the Content-Type header. Check self::contentTypes['authorize'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

authorizeAsync()

Operation authorizeAsync

public authorizeAsync(string $client_id, string $redirect_uri, string $response_type, string $code_challenge, string $code_challenge_method, string $resource[, string $scope = null ][, string $state = null ][, string $contentType = self::contentTypes['authorize'][0] ]) : PromiseInterface
Parameters
$client_id : string

(required)

$redirect_uri : string

(required)

$response_type : string

(required)

$code_challenge : string

(required)

$code_challenge_method : string

(required)

$resource : string

(required)

$scope : string = null

(optional)

$state : string = null

(optional)

$contentType : string = self::contentTypes['authorize'][0]

The value for the Content-Type header. Check self::contentTypes['authorize'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authorizeAsyncWithHttpInfo()

Operation authorizeAsyncWithHttpInfo

public authorizeAsyncWithHttpInfo(string $client_id, string $redirect_uri, string $response_type, string $code_challenge, string $code_challenge_method, string $resource[, string $scope = null ][, string $state = null ][, string $contentType = self::contentTypes['authorize'][0] ]) : PromiseInterface
Parameters
$client_id : string

(required)

$redirect_uri : string

(required)

$response_type : string

(required)

$code_challenge : string

(required)

$code_challenge_method : string

(required)

$resource : string

(required)

$scope : string = null

(optional)

$state : string = null

(optional)

$contentType : string = self::contentTypes['authorize'][0]

The value for the Content-Type header. Check self::contentTypes['authorize'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

authorizeRequest()

Create request for operation 'authorize'

public authorizeRequest(string $client_id, string $redirect_uri, string $response_type, string $code_challenge, string $code_challenge_method, string $resource[, string $scope = null ][, string $state = null ][, string $contentType = self::contentTypes['authorize'][0] ]) : Request
Parameters
$client_id : string

(required)

$redirect_uri : string

(required)

$response_type : string

(required)

$code_challenge : string

(required)

$code_challenge_method : string

(required)

$resource : string

(required)

$scope : string = null

(optional)

$state : string = null

(optional)

$contentType : string = self::contentTypes['authorize'][0]

The value for the Content-Type header. Check self::contentTypes['authorize'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

authorizeWithHttpInfo()

Operation authorizeWithHttpInfo

public authorizeWithHttpInfo(string $client_id, string $redirect_uri, string $response_type, string $code_challenge, string $code_challenge_method, string $resource[, string $scope = null ][, string $state = null ][, string $contentType = self::contentTypes['authorize'][0] ]) : array<string|int, mixed>
Parameters
$client_id : string

(required)

$redirect_uri : string

(required)

$response_type : string

(required)

$code_challenge : string

(required)

$code_challenge_method : string

(required)

$resource : string

(required)

$scope : string = null

(optional)

$state : string = null

(optional)

$contentType : string = self::contentTypes['authorize'][0]

The value for the Content-Type header. Check self::contentTypes['authorize'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

protectedResourceMetadata()

Operation protectedResourceMetadata

public protectedResourceMetadata([string $contentType = self::contentTypes['protectedResourceMetadata'][0] ]) : array<string, object>
Parameters
$contentType : string = self::contentTypes['protectedResourceMetadata'][0]

The value for the Content-Type header. Check self::contentTypes['protectedResourceMetadata'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string, object> —

protectedResourceMetadata1()

Operation protectedResourceMetadata1

public protectedResourceMetadata1([string $contentType = self::contentTypes['protectedResourceMetadata1'][0] ]) : array<string, object>
Parameters
$contentType : string = self::contentTypes['protectedResourceMetadata1'][0]

The value for the Content-Type header. Check self::contentTypes['protectedResourceMetadata1'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string, object> —

protectedResourceMetadata1Async()

Operation protectedResourceMetadata1Async

public protectedResourceMetadata1Async([string $contentType = self::contentTypes['protectedResourceMetadata1'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['protectedResourceMetadata1'][0]

The value for the Content-Type header. Check self::contentTypes['protectedResourceMetadata1'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

protectedResourceMetadata1AsyncWithHttpInfo()

Operation protectedResourceMetadata1AsyncWithHttpInfo

public protectedResourceMetadata1AsyncWithHttpInfo([string $contentType = self::contentTypes['protectedResourceMetadata1'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['protectedResourceMetadata1'][0]

The value for the Content-Type header. Check self::contentTypes['protectedResourceMetadata1'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

protectedResourceMetadata1Request()

Create request for operation 'protectedResourceMetadata1'

public protectedResourceMetadata1Request([string $contentType = self::contentTypes['protectedResourceMetadata1'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['protectedResourceMetadata1'][0]

The value for the Content-Type header. Check self::contentTypes['protectedResourceMetadata1'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

protectedResourceMetadata1WithHttpInfo()

Operation protectedResourceMetadata1WithHttpInfo

public protectedResourceMetadata1WithHttpInfo([string $contentType = self::contentTypes['protectedResourceMetadata1'][0] ]) : array<string|int, mixed>
Parameters
$contentType : string = self::contentTypes['protectedResourceMetadata1'][0]

The value for the Content-Type header. Check self::contentTypes['protectedResourceMetadata1'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of array<string,object>, HTTP status code, HTTP response headers (array of strings)

protectedResourceMetadataAsync()

Operation protectedResourceMetadataAsync

public protectedResourceMetadataAsync([string $contentType = self::contentTypes['protectedResourceMetadata'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['protectedResourceMetadata'][0]

The value for the Content-Type header. Check self::contentTypes['protectedResourceMetadata'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

protectedResourceMetadataAsyncWithHttpInfo()

Operation protectedResourceMetadataAsyncWithHttpInfo

public protectedResourceMetadataAsyncWithHttpInfo([string $contentType = self::contentTypes['protectedResourceMetadata'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['protectedResourceMetadata'][0]

The value for the Content-Type header. Check self::contentTypes['protectedResourceMetadata'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

protectedResourceMetadataRequest()

Create request for operation 'protectedResourceMetadata'

public protectedResourceMetadataRequest([string $contentType = self::contentTypes['protectedResourceMetadata'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['protectedResourceMetadata'][0]

The value for the Content-Type header. Check self::contentTypes['protectedResourceMetadata'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

protectedResourceMetadataWithHttpInfo()

Operation protectedResourceMetadataWithHttpInfo

public protectedResourceMetadataWithHttpInfo([string $contentType = self::contentTypes['protectedResourceMetadata'][0] ]) : array<string|int, mixed>
Parameters
$contentType : string = self::contentTypes['protectedResourceMetadata'][0]

The value for the Content-Type header. Check self::contentTypes['protectedResourceMetadata'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of array<string,object>, HTTP status code, HTTP response headers (array of strings)

register()

Operation register

public register(McpOAuthClientRegistrationOptions $mcp_o_auth_client_registration_options[, string $contentType = self::contentTypes['register'][0] ]) : object
Parameters
$mcp_o_auth_client_registration_options : McpOAuthClientRegistrationOptions

mcp_o_auth_client_registration_options (required)

$contentType : string = self::contentTypes['register'][0]

The value for the Content-Type header. Check self::contentTypes['register'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

registerAsync()

Operation registerAsync

public registerAsync(McpOAuthClientRegistrationOptions $mcp_o_auth_client_registration_options[, string $contentType = self::contentTypes['register'][0] ]) : PromiseInterface
Parameters
$mcp_o_auth_client_registration_options : McpOAuthClientRegistrationOptions

(required)

$contentType : string = self::contentTypes['register'][0]

The value for the Content-Type header. Check self::contentTypes['register'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

registerAsyncWithHttpInfo()

Operation registerAsyncWithHttpInfo

public registerAsyncWithHttpInfo(McpOAuthClientRegistrationOptions $mcp_o_auth_client_registration_options[, string $contentType = self::contentTypes['register'][0] ]) : PromiseInterface
Parameters
$mcp_o_auth_client_registration_options : McpOAuthClientRegistrationOptions

(required)

$contentType : string = self::contentTypes['register'][0]

The value for the Content-Type header. Check self::contentTypes['register'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

registerRequest()

Create request for operation 'register'

public registerRequest(McpOAuthClientRegistrationOptions $mcp_o_auth_client_registration_options[, string $contentType = self::contentTypes['register'][0] ]) : Request
Parameters
$mcp_o_auth_client_registration_options : McpOAuthClientRegistrationOptions

(required)

$contentType : string = self::contentTypes['register'][0]

The value for the Content-Type header. Check self::contentTypes['register'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

registerWithHttpInfo()

Operation registerWithHttpInfo

public registerWithHttpInfo(McpOAuthClientRegistrationOptions $mcp_o_auth_client_registration_options[, string $contentType = self::contentTypes['register'][0] ]) : array<string|int, mixed>
Parameters
$mcp_o_auth_client_registration_options : McpOAuthClientRegistrationOptions

(required)

$contentType : string = self::contentTypes['register'][0]

The value for the Content-Type header. Check self::contentTypes['register'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index

public setHostIndex(int $hostIndex) : void
Parameters
$hostIndex : int

Host index (required)

Return values
void —

token()

Operation token

public token(string $grant_type, string $client_id, string $resource[, string $code = null ][, string $redirect_uri = null ][, string $code_verifier = null ][, string $refresh_token = null ][, string $contentType = self::contentTypes['token'][0] ]) : object
Parameters
$grant_type : string

grant_type (required)

$client_id : string

client_id (required)

$resource : string

resource (required)

$code : string = null

code (optional)

$redirect_uri : string = null

redirect_uri (optional)

$code_verifier : string = null

code_verifier (optional)

$refresh_token : string = null

refresh_token (optional)

$contentType : string = self::contentTypes['token'][0]

The value for the Content-Type header. Check self::contentTypes['token'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

tokenAsync()

Operation tokenAsync

public tokenAsync(string $grant_type, string $client_id, string $resource[, string $code = null ][, string $redirect_uri = null ][, string $code_verifier = null ][, string $refresh_token = null ][, string $contentType = self::contentTypes['token'][0] ]) : PromiseInterface
Parameters
$grant_type : string

(required)

$client_id : string

(required)

$resource : string

(required)

$code : string = null

(optional)

$redirect_uri : string = null

(optional)

$code_verifier : string = null

(optional)

$refresh_token : string = null

(optional)

$contentType : string = self::contentTypes['token'][0]

The value for the Content-Type header. Check self::contentTypes['token'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

tokenAsyncWithHttpInfo()

Operation tokenAsyncWithHttpInfo

public tokenAsyncWithHttpInfo(string $grant_type, string $client_id, string $resource[, string $code = null ][, string $redirect_uri = null ][, string $code_verifier = null ][, string $refresh_token = null ][, string $contentType = self::contentTypes['token'][0] ]) : PromiseInterface
Parameters
$grant_type : string

(required)

$client_id : string

(required)

$resource : string

(required)

$code : string = null

(optional)

$redirect_uri : string = null

(optional)

$code_verifier : string = null

(optional)

$refresh_token : string = null

(optional)

$contentType : string = self::contentTypes['token'][0]

The value for the Content-Type header. Check self::contentTypes['token'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

tokenRequest()

Create request for operation 'token'

public tokenRequest(string $grant_type, string $client_id, string $resource[, string $code = null ][, string $redirect_uri = null ][, string $code_verifier = null ][, string $refresh_token = null ][, string $contentType = self::contentTypes['token'][0] ]) : Request
Parameters
$grant_type : string

(required)

$client_id : string

(required)

$resource : string

(required)

$code : string = null

(optional)

$redirect_uri : string = null

(optional)

$code_verifier : string = null

(optional)

$refresh_token : string = null

(optional)

$contentType : string = self::contentTypes['token'][0]

The value for the Content-Type header. Check self::contentTypes['token'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

tokenWithHttpInfo()

Operation tokenWithHttpInfo

public tokenWithHttpInfo(string $grant_type, string $client_id, string $resource[, string $code = null ][, string $redirect_uri = null ][, string $code_verifier = null ][, string $refresh_token = null ][, string $contentType = self::contentTypes['token'][0] ]) : array<string|int, mixed>
Parameters
$grant_type : string

(required)

$client_id : string

(required)

$resource : string

(required)

$code : string = null

(optional)

$redirect_uri : string = null

(optional)

$code_verifier : string = null

(optional)

$refresh_token : string = null

(optional)

$contentType : string = self::contentTypes['token'][0]

The value for the Content-Type header. Check self::contentTypes['token'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed> —

of http client options

Search results