ModelOAuth module

UserOauthClient

OAuthUserClient

A model in the OAuth module, with 9 members for templates, 5 API properties and 9 members for admin templates.

OAuth\Models\Frontend\UserOauthClient OAuth\Models\Api\UserOauthClient OAuth\Models\Backend\UserOauthClient Also in OAuth: AccessToken AuthorizationCode CimdClient Client DcrClient Passkey RefreshToken RegisteredClient RememberMeToken UserAuthenticator
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 8

Take no arguments.

# getId()
?int
# getScope()
?string
# getConsentDate()
?DateTime
# getApp()
?Client
# getUser()
?User
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

Methods 1

Take arguments. The API serialises only getters that need none.

# hasScopeIncluded(string $scope)
bool
Does this record have this scope?

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 5

Read-only values on the record.

# id
?int
# scope
?string
# consentDate
?DateTime
# app
?Client
# user
?User

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 8

Take no arguments.

# getId()
?int
# getScope()
?string
# getConsentDate()
?DateTime
# getApp()
?Client
# getUser()
?User
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

Methods 1

Take arguments. The API serialises only getters that need none.

# hasScopeIncluded(string $scope)
bool
Does this record have this scope?