CiviGenericProvider
extends GenericProvider
in package
Class CiviGenericProvider
Table of Contents
Properties
- $tenant : string
Methods
- getBaseAccessTokenUrl() : string
- Returns the base URL for requesting an access token.
- getBaseAuthorizationUrl() : string
- Returns the base URL for authorizing a client.
- fetchResourceOwnerDetails() : mixed
- Requests resource owner details.
- getAuthorizationParameters() : mixed
- decodeUnauthenticatedJwt() : mixed
- replaceTenantToken() : string
- Replace {{tenant}} in the endpoint URLs with 'common' for consumer accounts or the tenancy ID for dedicated services.
Properties
$tenant
protected
string
$tenant
Methods
getBaseAccessTokenUrl()
Returns the base URL for requesting an access token.
public
getBaseAccessTokenUrl(array<string|int, mixed> $params) : string
Eg. https://oauth.service.com/token
Parameters
- $params : array<string|int, mixed>
Return values
stringgetBaseAuthorizationUrl()
Returns the base URL for authorizing a client.
public
getBaseAuthorizationUrl() : string
Eg. https://oauth.service.com/authorize
Return values
stringfetchResourceOwnerDetails()
Requests resource owner details.
protected
fetchResourceOwnerDetails(AccessToken $token) : mixed
Parameters
- $token : AccessToken
getAuthorizationParameters()
protected
getAuthorizationParameters(array<string|int, mixed> $options) : mixed
Parameters
- $options : array<string|int, mixed>
decodeUnauthenticatedJwt()
private
decodeUnauthenticatedJwt(mixed $t) : mixed
Parameters
- $t : mixed
replaceTenantToken()
Replace {{tenant}} in the endpoint URLs with 'common' for consumer accounts or the tenancy ID for dedicated services.
private
replaceTenantToken(string $str) : string
Parameters
- $str : string
-
URL to replace