Skip to content

Latest commit

 

History

History
3490 lines (2307 loc) · 128 KB

UAA-Configuration-Reference.md

File metadata and controls

3490 lines (2307 loc) · 128 KB

UAA Configuration Reference

The Cloud Foundry UAA (User Account and Authentication) server is a Spring Boot application. Configuration is loaded from the embedded uaa/src/main/resources/uaa.yml and can be overridden by an external YAML file located at $UAA_CONFIG_URL, $UAA_CONFIG_PATH/uaa.yml, or $CLOUDFOUNDRY_CONFIG_PATH/uaa.yml.


Table of Contents


Property Quick-Reference Table

Core / General

Property Default Description
↪ issuer.uri — (required) Token issuer URI
↪ uaa.url http://localhost:8080/uaa Public URL of the UAA
↪ login.url http://localhost:8080/uaa URL of the login server
↪ spring_profiles — Active Spring profiles
↪ require_https false Require HTTPS for cookies
↪ https_port 443 HTTPS port
↪ LOGIN_SECRET loginsecret Shared secret for login server auth
↪ dump_requests false Dump HTTP requests for debugging
↪ environmentYamlKey — YAML config string for validation
↪ disableInternalAuth false Disable internal IDP authentication
↪ disableInternalUserManagement false Disable internal user management endpoints
↪ allowUnverifiedUsers true Allow login for unverified users

Database

Property Default Description
↪ database.driverClassName (per profile) JDBC driver class
↪ database.url (per profile) JDBC connection URL
↪ database.username — Database user
↪ database.password — Database password
↪ database.maxactive 100 Max active connections
↪ database.maxidle 10 Max idle connections
↪ database.minidle 0 Min idle connections
↪ database.maxwait 30000 Max wait for connection (ms)
↪ database.initialsize 10 Initial pool size
↪ database.validationquerytimeout 10 Validation query timeout (s)
↪ database.validationinterval 5000 Validation interval (ms)
↪ database.connecttimeout 10 Connection timeout (s)
↪ database.testwhileidle false Test connections while idle
↪ database.removedAbandoned false Remove abandoned connections
↪ database.logabandoned true Log abandoned connections
↪ database.abandonedtimeout 300 Abandoned timeout (s)
↪ database.evictionintervalms 15000 Eviction interval (ms)
↪ database.minevictionidlems 60000 Min eviction idle time (ms)
↪ database.caseinsensitive false Case-insensitive queries
↪ database.useSkipLocked false Use SKIP LOCKED in queries
↪ database.maxParameters -1 Max SQL parameters (-1 = unlimited)

Servlet & Session

Property Default Description
↪ servlet.session-store memory Session store type
↪ servlet.session-cookie.encode-base64 true Base64-encode session cookie
↪ servlet.session-cookie.max-age — (null) Session cookie max age
↪ servlet.idle-timeout 1800 Session idle timeout (s)
↪ servlet.filtered-headers X-Forwarded-For, X-Forwarded-Host, X-Forwarded-Proto, X-Forwarded-Prefix, Forwarded, X-Client-IP, X-Real-IP Headers to filter

JWT Token Policy

Property Default Description
↪ jwt.token.signing-key — (null) Legacy token signing key
↪ jwt.token.signing-alg — (null) Legacy signing algorithm
↪ jwt.token.signing-cert — (null) Legacy signing certificate
↪ jwt.token.revocable false Make JWT tokens revocable
↪ jwt.token.queryString.enabled true Allow tokens via query string
↪ jwt.token.policy.activeKeyId — (null) Active signing key ID
↪ jwt.token.policy.keys {} Map of signing keys
↪ jwt.token.policy.accessTokenValiditySeconds falls back to global Access token validity (s)
↪ jwt.token.policy.refreshTokenValiditySeconds falls back to global Refresh token validity (s)
↪ jwt.token.policy.global.accessTokenValiditySeconds 43200 Global access token validity (s)
↪ jwt.token.policy.global.refreshTokenValiditySeconds 2592000 Global refresh token validity (s)
↪ jwt.token.refresh.format opaque Refresh token format
↪ jwt.token.refresh.unique -1 Max concurrent refresh-token sessions per user/client
↪ jwt.token.refresh.rotate false Rotate refresh tokens
↪ jwt.token.refresh.restrict_grant — Restrict refresh token grant
↪ jwt.token.claims.exclude [] Claims excluded from tokens
↪ jwt.token.idToken.enhancer.allowClaimModification false Allow id_token enhancers to modify existing claims

OAuth Clients & Users

Property Default Description
↪ oauth.clients {} Bootstrap OAuth client definitions
↪ oauth.client.override — Override existing client on bootstrap
↪ oauth.client.autoapprove [] Clients auto-approved for all scopes
↪ oauth.client.allowpublic [] Clients allowed to authenticate without a client secret (PKCE S256)
↪ oauth.user.authorities (see details) Default authorities for new users
↪ clientMaxCount 500 Max clients returned by list endpoint
↪ uaa.mtls.enabled false Enables RFC 8705 mutual-TLS client authentication
↪ uaa.mtls.trust_bundles {} Named mTLS CA bundles for the default identity zone

Password Policy

Property Default Description
↪ password.policy.global.minLength 0 Global min password length
↪ password.policy.global.maxLength 255 Global max password length
↪ password.policy.global.requireUpperCaseCharacter 0 Global required uppercase chars
↪ password.policy.global.requireLowerCaseCharacter 0 Global required lowercase chars
↪ password.policy.global.requireDigit 0 Global required digits
↪ password.policy.global.requireSpecialCharacter 0 Global required special chars
↪ password.policy.global.expirePasswordInMonths 0 Global password expiry (months)
↪ password.policy.minLength (falls back to global) Default zone min password length
↪ password.policy.maxLength (falls back to global) Default zone max password length
↪ password.policy.requireUpperCaseCharacter (falls back to global) Default zone required uppercase
↪ password.policy.requireLowerCaseCharacter (falls back to global) Default zone required lowercase
↪ password.policy.requireDigit (falls back to global) Default zone required digits
↪ password.policy.requireSpecialCharacter (falls back to global) Default zone required special chars
↪ password.policy.expirePasswordInMonths (falls back to global) Default zone password expiry

Client Secret Policy

Property Default Description
↪ oauth.client.secret.policy.global.minLength 0 Global min secret length
↪ oauth.client.secret.policy.global.maxLength 255 Global max secret length
↪ oauth.client.secret.policy.global.requireUpperCaseCharacter 0 Global required uppercase
↪ oauth.client.secret.policy.global.requireLowerCaseCharacter 0 Global required lowercase
↪ oauth.client.secret.policy.global.requireDigit 0 Global required digits
↪ oauth.client.secret.policy.global.requireSpecialCharacter 0 Global required special chars
↪ oauth.client.secret.policy.global.expireSecretInMonths 0 Global secret expiry (months)
↪ oauth.client.secret.policy.minLength (falls back to global) Default zone min secret length
↪ oauth.client.secret.policy.maxLength (falls back to global) Default zone max secret length

Authentication / Lockout Policy

Property Default Description
↪ authentication.policy.global.lockoutAfterFailures 5 Global lockout threshold
↪ authentication.policy.global.countFailuresWithinSeconds 1200 Global failure counting window (s)
↪ authentication.policy.global.lockoutPeriodSeconds 300 Global lockout duration (s)
↪ authentication.policy.lockoutAfterFailures (falls back to global) Default zone lockout threshold
↪ authentication.policy.countFailuresWithinSeconds (falls back to global) Default zone failure window (s)
↪ authentication.policy.lockoutPeriodSeconds (falls back to global) Default zone lockout duration (s)
↪ authentication.enableUriEncodingCompatibilityMode false URI encoding compat mode

SCIM (User Provisioning)

Property Default Description
↪ scim.users [] Bootstrap users
↪ scim.groups {} Bootstrap groups and descriptions
↪ scim.external_groups [] External group mappings
↪ scim.userids_enabled true Enable /ids/Users endpoint
↪ scim.user.override false Override existing bootstrap users
↪ scim.delete.deactivate false Deactivate instead of delete
↪ scim.invite.allow_reinvite true Invite verified users for any scim.invite caller
↪ userMaxCount 500 Max users returned by list endpoint
↪ groupMaxCount 500 Max groups returned by list endpoint
↪ delete.users — (null) Users to delete on bootstrap

Login & Branding

Property Default Description
↪ login.selfServiceLinksEnabled true Show self-service links
↪ login.homeRedirect — (null) Home page redirect URL
↪ login.idpDiscoveryEnabled false Enable IDP discovery
↪ login.accountChooserEnabled false Enable account chooser
↪ login.entityBaseURL http://localhost:8080/uaa SAML SP entity base URL
↪ login.entityID unit-test-sp SAML SP entity ID
↪ login.prompt.username.text Email Username field label
↪ login.prompt.password.text Password Password field label
↪ login.branding — UI branding configuration
↪ login.defaultIdentityProvider — (null) Default IDP origin key
↪ login.allowedGroups — (null) Restrict login to group members
↪ login.checkOriginEnabled false Check user origin on auth
↪ login.maxUsers -1 Max users (-1 = unlimited)
↪ login.allowOriginLoop true Allow origin loop
↪ login.aliasEntitiesEnabled false Enable alias entities
↪ login.oauth.providers — External OAuth/OIDC providers
↪ login.oauth.externalGroupsFromMappedAuthorities false Use mapped UAA authorities for external OAuth external groups

SAML Service Provider

Property Default Description
↪ login.saml.activeKeyId — Active SAML signing key ID
↪ login.saml.keys {} Map of SAML keys
↪ login.saml.entityIDAlias — (null) SAML entity ID alias
↪ login.saml.nameID urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified Default SAML NameID format
↪ login.saml.assertionConsumerIndex 0 Assertion consumer index
↪ login.saml.signMetaData true Sign SAML SP metadata
↪ login.saml.signRequest true Sign SAML auth requests
↪ login.saml.wantAssertionSigned true Deprecated (since 78.13.0). Only controls SAML SP metadata WantAssertionsSigned attribute. No longer affects authentication behavior.
↪ login.saml.signatureAlgorithm SHA256 SAML signature algorithm
↪ login.saml.disableInResponseToCheck false Disable InResponseTo validation
↪ login.saml.providers — SAML IDP definitions
↪ login.serviceProviderKey — Legacy SP private key
↪ login.serviceProviderKeyPassword — Legacy SP key password
↪ login.serviceProviderCertificate — Legacy SP certificate

Logout

Property Default Description
↪ logout.redirect.url /login Post-logout redirect URL
↪ logout.redirect.parameter.disable false Disable redirect parameter
↪ logout.redirect.parameter.whitelist [] Allowed redirect URLs

Links

Property Default Description
↪ links.global.passwd — (null) Custom forgot-password link
↪ links.global.signup — (null) Custom signup link
↪ links.global.homeRedirect — (null) Home redirect URL

CORS

Property Default Description
↪ cors.enforceSystemZonePolicyInAllZones false Enforce system CORS in all zones
↪ cors.default.max_age 1728000 Default CORS max age (s)
↪ cors.default.allowed.uris [".*"] Default allowed URI patterns
↪ cors.default.allowed.origins [".*"] Default allowed origins
↪ cors.default.allowed.headers [Accept, Authorization, Content-Type, Accept-Language, Content-Language] Default allowed headers
↪ cors.default.allowed.methods [GET, POST, PUT, OPTIONS, DELETE, PATCH] Default allowed methods
↪ cors.default.allowed.credentials false Default allow credentials
↪ cors.xhr.max_age 1728000 XHR CORS max age (s)
↪ cors.xhr.allowed.uris [".*"] XHR allowed URI patterns
↪ cors.xhr.allowed.origins [".*"] XHR allowed origins
↪ cors.xhr.allowed.headers [Accept, Authorization, Content-Type, Accept-Language, Content-Language, X-Requested-With] XHR allowed headers
↪ cors.xhr.allowed.methods [GET, OPTIONS] XHR allowed methods
↪ cors.xhr.allowed.credentials true XHR allow credentials

SMTP / Notifications

Property Default Description
↪ smtp.host localhost SMTP server hostname
↪ smtp.port 25 SMTP server port
↪ smtp.user "" SMTP username
↪ smtp.password "" SMTP password
↪ smtp.auth false Enable SMTP auth
↪ smtp.starttls false Enable STARTTLS
↪ smtp.sslprotocols TLSv1.2 SSL/TLS protocol versions
↪ smtp.fromAddress "" From address for emails
↪ notifications.url — (null) Notification service URL
↪ notifications.sendInDefaultZone true Send in default zone
↪ notifications.verify_ssl false Verify SSL for notifications

LDAP

Property Default Description
↪ ldap.profile.file — LDAP profile configuration file
↪ ldap.base.url — LDAP server URL
↪ ldap.base.userDn — LDAP bind DN
↪ ldap.base.password — LDAP bind password
↪ ldap.base.searchBase — LDAP search base DN
↪ ldap.base.searchFilter — LDAP user search filter
↪ ldap.base.userDnPattern — DN pattern for simple bind
↪ ldap.base.referral — LDAP referral handling
↪ ldap.ssl.skipverification false Skip LDAP SSL verification
↪ ldap.ssl.caCertificates — PEM-encoded CA certificates to trust for LDAPS connections
↪ ldap.externalGroupsWhitelist — (all groups at login) Whitelist of LDAP groups to include in the ID token/userinfo
↪ ldap.groups.file — LDAP groups configuration file
↪ ldap.groups.searchBase — LDAP group search base
↪ ldap.groups.groupSearchFilter — Group membership filter
↪ ldap.groups.maxSearchDepth 10 Max nested group depth
↪ ldap.groups.autoAdd — Auto-add LDAP groups

Encryption

Property Default Description
↪ encryption.active_key_label — (required) Active encryption key label
↪ encryption.encryption_keys — (required) List of encryption keys

Rate Limiting

Property Default Description
↪ ratelimit.loggingOption OnlyLimited Rate-limit logging mode
↪ ratelimit.credentialID — Regex for credential extraction
↪ ratelimit.limiterMappings [] Rate-limit rules

REST Template (HTTP Client)

Property Default Description
↪ rest.template.timeout 10000 HTTP client timeout (ms)
↪ rest.template.maxTotal 10 Max total connections
↪ rest.template.maxPerRoute 5 Max connections per route
↪ rest.template.maxKeepAlive 0 Max keep-alive (ms)
↪ rest.template.validateAfterInactivity 2000 Validate after inactivity (ms)
↪ rest.template.retryCount 0 HTTP retry count

Tracing (Brave/Zipkin)

Property Default Description
↪ brave.localServiceName uaa Service name in traces
↪ brave.supportsJoin true Support span joining
↪ brave.traceId128Bit false Use 128-bit trace IDs

Health & Shutdown

Property Default Description
↪ uaa.shutdown.sleep 10000 Shutdown sleep time (ms)
↪ uaa.health.db.rate 10000 DB health check interval (ms)
↪ delete.expirationRunTime 2500 Token expiration cleanup timeout (ms)

Limited Mode

Property Default Description
↪ uaa.limitedFunctionality.statusFile — (null) Limited mode status file
↪ uaa.limitedFunctionality.whitelist.endpoints {} Whitelisted endpoints
↪ uaa.limitedFunctionality.whitelist.methods {} Whitelisted HTTP methods

Metrics

Property Default Description
↪ metrics.enabled true Enable metrics collection
↪ metrics.perRequestMetrics false Per-request metrics

Zone Paths

Property Default Description
↪ zones.paths.enabled false Enable zone path routing
↪ zones.internal.hostnames [] Hostnames for default zone

CSP (Content Security Policy)

Property Default Description
↪ csp.script-src ['self'] CSP script-src directive

Logged Out Page

Property Default Description
↪ logged_out.message You have successfully logged out. Logged out page message
↪ logged_out.link_text Back to Sign In Logged out page link text
↪ logged_out.link_url /login Logged out page link URL

Miscellaneous

Property Default Description
↪ logging.file.name.path — Log file directory

Detailed Property Descriptions


issuer.uri

Default: — (required, no default) Source: @Value("${issuer.uri}") in TokenEndpointBuilder, OpenIdConnectEndpoints Type: String

The URI that identifies this UAA instance as an OAuth 2.0 / OIDC token issuer. This value appears in the iss claim of all tokens issued by the UAA and in the OpenID Connect discovery document. It must be a fully-qualified URL (e.g. http://localhost:8080/uaa).

Back to table


uaa.url

Default: http://localhost:8080/uaa Source: @ConfigurationProperties(prefix = "uaa") in UaaProperties.Uaa, @Value("${uaa.url}") in multiple beans Type: String

The externally-reachable URL of the UAA. Used for constructing token endpoint URLs, JWKS URIs, and other self-referencing links in API responses.

Back to table


login.url

Default: http://localhost:8080/uaa Source: @Value("${login.url:http://localhost:8080/uaa}") in MessagingConfig, SpringServletXmlBeansConfiguration Type: String

The base URL of the login server. Used in email templates (e.g. password reset links) and other contexts where the login page URL is needed. Typically the same as uaa.url.

Back to table


spring_profiles

Default: — (none) Source: Mapped to Spring active profiles Type: String (comma-separated)

Controls which Spring profiles are active. Common values:

  • hsqldb — in-memory HSQLDB (default for testing)
  • postgresql — PostgreSQL database
  • mysql — MySQL/MariaDB database
  • ldap — Enable LDAP authentication
  • saml — Enable SAML support

Multiple profiles can be combined, e.g. postgresql,ldap.

Back to table


require_https

Default: false Source: @ConfigurationProperties in UaaProperties.RootLevel Type: boolean

When true, various UAA cookies will have the Secure attribute set. Should be true in production when the UAA is served over HTTPS.

Back to table


https_port

Default: 443 Source: @ConfigurationProperties in UaaProperties.RootLevel Type: int

The HTTPS port for the UAA server. Used in redirect calculations when HTTPS is required.

Back to table


LOGIN_SECRET

Default: loginsecret Source: @ConfigurationProperties in UaaProperties.RootLevel Type: String

The shared secret that an external login server uses to authenticate to the UAA via the login client. Each deployment should set a unique value.

Back to table


dump_requests

Default: false Source: @ConfigurationProperties in UaaProperties.RootLevel Type: boolean

When true, logs full HTTP request details for debugging. Should never be true in production.

Back to table


environmentYamlKey

Default: — (injected internally) Source: key environmentYamlKey read directly from ConfigurableEnvironment.getPropertySources() in SpringServletXmlBeansConfiguration Type: String

An internal property holding the full YAML configuration string. Used by the YamlConfigurationValidator to validate configuration structure at startup. The property is read raw (i.e. without Spring expression or placeholder resolution).

Back to table


disableInternalAuth

Default: false Source: Referenced in uaa.yml comments, checked via @config['disableInternalAuth'] Type: boolean

When true, authentication via the UAA's internal identity provider (IDP) is disabled. Users must then authenticate via external IDPs (LDAP, SAML, OAuth/OIDC).

Back to table


disableInternalUserManagement

Default: false Source: @config['disableInternalUserManagement'] in SpringServletXmlBeansConfiguration Type: boolean

When true, disables user management endpoints and controllers for the internal IDP. Operations like creating internal users, changing passwords, etc. will be blocked.

Back to table


allowUnverifiedUsers

Default: true Source: @Value("${allowUnverifiedUsers:true}") in OauthEndpointBeanConfiguration Type: boolean

When true, users who have not verified their email can still log in. Set to false to require email verification before allowing authentication.

Back to table


database.driverClassName

Default: Determined by active profile (hsqldb, postgresql, or mysql) Source: @ConfigurationProperties(prefix = "database") in DatabaseProperties Type: String

The fully-qualified JDBC driver class name. Typically auto-resolved from the active profile:

  • HSQLDB: org.hsqldb.jdbc.JDBCDriver
  • PostgreSQL: org.postgresql.Driver
  • MySQL: org.mariadb.jdbc.Driver

Back to table


database.url

Default: Determined by active profile Source: DatabaseProperties Type: String

JDBC connection URL for the UAA database (e.g. jdbc:postgresql://localhost/uaa).

Back to table


database.username

Default: — (none) Source: DatabaseProperties Type: String

Database connection username.

Back to table


database.password

Default: — (none) Source: DatabaseProperties Type: String

Database connection password.

Back to table


database.maxactive

Default: 100 Source: DatabaseProperties Type: int

Maximum number of active connections in the connection pool.

Back to table


database.maxidle

Default: 10 Source: DatabaseProperties Type: int

Maximum number of idle connections in the pool.

Back to table


database.minidle

Default: 0 Source: DatabaseProperties Type: int

Minimum number of idle connections maintained in the pool.

Back to table


database.maxwait

Default: 30000 Source: DatabaseProperties Type: int

Maximum time (in milliseconds) to wait for a connection from the pool before throwing an exception.

Back to table


database.initialsize

Default: 10 Source: DatabaseProperties Type: int

Initial number of connections created when the pool starts.

Back to table


database.validationquerytimeout

Default: 10 Source: DatabaseProperties Type: int

Timeout (in seconds) for the validation query.

Back to table


database.validationinterval

Default: 5000 Source: DatabaseProperties Type: long

Interval (in milliseconds) between connection validation checks.

Back to table


database.connecttimeout

Default: 10 Source: DatabaseProperties Type: Integer

Connection timeout (in seconds) for establishing a new database connection.

Back to table


database.testwhileidle

Default: false Source: DatabaseProperties Type: boolean

When true, idle connections are validated periodically.

Back to table


database.removedAbandoned

Default: false Source: DatabaseProperties Type: boolean

When true, connections that have been abandoned (not returned to the pool) are reclaimed.

Back to table


database.logabandoned

Default: true Source: DatabaseProperties Type: boolean

When true, logs a stack trace for abandoned connections to help identify leaks.

Back to table


database.abandonedtimeout

Default: 300 Source: DatabaseProperties Type: int

Time (in seconds) after which a connection is considered abandoned.

Back to table


database.evictionintervalms

Default: 15000 Source: DatabaseProperties Type: int

Interval (in milliseconds) between eviction runs that remove idle connections.

Back to table


database.minevictionidlems

Default: 60000 Source: DatabaseProperties Type: int

Minimum time (in milliseconds) a connection can sit idle before being eligible for eviction.

Back to table


database.caseinsensitive

Default: false Source: DatabaseProperties Type: boolean

When true, enables case-insensitive queries for username lookups. This affects how users are searched and matched in the database.

Back to table


database.useSkipLocked

Default: false Source: @Value("${database.useSkipLocked:false}") in JdbcUaaUserDatabase Type: boolean

When true, uses the SKIP LOCKED clause in SQL queries to avoid lock contention. Supported by PostgreSQL and MySQL 8+.

Back to table


database.maxParameters

Default: -1 (unlimited) Source: @Value("${database.maxParameters:-1}") in JdbcUaaUserDatabase, JdbcScimGroupMembershipManager Type: int

Maximum number of SQL parameters allowed in IN clauses. -1 means no limit. Use this to work around database driver parameter limits.

Back to table


servlet.session-store

Default: memory Source: UaaSessionConfig (reads servlet.session-store from environment) Type: String

The session storage mechanism. Accepted values:

  • memory — In-memory sessions (default, suitable for multi-instance deployments that support sticky sessions)
  • database — Database-backed sessions via Spring Session JDBC

Back to table


servlet.session-cookie.encode-base64

Default: true Source: @ConfigurationProperties(prefix = "servlet") in UaaProperties.Servlet Type: boolean

When true, the session cookie value is Base64-encoded. Helps with cookie compatibility across different web servers and proxies.

Back to table


servlet.session-cookie.max-age

Default: — (null, session cookie) Source: UaaProperties.SessionCookie Type: Integer (nullable)

Maximum age of the session cookie in seconds. When null, the cookie is a session cookie (expires when the browser closes).

Back to table


servlet.idle-timeout

Default: 1800 Source: @ConfigurationProperties(prefix = "servlet") in UaaProperties.Servlet Type: int

Session idle timeout in seconds. After this period of inactivity, the session expires.

Back to table


servlet.filtered-headers

Default: [X-Forwarded-For, X-Forwarded-Host, X-Forwarded-Proto, X-Forwarded-Prefix, Forwarded, X-Client-IP, X-Real-IP] Source: @ConfigurationProperties(prefix = "servlet") in UaaProperties.Servlet Type: List<String>

HTTP headers that the UAA's request filter will process. These are typically proxy headers used to determine the original client request details.

Back to table


jwt.token.signing-key

Default: — (null) Source: @Value("${jwt.token.signing-key:#{null}}") in OauthEndpointBeanConfiguration Type: String

Legacy property for specifying a single token signing key (RSA private key in PEM format or symmetric key). Prefer using jwt.token.policy.keys instead for key rotation support.

Back to table


jwt.token.signing-alg

Default: — (null) Source: @Value("${jwt.token.signing-alg:#{null}}") in OauthEndpointBeanConfiguration Type: String

Legacy signing algorithm override (e.g. RS256, HS256). Prefer using jwt.token.policy.keys[].signingAlg instead.

Back to table


jwt.token.signing-cert

Default: — (null) Source: @Value("${jwt.token.signing-cert:#{null}}") in OauthEndpointBeanConfiguration Type: String

Legacy signing certificate (X.509 in PEM format) for the signing key. Used as the verification certificate for RS256 tokens when provided.

Back to table


jwt.token.revocable

Default: false Source: @Value("${jwt.token.revocable:false}") in OauthEndpointBeanConfiguration Type: boolean

When true, all JWT access tokens issued by the default zone are stored in the revocable token store, allowing them to be revoked before expiration.

Back to table


jwt.token.queryString.enabled

Default: true Source: @Value("${jwt.token.queryString.enabled:true}") in SpringServletXmlBeansConfiguration Type: boolean

When true, allows access tokens to be passed via query string parameters. Disable for increased security (tokens in query strings may be logged).

Back to table


jwt.token.policy.activeKeyId

Default: — (null) Source: @Value("${jwt.token.policy.activeKeyId:#{null}}") in OauthEndpointBeanConfiguration Type: String

The key ID of the currently active signing key from the jwt.token.policy.keys map. Tokens are signed with this key. Other keys in the map remain valid for verification, enabling key rotation.

Back to table


jwt.token.policy.keys

Default: {} (empty map) Source: @config['jwt.token.policy.keys'] in OauthEndpointBeanConfiguration Type: Map<String, Map<String, String>>

A map of key IDs to signing key configurations. Each entry has:

  • signingKey — RSA private key in PEM format
  • signingAlg — Algorithm (e.g. RS256)
jwt:
  token:
    policy:
      activeKeyId: key-id-1
      keys:
        key-id-1:
          signingAlg: RS256
          signingKey: |
            -----BEGIN PRIVATE KEY-----
            ...
            -----END PRIVATE KEY-----

Back to table


jwt.token.policy.accessTokenValiditySeconds

Default: Falls back to jwt.token.policy.global.accessTokenValiditySeconds Source: @Value in OauthEndpointBeanConfiguration Type: int

Access token lifetime in seconds for the default identity zone. Overrides the global value.

Back to table


jwt.token.policy.refreshTokenValiditySeconds

Default: Falls back to jwt.token.policy.global.refreshTokenValiditySeconds Source: @Value in OauthEndpointBeanConfiguration Type: int

Refresh token lifetime in seconds for the default identity zone. Overrides the global value.

Back to table


jwt.token.policy.global.accessTokenValiditySeconds

Default: 43200 (12 hours) Source: @Value("${jwt.token.policy.global.accessTokenValiditySeconds:43200}") in OauthEndpointBeanConfiguration Type: int

Global default for access token lifetime in seconds. Applies to all zones unless overridden.

Back to table


jwt.token.policy.global.refreshTokenValiditySeconds

Default: 2592000 (30 days) Source: @Value("${jwt.token.policy.global.refreshTokenValiditySeconds:2592000}") in OauthEndpointBeanConfiguration Type: int

Global default for refresh token lifetime in seconds. Applies to all zones unless overridden.

Back to table


jwt.token.refresh.format

Default: opaque Source: @Value in OauthEndpointBeanConfiguration Type: String

Format of issued refresh tokens. Accepted values:

  • opaque — Opaque, randomly generated token stored in the database
  • jwt — Self-contained JWT refresh token

Back to table


jwt.token.refresh.unique

Default: -1 (unlimited) Source: @Value("${jwt.token.refresh.unique:false}") in OauthEndpointBeanConfiguration Type: integer (or boolean for backwards compatibility)

Maximum number of concurrent active refresh tokens (sessions) allowed per user/client pair.

This property was originally a boolean. It has been changed to an integer to support arbitrary limits, but the legacy boolean values are still supported and parsed as follows:

  • false (or any non-positive integer like 0 or -1) — no limit (default behaviour)
  • true — equivalent to 1; at most one active refresh token per user/client pair
  • A positive integer N — at most N concurrent refresh tokens per user/client pair

When the limit is reached, the oldest refresh token is revoked to make room for the new one. Enforcement only takes effect when refresh tokens are revocable/stored (opaque refresh tokens are always stored; JWT refresh tokens require jwt.token.revocable to be true so UAA can track and delete them).

Per-client overrides are supported: set refreshTokenUnique in the client's additionalInformation map to an integer to override the zone-level policy for that specific client.

Example — limit all users to two concurrent sessions:

jwt:
  token:
    revocable: true
    refresh:
      unique: 2

Related properties: jwt.token.revocable, jwt.token.refresh.rotate

Back to table


jwt.token.refresh.rotate

Default: false Source: @Value("${jwt.token.refresh.rotate:false}") in OauthEndpointBeanConfiguration Type: boolean

When true, a new refresh token is issued each time the current refresh token is used to obtain a new access token (refresh token rotation).

Back to table


jwt.token.refresh.restrict_grant

Default: — (not set) Source: Referenced in uaa.yml comments Type: boolean

When true, refresh tokens are only granted to clients that have refresh_token in their scopes for offline access.

Back to table


jwt.token.claims.exclude

Default: [] (empty set) Source: @config['jwt.token.claims.exclude'] in OauthEndpointBeanConfiguration Type: List<String>

A list of claim names to exclude from issued JWT tokens. For example, to omit the authorities claim: exclude: [authorities]. cnf cannot be excluded: it is the RFC 8705 certificate binding of a token issued to a client registered with tls_client_certificate_bound_access_tokens: true, and removing it would turn that token into a bearer token.

Back to table


jwt.token.idToken.enhancer.allowClaimModification

Default: false Source: @Value("${jwt.token.idToken.enhancer.allowClaimModification:false}") in OauthEndpointBeanConfiguration Type: boolean

Controls whether registered IdTokenEnhancer beans may overwrite claims that already exist on the id_token. When false (the default), enhancers may only add new claims; any attempt to change a claim already set by IdTokenCreator or by another enhancer is ignored and the original value is preserved. Set to true to let enhancers replace the value of existing claims. Adding brand-new claims never requires this flag.

Enhancer implementations register as IdTokenEnhancer beans and read the OAuth2Authentication, the access-token claims, and the refresh-token claims through the supplied IdTokenEnhancementContext.

Back to table


oauth.clients

Default: {} (empty) Source: Loaded via @config['oauth']['clients'] Type: Map<String, OAuthClientConfig>

Bootstrap client definitions loaded at startup. Each entry is keyed by client ID and contains:

  • id — Client ID
  • secret — Client secret
  • authorized-grant-types — Comma-separated grant types
  • scope — Comma-separated scopes
  • authorities — Comma-separated authorities
  • redirect-uri — Comma-separated redirect URIs
  • autoapprove — Auto-approved scopes
  • allowpublic — Allow public (no secret) auth
  • jwks — Inline JWKS for private_key_jwt auth
  • jwks_uri — URI to fetch JWKS
  • jwt_creds — JSON string of federated private_key_jwt credentials (RFC 7523), each with iss, either sub or sub_pattern, and an optional aud. See UAA-Client-Authentication.md for subject patterns.
  • name — Display name
  • signup_redirect_url — Where a user is sent after confirming a self-service signup and setting a password, when the signup request carries no redirect_uri that matches one of the client's registered redirect URIs. Without it the default is the UAA home page.
  • change_email_redirect_url — Where a user is sent after verifying an email change, when the verification link carries no redirect_uri that matches one of the client's registered redirect URIs. Without it the user is sent to the profile page (or the login page when signed out). POST /email_changes returns this value as redirect_url.

signup_redirect_url and change_email_redirect_url are stored as additional information of the client. They are keys of the client definition (see scripts/boot/uaa.yml) and top-level attributes of the client in the client registration API.

Back to table


oauth.client.override

Default: — (not set) Source: UaaConfiguration.OAuth.Client Type: String (boolean-like)

When true, existing OAuth clients are overwritten on bootstrap with the values defined in the configuration file.

Back to table


oauth.client.autoapprove

Default: [] Source: UaaConfiguration.OAuth.Client Type: List<String>

List of client IDs that are auto-approved for all scopes (user consent is not requested).

Back to table


oauth.client.allowpublic

Default: [] (empty — no clients allowed without a secret) Source: @config['oauth']['client']['allowpublic'] resolved by ClientAdminBootstrap Type: List<String> (duplicate entries are silently deduplicated at runtime)

List of client IDs that are permitted to authenticate without a client_secret, provided they use PKCE with the S256 code-challenge method. Clients listed here are marked with the allowpublic flag at bootstrap time.

This is the global allowlist applied across all bootstrapped clients. To allow a single client without a secret, you can also set allowpublic: true directly on the individual client entry under oauth.clients.

Example:

oauth:
  client:
    allowpublic:
      - my-spa-client
      - mobile-app-client

Back to table


oauth.user.authorities

Default: [openid, scim.me, cloud_controller.read, cloud_controller.write, cloud_controller_service_permissions.read, password.write, scim.userids, uaa.user, approvals.me, oauth.approvals, profile, roles, user_attributes, uaa.offline_token] Source: @config['oauth']['user']['authorities'] in OauthEndpointBeanConfiguration Type: List<String>

Default authorities (group memberships) automatically assigned to every new user.

Back to table


clientMaxCount

Default: 500 Source: @Value("${clientMaxCount:500}") in ClientAdminEndpoints Type: int

Maximum number of clients returned in a single list/search response from the client admin API (/oauth/clients).

Back to table


uaa.mtls.enabled

Default: false Source: @Value("${uaa.mtls.enabled:false}") in MtlsFeaturePolicy and the deployment's connector, filter, discovery, and client-registration configuration. Type: boolean

Master switch enabling RFC 8705 mutual-TLS client authentication (tls_client_auth) deployment-wide. This is connector-wide: it affects every TLS connection to this UAA instance, not just requests to the mTLS token endpoint (/oauth/mtls/token). Client registration does not depend on it: mTLS client configuration is validated on every create, update and bootstrap whether or not the switch is on.

When true, the embedded Tomcat connector is reconfigured to request a client certificate during every TLS handshake (certificateVerification=optionalNoCA), without validating it against any CA at the transport layer -- the trust decision is deferred entirely to per-client application logic (see docs/UAA-Client-Authentication.md for the per-client tls-client-auth-* properties). Enabling this also switches the connector to the FIPS BouncyCastle JSSE provider, required for TLS 1.3 client-certificate support (OpenJDK's JSSE does not implement server-side TLS 1.3 post-handshake client-certificate requests).

When false (the default), no client certificate is requested at the TLS layer at all, /oauth/mtls/token (and everything below it) answers 404, OIDC discovery advertises no tls_client_auth, no mtls_endpoint_aliases and no tls_client_certificate_bound_access_tokens, and a stored mTLS client cannot authenticate at all.

Registering tls_client_certificate_bound_access_tokens=true requires a nonblank per-client tls-client-auth-ca or valid tls-client-auth-ca-ref, and exactly one subject binding. UAA refuses secret-only authentication for a stored client that requires binding and checks for certificate confirmation before signing its access tokens. When tls_client_auth_subject_dn is used, malformed DN syntax is rejected by the client APIs and oauth.clients bootstrap. Per-client trust may use a root or intermediate CA; the peer's certificate chain may include the configured trust anchor and its parent certificates.

The value is read the same way everywhere -- true, 1, yes and on all enable it -- so the feature cannot be half-enabled by an unusual spelling.

All mTLS beans and the security chain are created regardless of this flag. Availability is enforced at runtime: both this deployment switch and config.mtls.enabled in the current identity zone must be enabled. The zone flag defaults to false when omitted, so each tenant zone opts in; it can be changed without restarting UAA. With a zone disabled, its mTLS endpoints return 404 and OIDC discovery omits the mTLS authentication method and endpoint alias. Existing mTLS clients cannot use their secrets as a fallback. Other zones remain unaffected; issued tokens are not revoked by changing the flag. The default zone's flag is initialized from this property on every restart; other zones retain their stored flags.

Token enhancers. MtlsClaimsEnhancer is always registered in the same list as any other UaaTokenEnhancer a deployment provides. It is active only when both mTLS switches are enabled and does not activate refresh-claim copying while inactive. It adds nothing to a request that was not authenticated with tls_client_auth, and it does not restrict or alter any other enhancer: claims from other enhancers are applied exactly as they were before. The one thing it asks for is that its certificate-derived sub and aud survive UAA's defaults, which it does through the opt-in UaaTokenEnhancer.getLateOverrideClaims() (empty by default). If two enhancers emit the same custom claim, the later one in the list wins; MtlsClaimsEnhancer has no explicit order.

uaa.mtls.enabled: true

or, nested, which resolves to the same property:

uaa:
  mtls:
    enabled: true

The uaa.mtls namespace is reserved for this feature's deployment-wide options.

Back to table


uaa.mtls.trust_bundles

Default: {} Type: Map<String, String> Source: Binder in configuration wiring

Defines named PEM CA trust bundles for the default UAA identity zone. Each value is a single X.509 certificate or multiple concatenated PEM certificates, allowing an old/new CA overlap during rotation. Names are case-sensitive, 1 to 128 characters, use letters, digits, dots, underscores or hyphens, and start with a letter or digit. Malformed definitions prevent startup, whether or not mTLS is enabled. These settings are reapplied on restart. Use quoted bracket notation for YAML bundle names containing underscores, for example "[instance_identity]", to preserve the literal name during Spring Boot map binding.

uaa:
  mtls:
    enabled: true
    trust_bundles:
      instance-identity: <CA certificate PEM>
      backend-proxy: <proxy CA certificate PEM>

Clients use tls-client-auth-ca-ref or tls-client-auth-trusted-proxy-ca-ref; the corresponding inline PEM property and reference are mutually exclusive. Referencing clients are validated whether or not mTLS is enabled and require their individual certificate subject binding. Unknown references are rejected at registration. References are not rechecked at startup or when a zone enables mTLS; one that no longer resolves, for example after its bundle is removed, denies the referencing client at token time. Trust is resolved from the client's current zone only. Proxy trust also requires the per-client tls-client-auth-trusted-proxy-subject-dn string: the full RFC 4514 subject DN of the genuine proxy certificate, for example CN=gorouter_backend_tls. It has no default and is mandatory with either proxy CA property. A CA match alone never authorizes XFCC forwarding. See proxy client configuration for direct and proxy examples.

Other zones use config.mtls.trustBundles in the identity-zone API and do not inherit the default zone's bundles. Their config.mtls.enabled flag controls availability within the deployment's master switch. An authenticated client administrator can list names through GET /oauth/mtls/trust-bundles; PEM contents are not returned. See Named CA trust bundles.

Related Properties: uaa.mtls.enabled

Back to table


password.policy.global.minLength

Default: 0 Source: @Value("${password.policy.global.minLength:0}") in ScimBeanConfiguration Type: int

Global minimum password length. Applies across all zones unless overridden. Set to 0 to impose no minimum.

Back to table


password.policy.global.maxLength

Default: 255 Source: @Value("${password.policy.global.maxLength:255}") in ScimBeanConfiguration Type: int

Global maximum password length.

Back to table


password.policy.global.requireUpperCaseCharacter

Default: 0 Source: @Value in ScimBeanConfiguration Type: int

Global minimum number of uppercase characters required. 0 means not enforced.

Back to table


password.policy.global.requireLowerCaseCharacter

Default: 0 Source: @Value in ScimBeanConfiguration Type: int

Global minimum number of lowercase characters required.

Back to table


password.policy.global.requireDigit

Default: 0 Source: @Value in ScimBeanConfiguration Type: int

Global minimum number of digit characters required.

Back to table


password.policy.global.requireSpecialCharacter

Default: 0 Source: @Value in ScimBeanConfiguration Type: int

Global minimum number of special characters required.

Back to table


password.policy.global.expirePasswordInMonths

Default: 0 (no expiry) Source: @Value in ScimBeanConfiguration Type: int

Number of months before a password expires globally. 0 means passwords never expire.

Back to table


password.policy.minLength

Default: Falls back to password.policy.global.minLength Source: @Value("${password.policy.minLength:#{globalPasswordPolicy.getMinLength()}}") in ScimBeanConfiguration Type: int

Minimum password length for the default identity zone. Falls back to the global value if not set.

Back to table


password.policy.maxLength

Default: Falls back to global Source: @Value in ScimBeanConfiguration Type: int

Maximum password length for the default identity zone.

Back to table


password.policy.requireUpperCaseCharacter

Default: Falls back to global Source: @Value in ScimBeanConfiguration Type: int

Required uppercase characters for the default zone.

Back to table


password.policy.requireLowerCaseCharacter

Default: Falls back to global Source: @Value in ScimBeanConfiguration Type: int

Required lowercase characters for the default zone.

Back to table


password.policy.requireDigit

Default: Falls back to global Source: @Value in ScimBeanConfiguration Type: int

Required digits for the default zone.

Back to table


password.policy.requireSpecialCharacter

Default: Falls back to global Source: @Value in ScimBeanConfiguration Type: int

Required special characters for the default zone.

Back to table


password.policy.expirePasswordInMonths

Default: Falls back to global Source: @Value in ScimBeanConfiguration Type: int

Password expiry in months for the default zone.

Back to table


oauth.client.secret.policy.global.minLength

Default: 0 Source: @ConfigurationProperties(prefix = "oauth.client.secret.policy.global") in UaaProperties.GlobalClientSecretPolicy Type: int

Global minimum length for client secrets. Applies across all zones unless overridden.

Back to table


oauth.client.secret.policy.global.maxLength

Default: 255 Source: UaaProperties.GlobalClientSecretPolicy Type: int

Global maximum length for client secrets.

Back to table


oauth.client.secret.policy.global.requireUpperCaseCharacter

Default: 0 Source: UaaProperties.GlobalClientSecretPolicy Type: int

Global minimum uppercase chars for client secrets.

Back to table


oauth.client.secret.policy.global.requireLowerCaseCharacter

Default: 0 Source: UaaProperties.GlobalClientSecretPolicy Type: int

Global minimum lowercase chars for client secrets.

Back to table


oauth.client.secret.policy.global.requireDigit

Default: 0 Source: UaaProperties.GlobalClientSecretPolicy Type: int

Global minimum digits for client secrets.

Back to table


oauth.client.secret.policy.global.requireSpecialCharacter

Default: 0 Source: UaaProperties.GlobalClientSecretPolicy Type: int

Global minimum special characters for client secrets.

Back to table


oauth.client.secret.policy.global.expireSecretInMonths

Default: 0 (no expiry) Source: UaaProperties.GlobalClientSecretPolicy Type: int

Number of months before a client secret expires.

Back to table


oauth.client.secret.policy.minLength

Default: Falls back to global Source: UaaProperties.DefaultClientSecretPolicy Type: int

Default zone min client secret length. If set to -1 (or not set), the global value is used.

Back to table


oauth.client.secret.policy.maxLength

Default: Falls back to global Source: UaaProperties.DefaultClientSecretPolicy Type: int

Default zone max client secret length. If -1, uses global.

Back to table


authentication.policy.global.lockoutAfterFailures

Default: 5 Source: @Value("${authentication.policy.global.lockoutAfterFailures:5}") in OauthEndpointBeanConfiguration Type: int

Global number of consecutive failed login attempts before locking the account.

Back to table


authentication.policy.global.countFailuresWithinSeconds

Default: 1200 (20 minutes) Source: @Value("${authentication.policy.global.countFailuresWithinSeconds:1200}") in OauthEndpointBeanConfiguration Type: int

Global time window (in seconds) during which failed attempts are counted toward lockout.

Back to table


authentication.policy.global.lockoutPeriodSeconds

Default: 300 (5 minutes) Source: @Value("${authentication.policy.global.lockoutPeriodSeconds:300}") in OauthEndpointBeanConfiguration Type: int

Global duration (in seconds) for which an account remains locked after exceeding the failure threshold.

Back to table


authentication.policy.lockoutAfterFailures

Default: Falls back to global Source: @Value in OauthEndpointBeanConfiguration Type: int

Default zone lockout failure threshold. Falls back to global if not specified.

Back to table


authentication.policy.countFailuresWithinSeconds

Default: Falls back to global Source: @Value in OauthEndpointBeanConfiguration Type: int

Default zone failure counting window.

Back to table


authentication.policy.lockoutPeriodSeconds

Default: Falls back to global Source: @Value in OauthEndpointBeanConfiguration Type: int

Default zone lockout duration.

Back to table


authentication.enableUriEncodingCompatibilityMode

Default: false Source: @Value("${authentication.enableUriEncodingCompatibilityMode:false}") in OauthEndpointBeanConfiguration Type: boolean

Enables a backward-compatible URI encoding mode for client authentication. When true, client credentials are decoded using a legacy algorithm for compatibility with older clients.

Back to table


scim.users

Default: [] (empty) Source: @config['scim']['users'] in ScimBeanConfiguration Type: List<String>

Bootstrap users created at startup. Each entry is a pipe-delimited string: username|password|email|firstName|lastName|groups[|origin]

Example:

scim:
  users:
    - admin|admin|admin@example.com|Admin|User|uaa.admin
    - marissa|koala|marissa@test.org|Marissa|Bloggs|uaa.user

Back to table


scim.groups

Default: {} Source: Loaded via @config['scim']['groups'] Type: Map<String, String>

Bootstrap groups created at startup. Keys are group names, values are human-readable descriptions. These groups are created in the default identity zone.

scim:
  groups:
    scim.read: Read all SCIM entities
    scim.write: Create, modify and delete SCIM entities

Back to table


scim.external_groups

Default: [] Source: Loaded via config map Type: List<String>

Mappings from external (LDAP) groups to internal UAA groups. Each entry is pipe-delimited: internal_group|external_group_dn

scim:
  external_groups:
    - internal.read|cn=developers,ou=scopes,dc=test,dc=com

Back to table


scim.userids_enabled

Default: true Source: @Value("${scim.userids_enabled:true}") in UserIdConversionEndpoints Type: boolean

Enables the /ids/Users endpoint for converting usernames to user IDs.

Back to table


scim.user.override

Default: false Source: @Value("${scim.user.override:false}") in ScimBeanConfiguration Type: boolean

When true, bootstrap users defined in scim.users overwrite existing users with the same username on every startup.

Back to table


scim.delete.deactivate

Default: false Source: @Value("${scim.delete.deactivate:false}") in JdbcScimUserProvisioning Type: boolean

When true, SCIM user DELETE operations deactivate the user (set active=false) instead of permanently deleting the record.

Back to table


scim.invite.allow_reinvite

Default: true Source: @Value("${scim.invite.allow_reinvite:true}") in InvitationsEndpoint Type: boolean

Controls what POST /invite_users returns for an email address that belongs to a user who is already verified.

  • true (default): the user is invited like any other user. The response lists the address under new_invites with the user's userId and a new inviteLink.
  • false: when the token has scim.invite but may not read users, that is when GET /Users would refuse it (for example it has neither scim.read nor the zone administrator scope), the address is listed under failed_invites with the error code user.already-verified and the message The user is already verified.. No user id and no link are returned, and no invitation code is created. A token that may read users still gets the user id and the link.

With either value, users who are not verified yet and new users are invited as before, so an expired invitation can always be sent again, and the other addresses of a batch are processed as usual.

Before setting false, check the clients that call /invite_users. A client that holds scim.invite without scim.read, re-invites existing users and relies on the user id or the link in the response (for example to assign permissions or to send the link itself) receives failed_invites for verified users. Give such a client scim.read, or leave the property at true.

Which users are verified: users created with POST /Users are verified unless the request says otherwise, users of the uaa origin become verified when they accept an invitation, and users of an external origin are verified only when their identity provider says so (for example the email_verified claim of an OpenID Connect provider).

Back to table


userMaxCount

Default: 500 Source: @Value("${userMaxCount:500}") in ScimUserEndpoints Type: int

Maximum number of users returned in a single list/search response from the SCIM Users API.

Back to table


groupMaxCount

Default: 500 Source: @Value("${groupMaxCount:500}") in ScimGroupEndpoints Type: int

Maximum number of groups returned in a single list/search response from the SCIM Groups API.

Back to table


delete.users

Default: — (null) Source: @Value("${delete.users:#{null}}") in ScimBeanConfiguration Type: List<String>

List of usernames to delete on bootstrap. Used to remove specific users during startup.

Back to table


login.selfServiceLinksEnabled

Default: true Source: @ConfigurationProperties(prefix = "login") in UaaProperties.Login Type: boolean

When true, "Create Account" and "Forgot Password" links are displayed on the login page.

Note on self-service account confirmation. Clicking the activation link in the confirmation email verifies ownership of the email address but does not activate the password typed on the registration form. The owner is sent to a password-setup page (stating that a password change is required due to changes in the system) and must establish their own password through the link before the account can be used to sign in. This ensures a password chosen before the email address was verified can never be used to authenticate. The redirect configured for the registration is applied after the owner has set their password: an explicit redirect_uri when it matches one of the client's registered redirect URIs, otherwise the client's signup_redirect_url, which does not have to be a registered redirect URI. Opening another activation link for an account that is already confirmed changes nothing: the password stays as it is and the user is sent to the login page.

Note on addresses that already have an account. The registration form (/create_account.do) and the change email form (/change_email.do) answer the same way whether or not the address already has a verified account in the zone's uaa origin: the user is sent to the "email sent" page, and no 422 response or "There is already a user with that username" message is shown. After a registration the page names the address the email was sent to. When the address already has an account, no activation or verification link is created. The owner of the address instead receives an email stating that the address already has an account and that nothing has changed. Clients that parsed the previous 422 page of these two forms must be updated.

Back to table


login.homeRedirect

Default: — (null) Source: UaaProperties.Login Type: String

URL to redirect to after successful login if no redirect was requested.

Back to table


login.idpDiscoveryEnabled

Default: false Source: UaaProperties.Login Type: boolean

When true, the login page first asks for the user's email to discover which identity provider (IDP) should be used for authentication.

Back to table


login.accountChooserEnabled

Default: false Source: UaaProperties.Login Type: boolean

When true, users see an account chooser UI that lets them pick from previously used accounts.

Back to table


login.entityBaseURL

Default: http://localhost:8080/uaa Source: @Value("${login.entityBaseURL:http://localhost:8080/uaa}") in SpringServletXmlBeansConfiguration, SamlRelyingPartyRegistrationRepositoryConfig Type: String

The base URL of this UAA instance for SAML SP metadata generation. This URL appears in the SAML metadata as the service provider's base location and is used to construct AssertionConsumerService (ACS) and SingleLogoutService (SLS) endpoints.

When null or empty: UAA derives the base URL from the incoming HTTP request, which works for subdomain-based zones but provides automatic hostname resolution.

Important: The behavior of entityBaseURL varies depending on the identity zone access pattern:

Zone Access Pattern Behavior Example
Default (UAA) zone Uses entityBaseURL as-is http://localhost:8080/uaa → ACS: http://localhost:8080/uaa/saml/SSO/alias/...
Non-default zone, subdomain access Prepends zone subdomain to entityBaseURL host http://localhost:8080/uaa + zone myzone → ACS: http://myzone.localhost:8080/uaa/saml/SSO/alias/...
Non-default zone, path access (zones.paths.enabled=true) Ignores entityBaseURL; derives from request Request to /z/myzone/saml/metadata → ACS: http://localhost/z/myzone/saml/SSO/alias/...

Zone Path Access Pattern: When zones.paths.enabled=true and zones are accessed via /z/{subdomain}/ URLs, entityBaseURL is ignored because it's a static configuration value that cannot encode the dynamic zone path. The SAML metadata URLs are derived from the incoming request, which already contains the zone path information thanks to the ZonePathContextRewritingFilter.

When to set entityBaseURL: Configure this when deploying behind load balancers or proxies where the internal server hostname/port differs from the externally accessible URL. This ensures SAML metadata contains stable, publicly reachable endpoints.

Back to table


login.entityID

Default: unit-test-sp (production deployments should override) Source: @Value("${login.entityID:unit-test-sp}") in SamlConfiguration Type: String

The SAML entity ID (issuer name) for this UAA instance as a SAML Service Provider. This value is declared in SAML SP metadata as the entityID attribute.

Back to table


login.prompt.username.text

Default: Email Source: @Value("${login.prompt.username.text:Email}") in SpringServletXmlBeansConfiguration Type: String

The label text displayed for the username input field on the login page.

Back to table


login.prompt.password.text

Default: Password Source: @Value("${login.prompt.password.text:Password}") in SpringServletXmlBeansConfiguration Type: String

The label text displayed for the password input field on the login page.

Back to table


login.branding

Default: — (null) Source: UaaProperties.Login Type: Map<String, Object>

Customizes the visual branding of the login UI. Supports the following sub-keys:

  • companyName — Company name displayed in the UI
  • productLogo — Base64-encoded product logo image
  • squareLogo — Base64-encoded square logo
  • footerLegalText — Legal text in the footer
  • footerLinks — Map of link names to URLs
  • banner.logo — Base64-encoded banner logo
  • banner.text — Banner text
  • banner.textColor — Banner text color (hex)
  • banner.backgroundColor — Banner background color (hex)
  • banner.link — Banner link URL
  • loginConsent — Login consent modal configuration (see sub-properties below)

Login Consent Configuration (loginConsent):

  • enabled — (boolean, default: false) When true, displays a mandatory consent modal on login
  • title — (string, default: "Terms and Conditions") Modal heading text
  • text — (string, required when enabled) Body content; HTML is allowed
  • acceptButtonText — (string, default: "I Agree") Text for the accept button
  • declineButtonText — (string, default: "Decline") Text for the decline button when declineLink is provided
  • declineLink — (string, optional) If set, must be a valid HTTP/HTTPS URL; displays as a decline link
  • consentValidDuration — (string, default: "1d") How long acceptance is remembered (e.g., "12h", "7d", "0" for always prompt)

Back to table


login.defaultIdentityProvider

Default: — (null) Source: UaaProperties.Login Type: String

When set, automatically routes users to the specified IDP origin key, skipping the login page.

Back to table


login.allowedGroups

Default: — (null, no restriction) Source: @Value("${login.allowedGroups:#{null}}") in SpringServletXmlBeansConfiguration Type: List<String>

When set, only users who are members of at least one of these groups can log in. Null means no restriction.

Back to table


login.checkOriginEnabled

Default: false Source: @Value("${login.checkOriginEnabled:false}") in SpringServletXmlBeansConfiguration Type: boolean

When true, the UAA checks the user's origin during authentication to ensure it matches the expected IDP.

Back to table


login.maxUsers

Default: -1 (unlimited) Source: @Value("${login.maxUsers:-1}") in SpringServletXmlBeansConfiguration Type: int

Maximum number of users allowed in the system. -1 means unlimited.

Back to table


login.allowOriginLoop

Default: true Source: @Value("${login.allowOriginLoop:true}") in SpringServletXmlBeansConfiguration Type: boolean

When true, allows redirect loops between origins during authentication flows.

Back to table


login.aliasEntitiesEnabled

Default: false Source: @Value("${login.aliasEntitiesEnabled:false}") in AliasEntitiesConfig Type: boolean

When true, enables identity provider and client alias entities across identity zones.

Back to table


login.oauth.providers

Default: — (not set) Source: @config['login']['oauth']['providers'] in SpringServletXmlBeansConfiguration Type: Map<String, Map>

External OAuth 2.0 and OIDC provider definitions. Each provider entry includes:

  • type — oauth2.0 or oidc1.0
  • authUrl / discoveryUrl — Authorization or discovery URL
  • tokenUrl — Token endpoint
  • tokenKey / tokenKeyUrl — Key for token verification
  • issuer — Expected token issuer
  • scopes — List of scopes to request
  • linkText — Text for the login link
  • relyingPartyId / relyingPartySecret — Client credentials
  • attributeMappings — Attribute mapping configuration
  • skipSslValidation — Skip TLS validation when calling the provider. This disables both certificate chain validation and hostname verification, offering no protection against man-in-the-middle attacks; it is intended for development and diagnostics. To trust a private CA in production, use caCertificates instead, which keeps validation enabled. Default false
  • caCertificates — List of PEM-encoded CA certificates to trust, in addition to the JVM's default trust store, when calling the provider. Each entry may contain a single certificate or multiple concatenated PEM certificates (e.g. a full chain); use multiple entries to supply independent trust anchors, such as during a CA rotation. Ignored if skipSslValidation is true

Back to table


login.oauth.externalGroupsFromMappedAuthorities

Default: false Source: @Value("${login.oauth.externalGroupsFromMappedAuthorities:false}") in OauthEndpointBeanConfiguration (bean externalOAuthAuthenticationManager) Type: boolean

When false (default), external OAuth login populates UaaAuthentication external group names from IdP token authorities before UAA group mapping (externalAuthorities). When true, external group names are taken from mapped UAA authorities (authorities after mapExternalGroups), for deployments that want downstream external-group membership logic to follow mapped group or scope names instead of raw IdP values.

Back to table


login.saml.activeKeyId

Default: — (none) Source: SamlConfigProps Type: String

The ID of the active key from the login.saml.keys map. SAML requests and metadata are signed with this key.

Back to table


login.saml.keys

Default: {} (empty) Source: SamlConfigProps Type: Map<String, SamlKey>

Map of key IDs to SAML key configurations. Each key has:

  • key — RSA private key in PEM format
  • certificate — X.509 certificate in PEM format
  • passphrase — Optional key passphrase

Back to table


login.saml.entityIDAlias

Default: — (null, falls back to login.entityID) Source: SamlConfigProps Type: String

Alias for the SAML SP entity ID. Used in SSO URLs like /saml/SSO/alias/{entityIDAlias}. If not set, falls back to the host portion of login.entityID.

Back to table


login.saml.nameID

Default: urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified Source: SamlConfigProps, @Value("${login.saml.nameID:...}") in SamlRelyingPartyRegistrationRepositoryConfig Type: String

Default SAML NameID format requested in authentication requests.

Back to table


login.saml.assertionConsumerIndex

Default: 0 Source: SamlConfigProps Type: int

The index of the Assertion Consumer Service (ACS) endpoint to use.

Back to table


login.saml.signMetaData

Default: true Source: SamlConfigProps Type: Boolean

When true, the generated SAML SP metadata includes a signature. When false, no signature is included in the metadata XML.

Back to table


login.saml.signRequest

Default: true Source: SamlConfigProps Type: Boolean

When true, SAML authentication requests (AuthnRequest) sent to IDPs are signed.

Back to table


login.saml.wantAssertionSigned

Deprecated since 78.13.0; scheduled for removal in a future release. The property is still read for backward compatibility.

Default: true Source: SamlConfigProps Type: Boolean

Deprecated since 78.13.0 - scheduled for removal. When true, the SP metadata declares that it wants incoming SAML assertions to be signed (WantAssertionsSigned). This flag no longer affects authentication behavior - UAA always attempts to decrypt encrypted assertions regardless of this setting. Authentication always requires a verifiable IdP XML signature on the response or on every assertion after decryption.

Back to table


login.saml.signatureAlgorithm

Default: SHA256 Source: SamlConfigProps Type: String

Algorithm used for SAML signatures. Accepted values: SHA1, SHA256, SHA512.

Back to table


login.saml.disableInResponseToCheck

Default: false Source: SamlConfigProps Type: Boolean

When true, the InResponseTo field in incoming SAML assertions is not validated. Useful for IDP-initiated SSO flows.

Back to table


login.saml.providers

Default: — (not configured) Source: BootstrapSamlIdentityProviderData (via EnvironmentAware) Type: Map<String, Map<String, Object>>

Bootstrap SAML Identity Provider definitions. Each entry is keyed by a provider alias (the IDP origin key) and supports:

Field Type Description
idpMetadata String Required. Inline metadata XML or HTTP/HTTPS URL to the IDP metadata endpoint
nameID String NameID format. Defaults to login.saml.nameID
assertionConsumerIndex int ACS index. Default 0
metadataTrustCheck boolean Validate metadata signature. Default true
showSamlLoginLink boolean Show login link on login page. Default true
linkText String Label for the login link
iconUrl String Icon URL for the login link
addShadowUserOnLogin boolean Create a local shadow user on first SAML login. Default true
emailDomain List<String> Email domains used for IDP discovery. Domains longer than 255 UTF-16 code units do not match.
externalGroupsWhitelist List<String> External group names to map
attributeMappings Map<String, Object> Attribute mapping configuration
skipSslValidation boolean Skip TLS validation when fetching metadata URL. Disables both certificate chain validation and hostname verification, offering no protection against man-in-the-middle attacks; intended for development and diagnostics. Use caCertificates to trust a private CA in production. Default false
caCertificates List<String> PEM-encoded CA certificates to trust, in addition to the JVM's default trust store, when fetching the metadata URL. Each entry may contain a single certificate or multiple concatenated PEM certificates (e.g. a full chain); use multiple entries to supply independent trust anchors, such as during a CA rotation. Ignored if skipSslValidation is true
storeCustomAttributes boolean Persist custom SAML attributes on the user. Default true
authnContext List<String> Requested authentication context class references
override boolean Overwrite an existing provider with the same alias on startup. Default true

When SAML sign-in fails during a saved authorization request (for example, when addShadowUserOnLogin is false and no shadow user exists), UAA sends error=access_denied and error_description only to a redirect_uri that resolves against the client's registered redirect URIs in the current identity zone. If the saved URI is malformed or unregistered, or the client_id is missing or unknown, UAA falls back to /saml_error.

idpMetadata and entity ID resolution

The value of idpMetadata determines how UAA parses the IDP's entity ID:

  • Inline XML (value starts with <?xml, <md:EntityDescriptor, or <EntityDescriptor): UAA parses the XML synchronously at startup. If the XML is invalid or the entity ID cannot be extracted, startup fails immediately. This is the most reliable form — the IDP entity ID is always stored in the database (external_key column) and IDP-initiated SSO works without any network dependency at authentication time.

  • HTTP/HTTPS URL (value starts with http): UAA fetches and parses the metadata URL at startup. If the IDP is temporarily unreachable (e.g. DNS not ready, network partition), UAA logs an error and continues startup, but the entity ID is not stored in the database. Until the IDP metadata becomes reachable and UAA is restarted (or the provider is re-saved via the API), IDP-initiated SSO for that provider depends on per-request dynamic metadata resolution. If the IDP is unreachable at authentication time as well, IDP-initiated SSO will fail.

Recommendation: For URL-type idpMetadata, ensure the IDP metadata endpoint is reachable when UAA starts. If it is not, restart UAA once the IDP is available so that the entity ID is resolved and persisted, enabling efficient and reliable IDP-initiated SSO lookups.

Back to table


login.serviceProviderKey

Default: — (none) Source: UaaProperties.Login, SamlConfigProps (deprecated since 77.20.0) Type: String

Legacy property for the SAML SP private key. Use login.saml.keys instead. The key, password, and certificate are grouped together:

  • login.serviceProviderKey — RSA private key in PEM
  • login.serviceProviderKeyPassword — Key passphrase
  • login.serviceProviderCertificate — X.509 certificate in PEM

Back to table


logout.redirect.url

Default: /login Source: @ConfigurationProperties(prefix = "logout") in UaaProperties.Logout Type: String

URL to redirect to after logout. Relative URLs are resolved against the UAA base URL.

Back to table


logout.redirect.parameter.disable

Default: false Source: UaaProperties.LogoutRedirectParameter Type: boolean

When true, the redirect query parameter on the logout endpoint is ignored.

Back to table


logout.redirect.parameter.whitelist

Default: [] (empty, no restriction) Source: UaaProperties.LogoutRedirectParameter Type: List<String>

Allowed redirect URLs for the logout endpoint. If empty, all redirects are allowed.

logout:
  redirect:
    parameter:
      whitelist:
        - https://app1.example.com/logout-success
        - https://app2.example.com/logout-success

Back to table


links.global.passwd

Default: — (null, uses internal /forgot_password) Source: @Value("${links.global.passwd:#{null}}") in SpringServletXmlBeansConfiguration Type: String

Custom URL for the "Forgot Password" link on the login page. When null, the UAA's internal forgot-password flow is used.

Back to table


links.global.signup

Default: — (null, uses internal /create_account) Source: @Value("${links.global.signup:#{null}}") in SpringServletXmlBeansConfiguration Type: String

Custom URL for the "Create Account" link on the login page. When null, the UAA's internal account creation flow is used.

Back to table


links.global.homeRedirect

Default: — (null) Source: @Value("${links.global.homeRedirect:#{null}}") in SpringServletXmlBeansConfiguration Type: String

URL to redirect to after login when no target redirect was specified.

Back to table


cors.enforceSystemZonePolicyInAllZones

Default: false Source: @Value("${cors.enforceSystemZonePolicyInAllZones:false}") in CorsProperties Type: boolean

When true, the system (default) zone's CORS policy is enforced in all identity zones, overriding per-zone CORS configurations.

Back to table


cors.default.max_age

Default: 1728000 (20 days) Source: @Value("${cors.default.max_age:1728000}") in CorsProperties Type: int

Maximum time (in seconds) a preflight response can be cached for default CORS requests.

Back to table


cors.default.allowed.uris

Default: [".*"] (all URIs) Source: CorsProperties.DefaultAllowed Type: List<String>

Regex patterns for URIs that allow CORS requests (non-XHR). Default permits all.

Back to table


cors.default.allowed.origins

Default: [".*"] (all origins) Source: CorsProperties.DefaultAllowed Type: List<String>

Regex patterns for allowed CORS origins (non-XHR).

Back to table


cors.default.allowed.headers

Default: [Accept, Authorization, Content-Type, Accept-Language, Content-Language] Source: CorsProperties.DefaultAllowed Type: List<String>

Allowed request headers for default CORS.

Back to table


cors.default.allowed.methods

Default: [GET, POST, PUT, OPTIONS, DELETE, PATCH] Source: CorsProperties.DefaultAllowed Type: List<String>

Allowed HTTP methods for default CORS.

Back to table


cors.default.allowed.credentials

Default: false Source: CorsProperties.DefaultAllowed Type: boolean

Whether default CORS responses include Access-Control-Allow-Credentials: true.

Back to table


cors.xhr.max_age

Default: 1728000 (20 days) Source: @Value("${cors.xhr.max_age:1728000}") in CorsProperties Type: int

Maximum preflight cache time for XHR CORS requests.

Back to table


cors.xhr.allowed.uris

Default: [".*"] Source: CorsProperties.XhrAllowed Type: List<String>

Regex patterns for URIs that allow XHR CORS requests.

Back to table


cors.xhr.allowed.origins

Default: [".*"] Source: CorsProperties.XhrAllowed Type: List<String>

Regex patterns for allowed XHR CORS origins.

Back to table


cors.xhr.allowed.headers

Default: [Accept, Authorization, Content-Type, Accept-Language, Content-Language, X-Requested-With] Source: CorsProperties.XhrAllowed Type: List<String>

Allowed request headers for XHR CORS. Includes X-Requested-With by default.

Back to table


cors.xhr.allowed.methods

Default: [GET, OPTIONS] Source: CorsProperties.XhrAllowed Type: List<String>

Allowed HTTP methods for XHR CORS. More restrictive than the default CORS policy.

Back to table


cors.xhr.allowed.credentials

Default: true Source: CorsProperties.XhrAllowed Type: boolean

Whether XHR CORS responses include Access-Control-Allow-Credentials: true. Default is true for XHR.

Back to table


smtp.host

Default: localhost Source: @ConfigurationProperties(prefix = "smtp") in SmtpProperties Type: String

SMTP server hostname for sending emails (account verification, password reset, etc.).

Back to table


smtp.port

Default: 25 Source: SmtpProperties Type: int

SMTP server port.

Back to table


smtp.user

Default: "" (empty) Source: SmtpProperties Type: String

Username for SMTP authentication.

Back to table


smtp.password

Default: "" (empty) Source: SmtpProperties Type: String

Password for SMTP authentication.

Back to table


smtp.auth

Default: false Source: SmtpProperties Type: boolean

When true, enables SMTP authentication using smtp.user and smtp.password.

Back to table


smtp.starttls

Default: false Source: SmtpProperties Type: boolean

When true, enables STARTTLS encryption for SMTP connections.

Back to table


smtp.sslprotocols

Default: TLSv1.2 Source: SmtpProperties Type: String

SSL/TLS protocol versions to use for SMTP connections.

Back to table


smtp.fromAddress

Default: "" (empty) Source: SmtpProperties Type: String

The "From" address for emails sent by the UAA.

Back to table


notifications.url

Default: — (null) Source: @ConditionalOnProperty(value = "notifications.url") in MessagingConfig Type: String

URL of an external notification service. When set, HTTP-based notifications are used instead of SMTP emails. When not set, falls back to email-based messaging.

Back to table


notifications.sendInDefaultZone

Default: true Source: NotificationsProperties Type: boolean

When true, notifications are sent for events occurring in the default identity zone.

Back to table


notifications.verify_ssl

Default: false Source: NotificationsProperties Type: boolean

When true, verifies SSL certificates when connecting to the notification service.

Back to table


ldap.profile.file

Default: — (not set) Source: YAML config, injected via @config['ldap'] Type: String

Path to the LDAP profile configuration file. Determines the bind mode:

  • ldap/ldap-simple-bind.xml — Simple bind (user DN pattern)
  • ldap/ldap-search-and-bind.xml — Search then bind
  • ldap/ldap-search-and-compare.xml — Search then compare

Back to table


ldap.base.url

Default: — (not set) Source: YAML config Type: String

LDAP server URL (e.g. ldap://localhost:389/ or ldaps://ldap.example.com:636/).

Back to table


ldap.base.userDn

Default: — (not set) Source: YAML config Type: String

The DN used to bind to the LDAP server for user searches (search-and-bind mode).

Back to table


ldap.base.password

Default: — (not set) Source: YAML config Type: String

Password for the bind DN.

Back to table


ldap.base.searchBase

Default: — (not set) Source: YAML config Type: String

Base DN for LDAP user searches (e.g. dc=test,dc=com).

Back to table


ldap.base.searchFilter

Default: — (not set) Source: YAML config Type: String

LDAP search filter for finding users. {0} is replaced with the username (e.g. cn={0} or (uid={0})).

Back to table


ldap.base.userDnPattern

Default: — (not set) Source: YAML config Type: String

DN pattern for simple-bind mode. {0} is replaced with the username. Multiple patterns can be separated by semicolons.

Example: cn={0},ou=Users,dc=test,dc=com;cn={0},ou=OtherUsers,dc=example,dc=com

Back to table


ldap.base.referral

Default: — (not set) Source: YAML config Type: String

How LDAP referrals are handled. Common values: follow, ignore.

Back to table


ldap.ssl.skipverification

Default: false Source: YAML config Type: boolean

When true, skips SSL certificate verification for LDAPS connections. Should only be used in development/testing.

Back to table


ldap.ssl.caCertificates

Default: — (not set) Source: LdapUtils, LdapIdentityProviderDefinition Type: List<String>

List of PEM-encoded CA certificates to trust, in addition to the JVM's default trust store, for LDAPS connections to this LDAP server. Useful when the LDAP server's certificate chain is signed by a private/internal certificate authority and importing it into the JVM truststore is not desired. Each entry may contain a single certificate or multiple concatenated PEM certificates (e.g. a full chain); use multiple entries to supply independent trust anchors, such as during a CA rotation. Ignored if ldap.ssl.skipverification is true.

Back to table


ldap.externalGroupsWhitelist

Default: — (not set); treated as ["*"] (all groups) at login time Source: LdapUtils, LdapLoginAuthenticationManager Type: List<String>

List of external LDAP group names (or wildcard patterns, e.g. admin.*) to include in the ID token//userinfo response when the roles scope is requested. If omitted or empty, all external groups are included at login time, equivalent to ["*"]. This is a login-time behavior only; an omitted/empty value is stored and returned as-is by GET/POST/PUT /identity-providers, it is not rewritten to ["*"].

If you want LDAP group membership to have no effect at all rather than restricting it, set ldap.groups.file to ldap/ldap-groups-null.xml instead, that disables LDAP group lookup entirely, so there are no external groups for this list to filter in the first place. This field can only narrow down which already-retrieved groups are used, it cannot suppress group lookup itself.

Back to table


ldap.groups.file

Default: — (not set) Source: YAML config Type: String

Path to the LDAP groups configuration file (e.g. ldap/ldap-groups-map-to-scopes.xml).

Back to table


ldap.groups.searchBase

Default: — (not set) Source: YAML config Type: String

Base DN for LDAP group searches.

Back to table


ldap.groups.groupSearchFilter

Default: — (not set) Source: YAML config Type: String

Filter for finding group membership (e.g. member={0}).

Back to table


ldap.groups.maxSearchDepth

Default: 10 Source: YAML config Type: int

Maximum depth for nested group lookups.

Back to table


ldap.groups.autoAdd

Default: — (not set) Source: YAML config Type: boolean

When true, LDAP groups are automatically created as UAA groups if they don't exist.

Back to table


encryption.active_key_label

Default: — (required) Source: UaaConfiguration.Encryption Type: String

Label identifying the active encryption key from the encryption_keys list. Used for encrypting new data. All listed keys can be used for decryption.

Back to table


encryption.encryption_keys

Default: — (required) Source: UaaConfiguration.Encryption Type: List<EncryptionKey>

List of encryption keys. Each key has:

  • label — Unique identifier
  • passphrase — Encryption passphrase
encryption:
  active_key_label: key-1
  encryption_keys:
    - label: key-1
      passphrase: MY-PASSPHRASE
    - label: key-2
      passphrase: MY-OLD-PASSPHRASE

Multiple keys allow for key rotation: new data is encrypted with the active key; old data encrypted with any listed key can still be decrypted.

Back to table


ratelimit.loggingOption

Default: OnlyLimited (only log rate-limited requests) Source: UaaConfiguration.RateLimit Type: String

Controls rate limiting log verbosity. Accepted values:

  • OnlyLimited — Only log when a request is rate-limited
  • AllCalls — Log all calls with rate-limit info
  • AllCallsWithDetails — Log all calls with full details

Back to table


ratelimit.credentialID

Default: — (not set) Source: UaaConfiguration.RateLimit Type: String

Regex pattern to extract a credential identifier from JWT claims for per-credential rate limiting. Example: 'JWT:Claims+"sub"\s*:\s*"(.*?)"'

Back to table


ratelimit.limiterMappings

Default: [] Source: UaaConfiguration.RateLimit Type: List<LimiterMapping>

List of rate limiting rules. Each mapping has:

  • name — Rule name
  • withCallerRemoteAddressID — Per-IP rate limit (e.g. 50r/s)
  • withCallerCredentialsID — Per-credential rate limit
  • global — Global rate limit
  • pathSelectors — List of path matching rules:
    • equals:/path — Exact match
    • startsWith:/prefix — Prefix match
    • other — Catch-all for unmatched paths
ratelimit:
  limiterMappings:
    - name: LoginPage
      withCallerRemoteAddressID: 50r/1s
      pathSelectors:
        - "equals:/login"
    - name: EverythingElse
      global: 1000r/s
      pathSelectors:
        - "other"

Back to table


rest.template.timeout

Default: 10000 (10 seconds) Source: @Value("${rest.template.timeout:10000}") in RestTemplateConfig Type: int

Connection and read timeout (in milliseconds) for outbound HTTP requests made by the UAA (e.g. OIDC metadata fetch, notification service calls).

Back to table


rest.template.maxTotal

Default: 10 Source: @Value("${rest.template.maxTotal:10}") in RestTemplateConfig Type: int

Maximum total number of outbound HTTP connections in the connection pool.

Back to table


rest.template.maxPerRoute

Default: 5 Source: @Value("${rest.template.maxPerRoute:5}") in RestTemplateConfig Type: int

Maximum number of connections per route (per target host).

Back to table


rest.template.maxKeepAlive

Default: 0 (no keep-alive limit) Source: @Value("${rest.template.maxKeepAlive:0}") in RestTemplateConfig Type: int

Maximum keep-alive time (in milliseconds) for persistent HTTP connections. 0 means no limit.

Back to table


rest.template.validateAfterInactivity

Default: 2000 Source: @Value("${rest.template.validateAfterInactivity:2000}") in RestTemplateConfig Type: int

Time (in milliseconds) after which an idle connection is validated before reuse.

Back to table


rest.template.retryCount

Default: 0 Source: @Value("${rest.template.retryCount:0}") in RestTemplateConfig Type: int

Number of times to retry failed outbound HTTP requests. 0 means no retries.

Back to table


brave.localServiceName

Default: uaa Source: @Value("${brave.localServiceName:uaa}") in TracingAutoConfiguration Type: String

The service name reported in distributed traces (Brave/Zipkin).

Back to table


brave.supportsJoin

Default: true Source: @Value("${brave.supportsJoin:true}") in TracingAutoConfiguration Type: boolean

When true, incoming spans can be joined (shared) rather than always creating child spans.

Back to table


brave.traceId128Bit

Default: false Source: @Value("${brave.traceId128Bit:false}") in TracingAutoConfiguration Type: boolean

When true, trace IDs are 128 bits instead of 64 bits. Recommended for compatibility with systems like AWS X-Ray.

Back to table


uaa.shutdown.sleep

Default: 10000 (10 seconds) Source: @Value("${uaa.shutdown.sleep:10000}") in HealthzEndpoint Type: long

Time (in milliseconds) the /healthz endpoint waits during shutdown before the process exits. During this period, the endpoint returns HTTP 503, allowing load balancers to drain connections.

Back to table


uaa.health.db.rate

Default: 10000 (10 seconds) Source: @Scheduled(fixedRateString = "${uaa.health.db.rate:10000}") in HealthzEndpoint Type: long

Interval (in milliseconds) between database connectivity health checks.

Back to table


delete.expirationRunTime

Default: 2500 Source: @Value("${delete.expirationRunTime:2500}") in OauthEndpointBeanConfiguration Type: int

Maximum runtime (in milliseconds) for a single expired-token cleanup run in the revocable token store.

Back to table


uaa.limitedFunctionality.statusFile

Default: — (null, limited mode disabled) Source: @Value("${uaa.limitedFunctionality.statusFile:#{null}}") in LimitedModeProperties Type: File

Path to a file that, when present, puts the UAA into limited-functionality mode. In this mode, only whitelisted endpoints and HTTP methods are allowed.

Back to table


uaa.limitedFunctionality.whitelist.endpoints

Default: {} (empty set) Source: LimitedModeProperties.Permitted Type: Set<String>

Set of endpoint patterns that remain accessible when the UAA is in limited-functionality mode.

Back to table


uaa.limitedFunctionality.whitelist.methods

Default: {} (empty set) Source: LimitedModeProperties.Permitted Type: Set<String>

Set of HTTP methods allowed when the UAA is in limited-functionality mode.

Back to table


metrics.enabled

Default: true Source: @ConfigurationProperties(prefix = "metrics") in UaaProperties.Metrics Type: boolean

Enables or disables metrics collection.

Back to table


metrics.perRequestMetrics

Default: false Source: UaaProperties.Metrics Type: boolean

When true, collects metrics for each individual request (higher overhead). When false, only aggregate metrics are collected. Per-request database query timings use the Tomcat JDBC pool's measured elapsed time in milliseconds, including failed queries, so elapsed durations are unaffected by wall-clock adjustments.

Back to table


zones.paths.enabled

Default: false Source: @Value("${zones.paths.enabled:false}") in ZonePathContextRewritingFilterConfiguration Type: boolean

When true, enables path-based identity zone routing via /z/{subdomain}/ URL prefixes. This allows multiple zones to be accessed through the same hostname using different URL paths instead of different subdomains.

Examples:

  • Subdomain access (default): https://myzone.uaa.example.com/login
  • Path access (when enabled): https://uaa.example.com/z/myzone/login

Important: When path-based zone access is enabled, login.entityBaseURL is ignored for SAML metadata generation in non-default zones, as the zone information is already encoded in the URL path. See the login.entityBaseURL documentation for details on how this affects SAML endpoint URLs.

Required since 2026-10-26: A zone path request must come from a recognized host, like any other request. The hostname must be the host of uaa.url, the host of login.url, localhost, or one of the zones.internal.hostnames; otherwise the request is answered with a 404 before it reaches the zone. Earlier versions accepted any hostname for a zone path request. Deployments that reach zone paths through a hostname that is not yet listed must add it to zones.internal.hostnames. When only localhost is configured, any hostname is accepted.

Back to table


zones.internal.hostnames

Default: [] (empty, defaults to localhost) Source: @ConfigurationProperties(prefix = "zones") in UaaProperties.Zones Type: Set<String>

A comprehensive list of hostnames that route to the UAA default zone. The UAA uses these to distinguish zone subdomains. If a request's hostname is not in this list and has extra subdomain levels, it is treated as a zone subdomain. A hostname that matches none of the configured root domains is not served, including for zone path requests (/z/{subdomain}/) since 2026-10-26.

zones:
  internal:
    hostnames:
      - uaa.example.com
      - login.example.com

Back to table


csp.script-src

Default: ['self'] Source: @ConfigurationProperties(prefix = "csp") in UaaProperties.Csp Type: List<String>

Content Security Policy script-src directive values. Controls which sources are allowed to execute JavaScript on UAA pages.

Back to table


logged_out.message

Default: You have successfully logged out. Source: @Value("${logged_out.message:You have successfully logged out.}") in LoggedOutEndpoint Type: String

Customizable message displayed on the logged out page after a user successfully logs out.

Back to table


logged_out.link_text

Default: Back to Sign In Source: @Value("${logged_out.link_text:Back to Sign In}") in LoggedOutEndpoint Type: String

Customizable text for the link displayed on the logged out page that takes users back to the login page.

Back to table


logged_out.link_url

Default: /login Source: @Value("${logged_out.link_url:/login}") in LoggedOutEndpoint Type: String

Customizable URL for the link displayed on the logged out page. Can be a relative path (e.g., /login) or an absolute URL (e.g., http://localhost:8080/uaa/login). Relative URLs are resolved against the UAA base URL.

Back to table


logging.file.name.path

Default: — (not set) Source: YAML config Type: String

Directory path for UAA log files (e.g. /tmp/uaa/logs).

Back to table


Configuration Precedence

Configuration values are resolved in the following order (later sources override earlier ones):

  1. uaa/src/main/resources/uaa.yml — Embedded defaults in the application JAR
  2. $CLOUDFOUNDRY_CONFIG_PATH/uaa.yml — External config file via Cloud Foundry config path
  3. $UAA_CONFIG_PATH/uaa.yml — External config file via UAA-specific config path
  4. $UAA_CONFIG_URL — Remote configuration URL
  5. System properties and environment variables — Standard Spring Boot property resolution

Active Profiles

The spring_profiles property activates Spring profiles that control database selection and optional features:

Profile Purpose
hsqldb In-memory HSQLDB database (default for development)
postgresql PostgreSQL database
mysql MySQL/MariaDB database
ldap Enable LDAP authentication
saml Enable SAML support

Multiple profiles can be combined: spring_profiles: postgresql,ldap