ModelOAuth module

Client

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

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

Templates view

Properties 16

Take no arguments.

# isAuthorizationCodeGrantTypeAllowed(): bool; Is Authorization Code grant type allowed for client?
# isRefreshTokenGrantTypeAllowed(): bool; Is Refresh Token grant type allowed for client?
# getId(): ?int
# getName(): ?string
# getOauthClientId(): ?string
# getAllowedGrantTypes(): ?array
# getAllowedRedirectUrls(): ?array
# getAllowedScopes(): ?array
# isConfidential(): bool
# getCreated(): ?DateTime; Date the record was created.
# getModified(): ?DateTime; Last modification date for the record.
# getRefreshTokens(): ?Collection<RefreshToken>
# 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

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 13

Read-only values on the record.

# authorizationCodeGrantTypeAllowed: bool; Is Authorization Code grant type allowed for client?
# refreshTokenGrantTypeAllowed: bool; Is Refresh Token grant type allowed for client?
# id: ?int
# name: ?string
# oauthClientId: ?string
# allowedGrantTypes: ?array
# allowedRedirectUrls: ?array
# allowedScopes: ?array
# confidential: bool
# created: ?DateTime; Date the record was created.
# modified: ?DateTime; Last modification date for the record.
# refreshTokens: ?Collection<RefreshToken>
# 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 23