☰ Browse the reference

Model·OAuth module

RefreshToken

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

OAuth\Models\Frontend\RefreshTokenCopy OAuth\Models\Api\RefreshTokenCopy OAuth\Models\Backend\RefreshTokenCopy Also in OAuth: AccessToken AuthorizationCode CimdClient Client DcrClient Passkey RegisteredClient RememberMeToken UserAuthenticator UserOauthClient

View

Templates15 API & Jobs11 Admin15

What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Filter

Templates view

Properties 14

Take no arguments.

# isValid()

bool

Is refresh token valid?

# getId()

?int

# getExpiryDate()

?DateTime

# getCreated()

?DateTime

Date the record was created.

# getModified()

?DateTime

Last modification date for the record.

# getMaxUses()

?int

# getUseCount()

?int

# getScope()

?string

# getApp()

?Client

# getUser()

?User

# getAccessTokens()

?Collection<AccessToken>

# 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 11

Read-only values on the record.

# valid

bool

Is refresh token valid?

# id

?int

# expiryDate

?DateTime

# created

?DateTime

Date the record was created.

# modified

?DateTime

Last modification date for the record.

# maxUses

?int

# useCount

?int

# scope

?string

# app

?Client

# user

?User

# accessTokens

?Collection<AccessToken>

Admin view

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

Properties 14

Take no arguments.

# isValid()

bool

Is refresh token valid?

# getId()

?int

# getExpiryDate()

?DateTime

# getCreated()

?DateTime

Date the record was created.

# getModified()

?DateTime

Last modification date for the record.

# getMaxUses()

?int

# getUseCount()

?int

# getScope()

?string

# getApp()

?Client

# getUser()

?User

# getAccessTokens()

?Collection<AccessToken>

# 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?