Overview
CAS takes advantages of Swagger to produce API documentation automatically. The generated documentation supports all CAS endpoints and REST APIs provided they are made available to the runtime application context and are present in the overlay.
Support is enabled by including the following dependency in the overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-swagger</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-swagger:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-swagger"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references should be included automatically and are listed here for reference only.
implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
*/
implementation "org.apereo.cas:cas-server-support-swagger"
}
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- Groovy Scripting
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Third Party
- Notes
springdoc.api-docs.enabled=true
Whether to generate and serve an OpenAPI document.
CAS Property:
|
1 |
springdoc.api-docs.enabled=true |
1
springdoc:
api-docs:
enabled: "true"
1
java -Dspringdoc.api-docs.enabled="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_API_DOCS_ENABLED="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.api-docs.enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.api-docs.groups.enabled=false
The Enabled.
org.springdoc.core.properties.SpringDocConfigProperties$Groups.
CAS Property: springdoc.api-docs.groups.enabled
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.
.properties
files:
1
springdoc.api-docs.groups.enabled=...
1
springdoc:
api-docs:
groups:
enabled: "..."
1
java -Dspringdoc.api-docs.groups.enabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_API_DOCS_GROUPS_ENABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.api-docs.groups.enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.api-docs.path=
Path to the generated OpenAPI documentation. For a yaml file, append ".yaml" to the path.
org.springdoc.core.properties.SpringDocConfigProperties$ApiDocs.
CAS Property: springdoc.api-docs.path
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.
.properties
files:
1
springdoc.api-docs.path=...
1
springdoc:
api-docs:
path: "..."
1
java -Dspringdoc.api-docs.path="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_API_DOCS_PATH="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.api-docs.path="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.api-docs.resolve-extensions-properties=false
The Resolve extensions properties.
org.springdoc.core.properties.SpringDocConfigProperties$ApiDocs.
CAS Property: springdoc.api-docs.resolve-extensions-properties
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.
.properties
files:
1
springdoc.api-docs.resolve-extensions-properties=...
1
springdoc:
api-docs:
resolve-extensions-properties: "..."
1
java -Dspringdoc.api-docs.resolve-extensions-properties="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_API_DOCS_RESOLVE_EXTENSIONS_PROPERTIES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.api-docs.resolve-extensions-properties="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.api-docs.resolve-schema-properties=false
The Resolve schema properties.
org.springdoc.core.properties.SpringDocConfigProperties$ApiDocs.
CAS Property: springdoc.api-docs.resolve-schema-properties
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.
.properties
files:
1
springdoc.api-docs.resolve-schema-properties=...
1
springdoc:
api-docs:
resolve-schema-properties: "..."
1
java -Dspringdoc.api-docs.resolve-schema-properties="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_API_DOCS_RESOLVE_SCHEMA_PROPERTIES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.api-docs.resolve-schema-properties="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.api-docs.version=
The OpenAPI version.
org.springdoc.core.properties.SpringDocConfigProperties$ApiDocs.
CAS Property: springdoc.api-docs.version
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.
.properties
files:
1
springdoc.api-docs.version=...
1
springdoc:
api-docs:
version: "..."
1
java -Dspringdoc.api-docs.version="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_API_DOCS_VERSION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.api-docs.version="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.auto-tag-classes=true
The Auto tag classes.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.auto-tag-classes
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.
.properties
files:
1
springdoc.auto-tag-classes=true
1
springdoc:
auto-tag-classes: "true"
1
java -Dspringdoc.auto-tag-classes="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_AUTO_TAG_CLASSES="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.auto-tag-classes="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.cache.disabled=false
The Disabled.
org.springdoc.core.properties.SpringDocConfigProperties$Cache.
CAS Property: springdoc.cache.disabled
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.
.properties
files:
1
springdoc.cache.disabled=...
1
springdoc:
cache:
disabled: "..."
1
java -Dspringdoc.cache.disabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_CACHE_DISABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.cache.disabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.consumes-to-match=
The Consumes to match.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.consumes-to-match
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.
.properties
files:
1
springdoc.consumes-to-match=...
1
springdoc:
consumes-to-match: "..."
1
java -Dspringdoc.consumes-to-match="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_CONSUMES_TO_MATCH="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.consumes-to-match="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.default-consumes-media-type=
The Default consumes media type.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.default-consumes-media-type
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.
.properties
files:
1
springdoc.default-consumes-media-type=...
1
springdoc:
default-consumes-media-type: "..."
1
java -Dspringdoc.default-consumes-media-type="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_DEFAULT_CONSUMES_MEDIA_TYPE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.default-consumes-media-type="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.default-flat-param-object=false
The param default flatten
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.default-flat-param-object
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.
.properties
files:
1
springdoc.default-flat-param-object=...
1
springdoc:
default-flat-param-object: "..."
1
java -Dspringdoc.default-flat-param-object="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_DEFAULT_FLAT_PARAM_OBJECT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.default-flat-param-object="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.default-produces-media-type=
The Default produces media type.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.default-produces-media-type
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.
.properties
files:
1
springdoc.default-produces-media-type=...
1
springdoc:
default-produces-media-type: "..."
1
java -Dspringdoc.default-produces-media-type="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_DEFAULT_PRODUCES_MEDIA_TYPE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.default-produces-media-type="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.default-support-form-data=false
convert query param to form data when consumes is multipart/form-data
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.default-support-form-data
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.
.properties
files:
1
springdoc.default-support-form-data=...
1
springdoc:
default-support-form-data: "..."
1
java -Dspringdoc.default-support-form-data="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_DEFAULT_SUPPORT_FORM_DATA="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.default-support-form-data="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.disable-i18n=false
The Disable i18n.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.disable-i18n
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.
.properties
files:
1
springdoc.disable-i18n=...
1
springdoc:
disable-i18n: "..."
1
java -Dspringdoc.disable-i18n="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_DISABLE_I18N="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.disable-i18n="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.enable-data-rest=true
The Enable hateoas.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.enable-data-rest
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.
.properties
files:
1
springdoc.enable-data-rest=true
1
springdoc:
enable-data-rest: "true"
1
java -Dspringdoc.enable-data-rest="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_ENABLE_DATA_REST="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.enable-data-rest="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.enable-default-api-docs=true
The Enable default api docs.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.enable-default-api-docs
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.
.properties
files:
1
springdoc.enable-default-api-docs=true
1
springdoc:
enable-default-api-docs: "true"
1
java -Dspringdoc.enable-default-api-docs="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_ENABLE_DEFAULT_API_DOCS="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.enable-default-api-docs="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.enable-groovy=true
The Enable groovy.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.enable-groovy
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.
.properties
files:
1
springdoc.enable-groovy=true
1
springdoc:
enable-groovy: "true"
1
java -Dspringdoc.enable-groovy="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_ENABLE_GROOVY="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.enable-groovy="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.enable-hateoas=true
The Enable hateoas.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.enable-hateoas
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.
.properties
files:
1
springdoc.enable-hateoas=true
1
springdoc:
enable-hateoas: "true"
1
java -Dspringdoc.enable-hateoas="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_ENABLE_HATEOAS="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.enable-hateoas="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.enable-javadoc=true
The Enable javadoc.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.enable-javadoc
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.
.properties
files:
1
springdoc.enable-javadoc=true
1
springdoc:
enable-javadoc: "true"
1
java -Dspringdoc.enable-javadoc="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_ENABLE_JAVADOC="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.enable-javadoc="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.enable-kotlin=true
The Enable kotlin.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.enable-kotlin
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.
.properties
files:
1
springdoc.enable-kotlin=true
1
springdoc:
enable-kotlin: "true"
1
java -Dspringdoc.enable-kotlin="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_ENABLE_KOTLIN="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.enable-kotlin="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.enable-spring-security=true
The Enable spring security.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.enable-spring-security
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.
.properties
files:
1
springdoc.enable-spring-security=true
1
springdoc:
enable-spring-security: "true"
1
java -Dspringdoc.enable-spring-security="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_ENABLE_SPRING_SECURITY="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.enable-spring-security="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.group-configs=
The Group configs.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.group-configs
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.
.properties
files:
1
springdoc.group-configs=...
1
springdoc:
group-configs: "..."
1
java -Dspringdoc.group-configs="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_GROUP_CONFIGS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.group-configs="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.headers-to-match=
The Headers to match.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.headers-to-match
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.
.properties
files:
1
springdoc.headers-to-match=...
1
springdoc:
headers-to-match: "..."
1
java -Dspringdoc.headers-to-match="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_HEADERS_TO_MATCH="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.headers-to-match="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.model-and-view-allowed=false
The Model and view allowed.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.model-and-view-allowed
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.
.properties
files:
1
springdoc.model-and-view-allowed=...
1
springdoc:
model-and-view-allowed: "..."
1
java -Dspringdoc.model-and-view-allowed="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_MODEL_AND_VIEW_ALLOWED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.model-and-view-allowed="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.model-converters.deprecating-converter.enabled=false
The Enabled.
org.springdoc.core.properties.SpringDocConfigProperties$ModelConverters$DeprecatingConverter.
CAS Property: springdoc.model-converters.deprecating-converter.enabled
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.
.properties
files:
1
springdoc.model-converters.deprecating-converter.enabled=...
1
springdoc:
model-converters:
deprecating-converter:
enabled: "..."
1
java -Dspringdoc.model-converters.deprecating-converter.enabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_MODEL_CONVERTERS_DEPRECATING_CONVERTER_ENABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.model-converters.deprecating-converter.enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.model-converters.pageable-converter.enabled=false
The Enabled.
org.springdoc.core.properties.SpringDocConfigProperties$ModelConverters$PageableConverter.
CAS Property: springdoc.model-converters.pageable-converter.enabled
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.
.properties
files:
1
springdoc.model-converters.pageable-converter.enabled=...
1
springdoc:
model-converters:
pageable-converter:
enabled: "..."
1
java -Dspringdoc.model-converters.pageable-converter.enabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_MODEL_CONVERTERS_PAGEABLE_CONVERTER_ENABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.model-converters.pageable-converter.enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.model-converters.polymorphic-converter.enabled=false
The Enabled.
org.springdoc.core.properties.SpringDocConfigProperties$ModelConverters$PolymorphicConverter.
CAS Property: springdoc.model-converters.polymorphic-converter.enabled
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.
.properties
files:
1
springdoc.model-converters.polymorphic-converter.enabled=...
1
springdoc:
model-converters:
polymorphic-converter:
enabled: "..."
1
java -Dspringdoc.model-converters.polymorphic-converter.enabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_MODEL_CONVERTERS_POLYMORPHIC_CONVERTER_ENABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.model-converters.polymorphic-converter.enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.nullable-request-parameter-enabled=false
The Nullable request parameter enabled.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.nullable-request-parameter-enabled
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.
.properties
files:
1
springdoc.nullable-request-parameter-enabled=...
1
springdoc:
nullable-request-parameter-enabled: "..."
1
java -Dspringdoc.nullable-request-parameter-enabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_NULLABLE_REQUEST_PARAMETER_ENABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.nullable-request-parameter-enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.open-api=
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.open-api
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.
.properties
files:
1
springdoc.open-api=...
1
springdoc:
open-api: "..."
1
java -Dspringdoc.open-api="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_OPEN_API="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.open-api="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.override-with-generic-response=
The Override with generic response.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.override-with-generic-response
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.
.properties
files:
1
springdoc.override-with-generic-response=...
1
springdoc:
override-with-generic-response: "..."
1
java -Dspringdoc.override-with-generic-response="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_OVERRIDE_WITH_GENERIC_RESPONSE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.override-with-generic-response="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.packages-to-exclude=
The Packages to exclude.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.packages-to-exclude
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.
.properties
files:
1
springdoc.packages-to-exclude=...
1
springdoc:
packages-to-exclude: "..."
1
java -Dspringdoc.packages-to-exclude="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_PACKAGES_TO_EXCLUDE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.packages-to-exclude="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.packages-to-scan=
The Packages to scan.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.packages-to-scan
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.
.properties
files:
1
springdoc.packages-to-scan=...
1
springdoc:
packages-to-scan: "..."
1
java -Dspringdoc.packages-to-scan="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_PACKAGES_TO_SCAN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.packages-to-scan="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.paths-to-exclude=
The Paths to exclude.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.paths-to-exclude
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.
.properties
files:
1
springdoc.paths-to-exclude=...
1
springdoc:
paths-to-exclude: "..."
1
java -Dspringdoc.paths-to-exclude="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_PATHS_TO_EXCLUDE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.paths-to-exclude="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.paths-to-match=
The Paths to match.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.paths-to-match
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.
.properties
files:
1
springdoc.paths-to-match=...
1
springdoc:
paths-to-match: "..."
1
java -Dspringdoc.paths-to-match="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_PATHS_TO_MATCH="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.paths-to-match="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.pre-loading-enabled=false
Allow for pre-loading OpenAPI
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.pre-loading-enabled
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.
.properties
files:
1
springdoc.pre-loading-enabled=...
1
springdoc:
pre-loading-enabled: "..."
1
java -Dspringdoc.pre-loading-enabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_PRE_LOADING_ENABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.pre-loading-enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.pre-loading-locales=
locale list to pre-loading
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.pre-loading-locales
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.
.properties
files:
1
springdoc.pre-loading-locales=...
1
springdoc:
pre-loading-locales: "..."
1
java -Dspringdoc.pre-loading-locales="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_PRE_LOADING_LOCALES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.pre-loading-locales="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.produces-to-match=
The Produces to match.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.produces-to-match
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.
.properties
files:
1
springdoc.produces-to-match=...
1
springdoc:
produces-to-match: "..."
1
java -Dspringdoc.produces-to-match="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_PRODUCES_TO_MATCH="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.produces-to-match="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.remove-broken-reference-definitions=true
The Remove broken reference definitions.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.remove-broken-reference-definitions
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.
.properties
files:
1
springdoc.remove-broken-reference-definitions=true
1
springdoc:
remove-broken-reference-definitions: "true"
1
java -Dspringdoc.remove-broken-reference-definitions="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_REMOVE_BROKEN_REFERENCE_DEFINITIONS="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.remove-broken-reference-definitions="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.show-actuator=false
The Show actuator.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.show-actuator
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.
.properties
files:
1
springdoc.show-actuator=...
1
springdoc:
show-actuator: "..."
1
java -Dspringdoc.show-actuator="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SHOW_ACTUATOR="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.show-actuator="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.show-login-endpoint=false
The Show login endpoint.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.show-login-endpoint
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.
.properties
files:
1
springdoc.show-login-endpoint=...
1
springdoc:
show-login-endpoint: "..."
1
java -Dspringdoc.show-login-endpoint="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SHOW_LOGIN_ENDPOINT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.show-login-endpoint="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.show-oauth2-endpoints=false
The Show oauth 2 endpoint.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.show-oauth2-endpoints
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.
.properties
files:
1
springdoc.show-oauth2-endpoints=...
1
springdoc:
show-oauth2-endpoints: "..."
1
java -Dspringdoc.show-oauth2-endpoints="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SHOW_OAUTH2_ENDPOINTS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.show-oauth2-endpoints="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.show-spring-cloud-functions=true
The Show spring cloud functions.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.show-spring-cloud-functions
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.
.properties
files:
1
springdoc.show-spring-cloud-functions=true
1
springdoc:
show-spring-cloud-functions: "true"
1
java -Dspringdoc.show-spring-cloud-functions="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SHOW_SPRING_CLOUD_FUNCTIONS="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.show-spring-cloud-functions="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.sort-converter.enabled=false
The Enabled.
org.springdoc.core.properties.SpringDocConfigProperties$SortConverter.
CAS Property: springdoc.sort-converter.enabled
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.
.properties
files:
1
springdoc.sort-converter.enabled=...
1
springdoc:
sort-converter:
enabled: "..."
1
java -Dspringdoc.sort-converter.enabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SORT_CONVERTER_ENABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.sort-converter.enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.config-url=
URL to fetch external configuration document from.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.config-url
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.
.properties
files:
1
springdoc.swagger-ui.config-url=...
1
springdoc:
swagger-ui:
config-url: "..."
1
java -Dspringdoc.swagger-ui.config-url="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_CONFIG_URL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.config-url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.csrf.cookie-name=
The Cookie name.
org.springdoc.core.properties.SwaggerUiConfigProperties$Csrf.
CAS Property: springdoc.swagger-ui.csrf.cookie-name
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.
.properties
files:
1
springdoc.swagger-ui.csrf.cookie-name=...
1
springdoc:
swagger-ui:
csrf:
cookie-name: "..."
1
java -Dspringdoc.swagger-ui.csrf.cookie-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_CSRF_COOKIE_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.csrf.cookie-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.csrf.enabled=false
The Enabled.
org.springdoc.core.properties.SwaggerUiConfigProperties$Csrf.
CAS Property: springdoc.swagger-ui.csrf.enabled
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.
.properties
files:
1
springdoc.swagger-ui.csrf.enabled=...
1
springdoc:
swagger-ui:
csrf:
enabled: "..."
1
java -Dspringdoc.swagger-ui.csrf.enabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_CSRF_ENABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.csrf.enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.csrf.header-name=
The Header name.
org.springdoc.core.properties.SwaggerUiConfigProperties$Csrf.
CAS Property: springdoc.swagger-ui.csrf.header-name
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.
.properties
files:
1
springdoc.swagger-ui.csrf.header-name=...
1
springdoc:
swagger-ui:
csrf:
header-name: "..."
1
java -Dspringdoc.swagger-ui.csrf.header-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_CSRF_HEADER_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.csrf.header-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.csrf.local-storage-key=
The Local storage key.
org.springdoc.core.properties.SwaggerUiConfigProperties$Csrf.
CAS Property: springdoc.swagger-ui.csrf.local-storage-key
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.
.properties
files:
1
springdoc.swagger-ui.csrf.local-storage-key=...
1
springdoc:
swagger-ui:
csrf:
local-storage-key: "..."
1
java -Dspringdoc.swagger-ui.csrf.local-storage-key="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_CSRF_LOCAL_STORAGE_KEY="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.csrf.local-storage-key="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.csrf.session-storage-key=
The Session storage key.
org.springdoc.core.properties.SwaggerUiConfigProperties$Csrf.
CAS Property: springdoc.swagger-ui.csrf.session-storage-key
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.
.properties
files:
1
springdoc.swagger-ui.csrf.session-storage-key=...
1
springdoc:
swagger-ui:
csrf:
session-storage-key: "..."
1
java -Dspringdoc.swagger-ui.csrf.session-storage-key="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_CSRF_SESSION_STORAGE_KEY="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.csrf.session-storage-key="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.csrf.use-local-storage=false
Use Local storage.
org.springdoc.core.properties.SwaggerUiConfigProperties$Csrf.
CAS Property: springdoc.swagger-ui.csrf.use-local-storage
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.
.properties
files:
1
springdoc.swagger-ui.csrf.use-local-storage=...
1
springdoc:
swagger-ui:
csrf:
use-local-storage: "..."
1
java -Dspringdoc.swagger-ui.csrf.use-local-storage="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_CSRF_USE_LOCAL_STORAGE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.csrf.use-local-storage="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.csrf.use-session-storage=false
Use Session storage.
org.springdoc.core.properties.SwaggerUiConfigProperties$Csrf.
CAS Property: springdoc.swagger-ui.csrf.use-session-storage
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.
.properties
files:
1
springdoc.swagger-ui.csrf.use-session-storage=...
1
springdoc:
swagger-ui:
csrf:
use-session-storage: "..."
1
java -Dspringdoc.swagger-ui.csrf.use-session-storage="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_CSRF_USE_SESSION_STORAGE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.csrf.use-session-storage="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.deep-linking=
Enables or disables deep linking for tags and operations. @see deep-linking.md
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.deep-linking
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.
.properties
files:
1
springdoc.swagger-ui.deep-linking=...
1
springdoc:
swagger-ui:
deep-linking: "..."
1
java -Dspringdoc.swagger-ui.deep-linking="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_DEEP_LINKING="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.deep-linking="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.default-model-expand-depth=
The default expansion depth for the model on the model-example section.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.default-model-expand-depth
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.
.properties
files:
1
springdoc.swagger-ui.default-model-expand-depth=...
1
springdoc:
swagger-ui:
default-model-expand-depth: "..."
1
java -Dspringdoc.swagger-ui.default-model-expand-depth="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_DEFAULT_MODEL_EXPAND_DEPTH="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.default-model-expand-depth="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.default-model-rendering=
Controls how the model is shown when the API is first rendered.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.default-model-rendering
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.
.properties
files:
1
springdoc.swagger-ui.default-model-rendering=...
1
springdoc:
swagger-ui:
default-model-rendering: "..."
1
java -Dspringdoc.swagger-ui.default-model-rendering="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_DEFAULT_MODEL_RENDERING="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.default-model-rendering="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.default-models-expand-depth=
The default expansion depth for models (set to -1 completely hide the models).
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.default-models-expand-depth
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.
.properties
files:
1
springdoc.swagger-ui.default-models-expand-depth=...
1
springdoc:
swagger-ui:
default-models-expand-depth: "..."
1
java -Dspringdoc.swagger-ui.default-models-expand-depth="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_DEFAULT_MODELS_EXPAND_DEPTH="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.default-models-expand-depth="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.disable-swagger-default-url=false
The Disable swagger default url.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.disable-swagger-default-url
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.
.properties
files:
1
springdoc.swagger-ui.disable-swagger-default-url=...
1
springdoc:
swagger-ui:
disable-swagger-default-url: "..."
1
java -Dspringdoc.swagger-ui.disable-swagger-default-url="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_DISABLE_SWAGGER_DEFAULT_URL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.disable-swagger-default-url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.display-operation-id=
Controls the display of operationId in operations list.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.display-operation-id
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.
.properties
files:
1
springdoc.swagger-ui.display-operation-id=...
1
springdoc:
swagger-ui:
display-operation-id: "..."
1
java -Dspringdoc.swagger-ui.display-operation-id="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_DISPLAY_OPERATION_ID="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.display-operation-id="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.display-request-duration=
Controls the display of the request duration (in milliseconds) for Try-It-Out requests.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.display-request-duration
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.
.properties
files:
1
springdoc.swagger-ui.display-request-duration=...
1
springdoc:
swagger-ui:
display-request-duration: "..."
1
java -Dspringdoc.swagger-ui.display-request-duration="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_DISPLAY_REQUEST_DURATION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.display-request-duration="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.doc-expansion=
Controls the default expansion setting for the operations and tags.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.doc-expansion
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.
.properties
files:
1
springdoc.swagger-ui.doc-expansion=...
1
springdoc:
swagger-ui:
doc-expansion: "..."
1
java -Dspringdoc.swagger-ui.doc-expansion="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_DOC_EXPANSION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.doc-expansion="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.enabled=true
Whether to generate and serve an OpenAPI document.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.enabled
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.
.properties
files:
1
springdoc.swagger-ui.enabled=true
1
springdoc:
swagger-ui:
enabled: "true"
1
java -Dspringdoc.swagger-ui.enabled="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_ENABLED="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.filter=
If set, enables filtering. The top bar will show an edit box that could be used to filter the tagged operations that are shown.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.filter
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.
.properties
files:
1
springdoc.swagger-ui.filter=...
1
springdoc:
swagger-ui:
filter: "..."
1
java -Dspringdoc.swagger-ui.filter="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_FILTER="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.filter="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.groups-order=
The Groups order.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.groups-order
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.
.properties
files:
1
springdoc.swagger-ui.groups-order=...
1
springdoc:
swagger-ui:
groups-order: "..."
1
java -Dspringdoc.swagger-ui.groups-order="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_GROUPS_ORDER="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.groups-order="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.layout=
The name of a component available via the plugin system to use as the top-level layout for Swagger UI.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.layout
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.
.properties
files:
1
springdoc.swagger-ui.layout=...
1
springdoc:
swagger-ui:
layout: "..."
1
java -Dspringdoc.swagger-ui.layout="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_LAYOUT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.layout="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.max-displayed-tags=
If set, limits the number of tagged operations displayed to at most this many.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.max-displayed-tags
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.
.properties
files:
1
springdoc.swagger-ui.max-displayed-tags=...
1
springdoc:
swagger-ui:
max-displayed-tags: "..."
1
java -Dspringdoc.swagger-ui.max-displayed-tags="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_MAX_DISPLAYED_TAGS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.max-displayed-tags="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.oauth.additional-query-string-params=
The Additional query string params.
org.springdoc.core.properties.SwaggerUiOAuthProperties.
CAS Property: springdoc.swagger-ui.oauth.additional-query-string-params
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.
.properties
files:
1
springdoc.swagger-ui.oauth.additional-query-string-params=...
1
springdoc:
swagger-ui:
oauth:
additional-query-string-params: "..."
1
java -Dspringdoc.swagger-ui.oauth.additional-query-string-params="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_OAUTH_ADDITIONAL_QUERY_STRING_PARAMS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.additional-query-string-params="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.oauth.app-name=
The App name.
org.springdoc.core.properties.SwaggerUiOAuthProperties.
CAS Property: springdoc.swagger-ui.oauth.app-name
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.
.properties
files:
1
springdoc.swagger-ui.oauth.app-name=...
1
springdoc:
swagger-ui:
oauth:
app-name: "..."
1
java -Dspringdoc.swagger-ui.oauth.app-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_OAUTH_APP_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.app-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.oauth.client-id=
The Client id.
org.springdoc.core.properties.SwaggerUiOAuthProperties.
CAS Property: springdoc.swagger-ui.oauth.client-id
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.
.properties
files:
1
springdoc.swagger-ui.oauth.client-id=...
1
springdoc:
swagger-ui:
oauth:
client-id: "..."
1
java -Dspringdoc.swagger-ui.oauth.client-id="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_OAUTH_CLIENT_ID="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.client-id="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.oauth.client-secret=
The Client secret.
org.springdoc.core.properties.SwaggerUiOAuthProperties.
CAS Property: springdoc.swagger-ui.oauth.client-secret
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.
.properties
files:
1
springdoc.swagger-ui.oauth.client-secret=...
1
springdoc:
swagger-ui:
oauth:
client-secret: "..."
1
java -Dspringdoc.swagger-ui.oauth.client-secret="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_OAUTH_CLIENT_SECRET="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.client-secret="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.oauth.config-parameters=
org.springdoc.core.properties.SwaggerUiOAuthProperties.
CAS Property: springdoc.swagger-ui.oauth.config-parameters
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.
.properties
files:
1
springdoc.swagger-ui.oauth.config-parameters=...
1
springdoc:
swagger-ui:
oauth:
config-parameters: "..."
1
java -Dspringdoc.swagger-ui.oauth.config-parameters="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_OAUTH_CONFIG_PARAMETERS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.config-parameters="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.oauth.realm=
The Realm.
org.springdoc.core.properties.SwaggerUiOAuthProperties.
CAS Property: springdoc.swagger-ui.oauth.realm
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.
.properties
files:
1
springdoc.swagger-ui.oauth.realm=...
1
springdoc:
swagger-ui:
oauth:
realm: "..."
1
java -Dspringdoc.swagger-ui.oauth.realm="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_OAUTH_REALM="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.realm="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.oauth.scope-separator=
The Scope separator.
org.springdoc.core.properties.SwaggerUiOAuthProperties.
CAS Property: springdoc.swagger-ui.oauth.scope-separator
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.
.properties
files:
1
springdoc.swagger-ui.oauth.scope-separator=...
1
springdoc:
swagger-ui:
oauth:
scope-separator: "..."
1
java -Dspringdoc.swagger-ui.oauth.scope-separator="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_OAUTH_SCOPE_SEPARATOR="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.scope-separator="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.oauth.scopes=
The Scopes selected by default upon authentication.
org.springdoc.core.properties.SwaggerUiOAuthProperties.
CAS Property: springdoc.swagger-ui.oauth.scopes
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.
.properties
files:
1
springdoc.swagger-ui.oauth.scopes=...
1
springdoc:
swagger-ui:
oauth:
scopes: "..."
1
java -Dspringdoc.swagger-ui.oauth.scopes="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_OAUTH_SCOPES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.scopes="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.oauth.use-basic-authentication-with-access-code-grant=
The Use basic authentication with access code grant.
org.springdoc.core.properties.SwaggerUiOAuthProperties.
CAS Property: springdoc.swagger-ui.oauth.use-basic-authentication-with-access-code-grant
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.
.properties
files:
1
springdoc.swagger-ui.oauth.use-basic-authentication-with-access-code-grant=...
1
springdoc:
swagger-ui:
oauth:
use-basic-authentication-with-access-code-grant: "..."
1
java -Dspringdoc.swagger-ui.oauth.use-basic-authentication-with-access-code-grant="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_OAUTH_USE_BASIC_AUTHENTICATION_WITH_ACCESS_CODE_GRANT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.use-basic-authentication-with-access-code-grant="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.oauth.use-pkce-with-authorization-code-grant=
The Use pkce with authorization code grant.
org.springdoc.core.properties.SwaggerUiOAuthProperties.
CAS Property: springdoc.swagger-ui.oauth.use-pkce-with-authorization-code-grant
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.
.properties
files:
1
springdoc.swagger-ui.oauth.use-pkce-with-authorization-code-grant=...
1
springdoc:
swagger-ui:
oauth:
use-pkce-with-authorization-code-grant: "..."
1
java -Dspringdoc.swagger-ui.oauth.use-pkce-with-authorization-code-grant="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_OAUTH_USE_PKCE_WITH_AUTHORIZATION_CODE_GRANT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.use-pkce-with-authorization-code-grant="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.oauth2-redirect-url=
OAuth redirect URL.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.oauth2-redirect-url
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.
.properties
files:
1
springdoc.swagger-ui.oauth2-redirect-url=...
1
springdoc:
swagger-ui:
oauth2-redirect-url: "..."
1
java -Dspringdoc.swagger-ui.oauth2-redirect-url="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_OAUTH2_REDIRECT_URL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.oauth2-redirect-url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.operations-sorter=
Apply a sort to the operation list of each API
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.operations-sorter
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.
.properties
files:
1
springdoc.swagger-ui.operations-sorter=...
1
springdoc:
swagger-ui:
operations-sorter: "..."
1
java -Dspringdoc.swagger-ui.operations-sorter="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_OPERATIONS_SORTER="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.operations-sorter="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.path=
The path for the Swagger UI pages to load. Will redirect to the springdoc.webjars.prefix property.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.path
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.
.properties
files:
1
springdoc.swagger-ui.path=...
1
springdoc:
swagger-ui:
path: "..."
1
java -Dspringdoc.swagger-ui.path="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_PATH="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.path="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.persist-authorization=
The Persist authorization.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.persist-authorization
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.
.properties
files:
1
springdoc.swagger-ui.persist-authorization=...
1
springdoc:
swagger-ui:
persist-authorization: "..."
1
java -Dspringdoc.swagger-ui.persist-authorization="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_PERSIST_AUTHORIZATION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.persist-authorization="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.query-config-enabled=
The Query config enabled.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.query-config-enabled
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.
.properties
files:
1
springdoc.swagger-ui.query-config-enabled=...
1
springdoc:
swagger-ui:
query-config-enabled: "..."
1
java -Dspringdoc.swagger-ui.query-config-enabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_QUERY_CONFIG_ENABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.query-config-enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.show-common-extensions=
Controls the display of extensions
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.show-common-extensions
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.
.properties
files:
1
springdoc.swagger-ui.show-common-extensions=...
1
springdoc:
swagger-ui:
show-common-extensions: "..."
1
java -Dspringdoc.swagger-ui.show-common-extensions="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_SHOW_COMMON_EXTENSIONS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.show-common-extensions="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.show-extensions=
Controls the display of vendor extension (x-) fields and values.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.show-extensions
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.
.properties
files:
1
springdoc.swagger-ui.show-extensions=...
1
springdoc:
swagger-ui:
show-extensions: "..."
1
java -Dspringdoc.swagger-ui.show-extensions="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_SHOW_EXTENSIONS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.show-extensions="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.supported-submit-methods=
The supported try it out methods
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.supported-submit-methods
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.
.properties
files:
1
springdoc.swagger-ui.supported-submit-methods=...
1
springdoc:
swagger-ui:
supported-submit-methods: "..."
1
java -Dspringdoc.swagger-ui.supported-submit-methods="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_SUPPORTED_SUBMIT_METHODS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.supported-submit-methods="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.syntax-highlight.activated=
The Activated.
org.springdoc.core.properties.SwaggerUiConfigProperties$SyntaxHighlight.
CAS Property: springdoc.swagger-ui.syntax-highlight.activated
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.
.properties
files:
1
springdoc.swagger-ui.syntax-highlight.activated=...
1
springdoc:
swagger-ui:
syntax-highlight:
activated: "..."
1
java -Dspringdoc.swagger-ui.syntax-highlight.activated="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_SYNTAX_HIGHLIGHT_ACTIVATED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.syntax-highlight.activated="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.syntax-highlight.theme=
The Theme.
org.springdoc.core.properties.SwaggerUiConfigProperties$SyntaxHighlight.
CAS Property: springdoc.swagger-ui.syntax-highlight.theme
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.
.properties
files:
1
springdoc.swagger-ui.syntax-highlight.theme=...
1
springdoc:
swagger-ui:
syntax-highlight:
theme: "..."
1
java -Dspringdoc.swagger-ui.syntax-highlight.theme="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_SYNTAX_HIGHLIGHT_THEME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.syntax-highlight.theme="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.tags-sorter=
Apply a sort to the tag list of each API
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.tags-sorter
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.
.properties
files:
1
springdoc.swagger-ui.tags-sorter=...
1
springdoc:
swagger-ui:
tags-sorter: "..."
1
java -Dspringdoc.swagger-ui.tags-sorter="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_TAGS_SORTER="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.tags-sorter="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.try-it-out-enabled=
Try it out enabled
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.try-it-out-enabled
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.
.properties
files:
1
springdoc.swagger-ui.try-it-out-enabled=...
1
springdoc:
swagger-ui:
try-it-out-enabled: "..."
1
java -Dspringdoc.swagger-ui.try-it-out-enabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_TRY_IT_OUT_ENABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.try-it-out-enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.url=
The Url.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.url
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.
.properties
files:
1
springdoc.swagger-ui.url=...
1
springdoc:
swagger-ui:
url: "..."
1
java -Dspringdoc.swagger-ui.url="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_URL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.urls=
The Urls.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.urls
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.
.properties
files:
1
springdoc.swagger-ui.urls=...
1
springdoc:
swagger-ui:
urls: "..."
1
java -Dspringdoc.swagger-ui.urls="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_URLS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.urls="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.urls-primary-name=
The Urls primary name.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.urls-primary-name
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.
.properties
files:
1
springdoc.swagger-ui.urls-primary-name=...
1
springdoc:
swagger-ui:
urls-primary-name: "..."
1
java -Dspringdoc.swagger-ui.urls-primary-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_URLS_PRIMARY_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.urls-primary-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.use-root-path=false
The Use root path.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.use-root-path
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.
.properties
files:
1
springdoc.swagger-ui.use-root-path=...
1
springdoc:
swagger-ui:
use-root-path: "..."
1
java -Dspringdoc.swagger-ui.use-root-path="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_USE_ROOT_PATH="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.use-root-path="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.validator-url=
URL to validate specs against.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.validator-url
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.
.properties
files:
1
springdoc.swagger-ui.validator-url=...
1
springdoc:
swagger-ui:
validator-url: "..."
1
java -Dspringdoc.swagger-ui.validator-url="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_VALIDATOR_URL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.validator-url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.version=
The Swagger ui version.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.version
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.
.properties
files:
1
springdoc.swagger-ui.version=...
1
springdoc:
swagger-ui:
version: "..."
1
java -Dspringdoc.swagger-ui.version="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_VERSION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.version="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.swagger-ui.with-credentials=
The With credentials.
org.springdoc.core.properties.SwaggerUiConfigProperties.
CAS Property: springdoc.swagger-ui.with-credentials
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.
.properties
files:
1
springdoc.swagger-ui.with-credentials=...
1
springdoc:
swagger-ui:
with-credentials: "..."
1
java -Dspringdoc.swagger-ui.with-credentials="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_SWAGGER_UI_WITH_CREDENTIALS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.swagger-ui.with-credentials="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.trim-kotlin-indent=false
The trim kotlin indent.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.trim-kotlin-indent
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.
.properties
files:
1
springdoc.trim-kotlin-indent=...
1
springdoc:
trim-kotlin-indent: "..."
1
java -Dspringdoc.trim-kotlin-indent="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_TRIM_KOTLIN_INDENT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.trim-kotlin-indent="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.use-fqn=false
Use fully qualified name
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.use-fqn
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.
.properties
files:
1
springdoc.use-fqn=...
1
springdoc:
use-fqn: "..."
1
java -Dspringdoc.use-fqn="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_USE_FQN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.use-fqn="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.use-management-port=false
If set to true, exposes the swagger-ui on the actuator management port.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.use-management-port
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.
.properties
files:
1
springdoc.use-management-port=...
1
springdoc:
use-management-port: "..."
1
java -Dspringdoc.use-management-port="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_USE_MANAGEMENT_PORT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.use-management-port="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.webjars.prefix=
The Prefix.
org.springdoc.core.properties.SpringDocConfigProperties$Webjars.
CAS Property: springdoc.webjars.prefix
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.
.properties
files:
1
springdoc.webjars.prefix=...
1
springdoc:
webjars:
prefix: "..."
1
java -Dspringdoc.webjars.prefix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_WEBJARS_PREFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.webjars.prefix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.writer-with-default-pretty-printer=false
The Writer with default pretty printer.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.writer-with-default-pretty-printer
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.
.properties
files:
1
springdoc.writer-with-default-pretty-printer=...
1
springdoc:
writer-with-default-pretty-printer: "..."
1
java -Dspringdoc.writer-with-default-pretty-printer="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_WRITER_WITH_DEFAULT_PRETTY_PRINTER="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.writer-with-default-pretty-printer="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
springdoc.writer-with-order-by-keys=false
The Writer with order by keys.
org.springdoc.core.properties.SpringDocConfigProperties.
CAS Property: springdoc.writer-with-order-by-keys
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.
.properties
files:
1
springdoc.writer-with-order-by-keys=...
1
springdoc:
writer-with-order-by-keys: "..."
1
java -Dspringdoc.writer-with-order-by-keys="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRINGDOC_WRITER_WITH_ORDER_BY_KEYS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --springdoc.writer-with-order-by-keys="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
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.
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, specially 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.
Endpoints
The following Swagger endpoints may be used to analyze and test the APIs:
Description | URL |
---|---|
Swagger API Specification | https://sso.example.org/cas/v3/api-docs |
Swagger UI | https://sso.example.org/cas/swagger-ui.html |