Enables scripted content fragments to use OAuth clients
Properties
Name | Access | Type | Description |
---|---|---|---|
Current | Read | OAuthClient | Current contextual OAuth client |
Methods
Authorize
Authorize Overload 1
Obsolete in 12
Velocity
#set($stringResponse = $core_v2_oauthClient.Authorize($clientId, $callbackUrl, $responseType, $scope, $state))
JavaScript
var stringResponse = core_v2_oauthClient.Authorize(clientId, callbackUrl, responseType, scope, state);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
clientId | Guid | Client Id | Required | ||
callbackUrl | String | Callback Url | Required | ||
responseType | String | Response Type | Required | ||
scope | String | Scope | Required | ||
state | String | State | Required |
Authorize Overload 2
Velocity
#set($stringResponse = $core_v2_oauthClient.Authorize($clientId, $callbackUrl, $responseType, "%{}"))
JavaScript
var stringResponse = core_v2_oauthClient.Authorize(clientId, callbackUrl, responseType, {});
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
clientId | Guid | Client Id | Required | ||
callbackUrl | String | Callback Url | Required | ||
responseType | String | Response Type | Required | ||
options | Options | Set of optional parameters including: | Required |
Returns
String
Deny
Returns a URL to redirect back to the client when denying a request to use your account for the provided scope.
Velocity
#set($stringResponse = $core_v2_oauthClient.Deny($clientId, $callbackUrl, $responseType, $scope, $state))
JavaScript
var stringResponse = core_v2_oauthClient.Deny(clientId, callbackUrl, responseType, scope, state);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
clientId | Guid | Client Id | Required | ||
callbackUrl | String | Callback Url | Required | ||
responseType | String | Response Type | Required | ||
scope | String | Scope | Required | ||
state | String | State | Required |
Returns
String
Get
Gets a OAuth Client
Velocity
#set($oAuthClientResponse = $core_v2_oauthClient.Get($clientId))
JavaScript
var oAuthClientResponse = core_v2_oauthClient.Get(clientId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
clientId | Guid | Client Id | Required |
Returns
Validate
Validate Overload 1
Obsolete in 12
Velocity
#set($stringResponse = $core_v2_oauthClient.Validate($callbackUrl, $responseType, $scope, $state))
JavaScript
var stringResponse = core_v2_oauthClient.Validate(callbackUrl, responseType, scope, state);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
callbackUrl | String | Callback Url | Required | ||
responseType | String | Response Type | Required | ||
scope | String | Scope | Required | ||
state | String | State | Required |
Validate Overload 2
Velocity
#set($stringResponse = $core_v2_oauthClient.Validate($clientId, $callbackUrl, $responseType, "%{}"))
JavaScript
var stringResponse = core_v2_oauthClient.Validate(clientId, callbackUrl, responseType, {});
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
clientId | Guid | Client Id | Required | ||
callbackUrl | String | Callback Url | Required | ||
responseType | String | Response Type | Required | ||
options | Options | Set of optional parameters including: | Required |
Returns
String