Enables scripted content fragments to use OAuth clients

Properties

NameTypeDescriptionDefaultOptions
CurrentOAuthClientCurrent contextual OAuth client

Methods

Authorize

Authorizes a client to use your account for the provided scope. Returns the URL to redirect back to for the client

Usage

#set($stringResponse = $core_v2_oauthClient.Authorize($clientId, $callbackUrl, $responseType, $scope, $state))

Parameters

NameTypeDescriptionRequiredDefaultOptions
clientIdGuidClient IdRequired
callbackUrlstringCallback UrlRequired
responseTypestringResponse TypeRequired
scopestringScopeRequired
statestringStateRequired

Return Type

string

Get

Gets a OAuth Client

Usage

#set($oAuthClientResponse = $core_v2_oauthClient.Get($clientId))

Parameters

NameTypeDescriptionRequiredDefaultOptions
clientIdGuidClient IdRequired

Return Type

OAuthClient