Azure Active Directory

For an overview of the delegated authentication flow, please see this guide.

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

The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.

  • cas.authn.pac4j.oidc[0].azure.discovery-uri=
  • The discovery endpoint to locate the provide metadata.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.id=
  • The client id.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.secret=
  • The client secret.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

    The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value. You should only include this field in your configuration if you need to modify the default value.

  • cas.authn.pac4j.oidc[0].azure.allow-unsigned-id-tokens=
  • Whether unsigned id tokens issued as plain JWTs are accepted.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.auto-redirect-type=NONE
  • Auto-redirect to this client.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.callback-url=
  • Callback URL to use to return the flow back to the CAS server one the identity provider is successfully done. This may be used at the discretion of the client and its type to build service parameters, redirect URIs, etc. If none is specified, the CAS server's login endpoint will be used as the basis of the final callback url.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.callback-url-type=QUERY_PARAMETER
  • Determine how the callback url should be resolved. Default is CallbackUrlTypes#QUERY_PARAMETER. Available values are as follows:

    • PATH_PARAMETER: Path parameter callback url. The client name is added to the path of the callback URL.
    • QUERY_PARAMETER: Query parameter callback url. The client name is added to the path of a query parameter.
    • NONE: No callback url. No name is added to the callback URL to be able to distinguish the client.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.client-name=
  • Name of the client mostly for UI purposes and uniqueness. This name, with 'non-word' characters converted to '-' (e.g. "This Org (New)" becomes "This-Org--New-") is added to the "class" attribute of the redirect link on the login page, to allow for custom styling of individual IdPs (e.g. for an organization logo).

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.connect-timeout=PT5S
  • Read timeout of the OIDC client.

    This settings supports the java.time.Duration syntax [?].

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.css-class=
  • CSS class that should be assigned to this client.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.custom-params=
  • Custom parameters to send along in authZ requests, etc.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.disable-pkce=
  • Disable PKCE support for the provider.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.display-name=
  • Indicate the title or display name of the client for decoration and client presentation purposes. If left blank, the client original name would be used by default.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.enabled=true
  • Whether the client/external identity provider should be considered active and enabled for integration purposes.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.expire-session-with-token=
  • Checks if sessions expire with token expiration.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.include-access-token-claims=
  • If enabled, try to process the access token as a JWT and include its claims in the profile. Only enable this if there is an agreement between the IdP and CAS about the format of the access token. If not, the token format could change at any time.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.logout-url=
  • Logout url used for this provider.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?

  • cas.authn.pac4j.oidc[0].azure.mapped-claims=
  • List arbitrary mappings of claims when fetching user profiles. Uses a "directed list" where the allowed syntax would be claim->attribute.

    org.apereo.cas.configuration.model.support.pac4j.oidc.Pac4jAzureOidcClientProperties.

    How can I configure this property?