ModelOAuth module

UserAuthenticator

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

OAuth\Models\Frontend\UserAuthenticator OAuth\Models\Api\UserAuthenticator OAuth\Models\Backend\UserAuthenticator Also in OAuth: AccessToken AuthorizationCode CimdClient Client DcrClient Passkey RefreshToken RegisteredClient RememberMeToken UserOauthClient
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 13

Take no arguments.

# isAccessTokenValid()
bool
Is access token valid?
# getId()
?int
# getCategory()
int
# getAuthenticatorClassName()
?string
# getExternalUserId()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getAccessTokenExpiryDate()
?DateTime
# getUser()
?User
# getPasskeys()
?Collection<Passkey>
# 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

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 10

Read-only values on the record.

# accessTokenValid
bool
Is access token valid?
# id
?int
# category
int
# authenticatorClassName
?string
# externalUserId
?string
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# accessTokenExpiryDate
?DateTime
# user
?User
# passkeys
?Collection<Passkey>

Admin view

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

Properties 13

Take no arguments.

# isAccessTokenValid()
bool
Is access token valid?
# getId()
?int
# getCategory()
int
# getAuthenticatorClassName()
?string
# getExternalUserId()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getAccessTokenExpiryDate()
?DateTime
# getUser()
?User
# getPasskeys()
?Collection<Passkey>
# 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