Token Expiration Policy - OAuth Authentication

The expiration policy for OAuth tokens is controlled by CAS settings and properties. Note that while access and refresh tokens may have their own lifetime and expiration policy, they are typically upper-bound to the length of the CAS single sign-on session.

OAuth Codes

The following settings and properties are available from the CAS configuration catalog:

cas.authn.oauth.code.number-of-usesNumber of times this code is valid and can be used.
1

Number of times this code is valid and can be used.

Type
Integer
Default
1
Defined by
OAuthCodeProperties
cas.authn.oauth.code.remove-related-access-tokensRevoke the access and refresh tokens issued from an authorization code when the code is presented again after it was redeemed, as RFC 6749 recommends.
false

Revoke the access and refresh tokens issued from an authorization code when the code is presented again after it was redeemed, as RFC 6749 recommends. When enabled, CAS keeps a short-lived record of the tokens issued from each code it redeems, for as long as transient session tickets live, and revokes them when the code is presented again.

Type
Boolean
Default
false
Defined by
OAuthCodeProperties
cas.authn.oauth.code.storage-nameThe storage object name used and created by CAS to hold OAuth codes in the backing ticket registry implementation.
oauthCodesCache

The storage object name used and created by CAS to hold OAuth codes in the backing ticket registry implementation.

Type
String
Default
oauthCodesCache
Defined by
OAuthCodeProperties
cas.authn.oauth.code.time-to-kill-in-secondsDuration in seconds where the code is valid.
30

Duration in seconds where the code is valid.

Type
Long
Default
30
Defined by
OAuthCodeProperties

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Notes on configuration

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

:information_source: Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

OAuth Access Tokens

The following settings and properties are available from the CAS configuration catalog:

cas.authn.oauth.access-token.crypto.encryption.keyThe encryption key is a string whose length is defined by the encryption key size setting.
no default
RequiredSpEL

The encryption key is a string whose length is defined by the encryption key size setting.

Type
String
Default
none
Defined by
EncryptionJwtCryptoProperties
Supports
Spring Expression Language
cas.authn.oauth.access-token.crypto.signing.keyThe signing key is a string whose length is defined by the signing key size setting.
no default
RequiredSpEL

The signing key is a string whose length is defined by the signing key size setting.

Type
String
Default
none
Defined by
SigningJwtCryptoProperties
Supports
Spring Expression Language
cas.authn.oauth.access-token.create-as-jwtCreate access token as JWTs.
false

Create access token as JWTs.

Type
Boolean
Default
false
Defined by
OAuthAccessTokenProperties
cas.authn.oauth.access-token.crypto.algThe signing/encryption algorithm to use.
no default

The signing/encryption algorithm to use.

Type
String
Default
none
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.access-token.crypto.enabledWhether crypto operations are enabled.
true

Whether crypto operations are enabled.

Type
Boolean
Default
true
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.access-token.crypto.encryption-enabledWhether crypto encryption operations are enabled.
true

Whether crypto encryption operations are enabled.

Type
Boolean
Default
true
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.access-token.crypto.encryption.key-sizeThe encryption key size.
512

The encryption key size.

Type
Integer
Default
512
Defined by
EncryptionJwtCryptoProperties
cas.authn.oauth.access-token.crypto.signing-enabledWhether crypto signing operations are enabled.
true

Whether crypto signing operations are enabled.

Type
Boolean
Default
true
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.access-token.crypto.signing.key-sizeThe signing key size.
512

The signing key size.

Type
Integer
Default
512
Defined by
SigningJwtCryptoProperties
cas.authn.oauth.access-token.crypto.strategy-typeControl the cipher sequence of operations.
ENCRYPT_AND_SIGN
Control the cipher sequence of operations. The accepted values are:
  • ENCRYPT_AND_SIGN: Encrypt the value first, and then sign.
  • SIGN_AND_ENCRYPT: Sign the value first, and then encrypt.
Type
String
Default
ENCRYPT_AND_SIGN
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.access-token.include-claims-in-jwtWhether CAS should include extra CAS attributes as claims in the JWT access token.
true

Whether CAS should include extra CAS attributes as claims in the JWT access token. This setting is only relevant if the access token is a determined to be a JWT.

Type
Boolean
Default
true
Defined by
OAuthAccessTokenProperties
cas.authn.oauth.access-token.max-active-tokens-allowedMaximum number of active access tokens that an application can receive.
0

Maximum number of active access tokens that an application can receive. If the application requests more that this limit, the request will be denied and the access token will not be issued.

Type
Long
Default
0
Defined by
OAuthAccessTokenProperties
cas.authn.oauth.access-token.max-time-to-live-in-secondsHard timeout to kill the access token and expire it.
PT8H
Duration

Hard timeout to kill the access token and expire it.

Type
String
Default
PT8H
Defined by
OAuthAccessTokenProperties
cas.authn.oauth.access-token.storage-nameThe storage object name used and created by CAS to hold OAuth access tokens in the backing ticket registry implementation.
oauthAccessTokensCache

The storage object name used and created by CAS to hold OAuth access tokens in the backing ticket registry implementation.

Type
String
Default
oauthAccessTokensCache
Defined by
OAuthAccessTokenProperties
cas.authn.oauth.access-token.time-to-kill-in-secondsSliding window for the access token expiration policy.
PT2H
Duration

Sliding window for the access token expiration policy. Essentially, this is an idle time out.

Type
String
Default
PT2H
Defined by
OAuthAccessTokenProperties

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Signing & encryption

This CAS feature is able to accept signing and encryption crypto keys. In most scenarios if keys are not provided, CAS will auto-generate them. The following instructions apply if you wish to manually and beforehand create the signing and encryption keys.

Note that if you are asked to create a JWK of a certain size for the key, you are to use the following set of commands to generate the token:

1
2
wget https://raw.githubusercontent.com/apereo/cas/master/etc/jwk-gen.jar
java -jar jwk-gen.jar -t oct -s [size]

The outcome would be similar to:

1
2
3
4
5
{
  "kty": "oct",
  "kid": "...",
  "k": "..."
}

The generated value for k needs to be assigned to the relevant CAS settings. Note that keys generated via the above algorithm are processed by CAS using the Advanced Encryption Standard (AES) algorithm which is a specification for the encryption of electronic data established by the U.S. National Institute of Standards and Technology.


Notes on configuration

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

:information_source: Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

OAuth Device Tokens

The following settings and properties are available from the CAS configuration catalog:

cas.authn.oauth.device-token.max-time-to-live-in-secondsHard timeout to kill the device token and expire it.
PT5M
Duration

Hard timeout to kill the device token and expire it.

Type
String
Default
PT5M
Defined by
OAuthDeviceTokenProperties
cas.authn.oauth.device-token.refresh-intervalThe device refresh interval.
PT15S
Duration

The device refresh interval. The client should attempt to acquire an access token every few seconds (at a rate specified by interval) by POSTing to the access token endpoint on the server.

Type
String
Default
PT15S
Defined by
OAuthDeviceTokenProperties
cas.authn.oauth.device-token.storage-nameThe storage object name used and created by CAS to hold OAuth device tokens in the backing ticket registry implementation.
oauthDeviceTokensCache

The storage object name used and created by CAS to hold OAuth device tokens in the backing ticket registry implementation.

Type
String
Default
oauthDeviceTokensCache
Defined by
OAuthDeviceTokenProperties

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Notes on configuration

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

:information_source: Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

OAuth Refresh Tokens

The following settings and properties are available from the CAS configuration catalog:

cas.authn.oauth.refresh-token.create-as-jwtCreate access token as JWTs.
false

Create access token as JWTs.

Type
Boolean
Default
false
Defined by
OAuthRefreshTokenProperties
cas.authn.oauth.refresh-token.max-active-tokens-allowedMaximum number of active refresh tokens that an application can receive.
0

Maximum number of active refresh tokens that an application can receive. If the application requests more that this limit, the request will be denied and the access token will not be issued.

Type
Long
Default
0
Defined by
OAuthRefreshTokenProperties
cas.authn.oauth.refresh-token.storage-nameThe storage object name used and created by CAS to hold OAuth refresh tokens in the backing ticket registry implementation.
oauthRefreshTokensCache

The storage object name used and created by CAS to hold OAuth refresh tokens in the backing ticket registry implementation.

Type
String
Default
oauthRefreshTokensCache
Defined by
OAuthRefreshTokenProperties
cas.authn.oauth.refresh-token.time-to-kill-in-secondsHard timeout beyond which the refresh token is considered expired.
P14D
Duration

Hard timeout beyond which the refresh token is considered expired.

Type
String
Default
P14D
Defined by
OAuthRefreshTokenProperties
cas.authn.oauth.refresh-token.track-access-tokensIf true, the refresh token will keep track of the access tokens issued using it.
true

If true, the refresh token will keep track of the access tokens issued using it. The access tokens will remain attached to the refresh token as long as the refresh token is valid and they are not periodically on on-demand checked for validity or removed from the refresh token if they expire. The tracking mechanism is only for history and auditing purposes.

Type
Boolean
Default
true
Defined by
OAuthRefreshTokenProperties

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Notes on configuration

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

:information_source: Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

OAuth Device User Codes

The following settings and properties are available from the CAS configuration catalog:

cas.authn.oauth.device-user-code.max-time-to-live-in-secondsHard timeout to kill the token and expire it.
PT1M
Duration

Hard timeout to kill the token and expire it.

Type
String
Default
PT1M
Defined by
OAuthDeviceUserCodeProperties
cas.authn.oauth.device-user-code.storage-nameThe storage object name used and created by CAS to hold OAuth device user codes in the backing ticket registry implementation.
oauthDeviceUserCodesCache

The storage object name used and created by CAS to hold OAuth device user codes in the backing ticket registry implementation.

Type
String
Default
oauthDeviceUserCodesCache
Defined by
OAuthDeviceUserCodeProperties
cas.authn.oauth.device-user-code.user-code-lengthLength of the generated user code.
8

Length of the generated user code.

Type
Integer
Default
8
Defined by
OAuthDeviceUserCodeProperties

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Notes on configuration

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

:information_source: Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

Per Service

The expiration policy of certain OAuth tokens can be conditionally decided on a per-application basis. The candidate service whose token expiration policy is to deviate from the default configuration must be designed as the following snippets demonstrate.

  • The expiration policy of codes can be defined on a per application basis:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    
    {
      "@class" : "org.apereo.cas.support.oauth.services.OAuthRegisteredService",
      "clientId": "clientid",
      "clientSecret": "clientSecret",
      "serviceId" : "^(https|imaps)://<redirect-uri>.*",
      "name" : "OAuthService",
      "id" : 100,
      "codeExpirationPolicy": {
        "@class": "org.apereo.cas.support.oauth.services.DefaultRegisteredServiceOAuthCodeExpirationPolicy",
        "numberOfUses": 1,
        "timeToLive": "PT10S"
      }
    }
    
  • The expiration policy of access tokens can be defined on a per application basis:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    
    {
      "@class" : "org.apereo.cas.support.oauth.services.OAuthRegisteredService",
      "clientId": "clientid",
      "clientSecret": "clientSecret",
      "serviceId" : "^(https|imaps)://<redirect-uri>.*",
      "name" : "OAuthService",
      "id" : 100,
      "accessTokenExpirationPolicy": {
        "@class": "org.apereo.cas.support.oauth.services.DefaultRegisteredServiceOAuthAccessTokenExpirationPolicy",
        "maxTimeToLive": "PT1000S",
        "timeToKill": "PT100S",
        "maxActiveTokens": 0
      }
    }
    
  • The expiration policy of device tokens can be defined on a per application basis:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    
    {
      "@class" : "org.apereo.cas.support.oauth.services.OAuthRegisteredService",
      "clientId": "clientid",
      "clientSecret": "clientSecret",
      "serviceId" : "^(https|imaps)://<redirect-uri>.*",
      "name" : "OAuthService",
      "id" : 100,
      "deviceTokenExpirationPolicy": {
        "@class": "org.apereo.cas.support.oauth.services.DefaultRegisteredServiceOAuthDeviceTokenExpirationPolicy",
        "timeToKill": "PT100S"
      }
    }
    
  • The expiration policy of refresh tokens can be defined on a per application basis:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    
    {
      "@class" : "org.apereo.cas.support.oauth.services.OAuthRegisteredService",
      "clientId": "clientid",
      "clientSecret": "clientSecret",
      "serviceId" : "^(https|imaps)://<redirect-uri>.*",
      "name" : "OAuthService",
      "id" : 100,
      "refreshTokenExpirationPolicy": {
        "@class": "org.apereo.cas.support.oauth.services.DefaultRegisteredServiceOAuthRefreshTokenExpirationPolicy",
        "timeToKill": "PT100S",
        "maxActiveTokens": 0
      }
    }