Configuration

Warning

Use the provided key pair only for development and testing purposes! Check the quick start section for information on how to create your own key pair.

enabled

Type: bool
Default: true
Path: Site settings oauth2_server.enabled

Enable oauth2 server.

privateKey

Type: string
Required: true
Default: EXT:oauth2_server/Resources/Private/Keys/private.key
Path: Site settings oauth2_server.privateKey or extension configuration $GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['oauth2_server']['privateKey']

Path to the private key file.

publicKey

Type: string
Required: true
Default: EXT:oauth2_server/Resources/Private/Keys/public.key
Path: Site settings oauth2_server.publicKey or extension configuration $GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['oauth2_server']['publicKey']

Path to the public key file.

routePrefix

Type: string
Default: oauth2
Path: Site settings oauth2_server.routePrefix

Prefix for the OAuth2 server routes.

accessTokensExpireIn

Type: string
Default: PT1H
Path: Site settings oauth2_server.accessTokensExpireIn

Access token lifetime, default is 1 hour.

refreshTokensExpireIn

Type: string
Default: P1M
Path: Site settings oauth2_server.refreshTokensExpireIn

Refresh token lifetime, default is 1 month.

requireCodeChallengeForPublicClients

Type: string
Default: true
Path: Site settings oauth2_server.requireCodeChallengeForPublicClients

Requires code challenge for public clients by default.

consentPageUid

Type: string
Required: true
Default: null
Path: Site settings oauth2_server.consentPageUid or extension configuration $GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['oauth2_server']['consentPageUid']

Page UID of the consent page.

loginPageUid

Type: string
Required: true
Default: null
Path: Site settings oauth2_server.loginPageUid or extension configuration $GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['oauth2_server']['loginPageUid']

Page UID of the login page.

scopes

Type: array
Default: []
Path: Site settings oauth2_server.scopes

List of scopes.

oauth2_server:
  scopes:
    - { identifier: 'read', consent: true, description: 'Read access' }

resources

Type: array
Default: []
Path: Site settings oauth2_server.resources

List of yaml configuration files with resource routes.