Authentication and Session Module Configuration

This appendix includes configuration details for the authentication modules described in "Authentication and Session Modules".

Authentication modules, as configured in the authentication.json file, include a number of properties.

Session Module
Authentication PropertyProperty as Listed in the Admin UIDescription
keyAlias(not shown)Used by the Jetty Web server to service SSL requests.
maxTokenLifeMinutesMax Token Life (in seconds)Maximum time before a session is cancelled. Note the different units for the property and the UI.
tokenIdleTimeMinutesToken Idle Time (in seconds)Maximum time before an idle session is cancelled. Note the different units for the property and the UI.
sessionOnlySession OnlyWhether the session continues after browser restarts.

Static User Module
Authentication PropertyProperty as Listed in the Admin UIDescription
enabledModule EnabledDoes IDM use the module?
queryOnResourceQuery on ResourceEndpoint hard coded to user anonymous
usernameStatic User NameDefault for the static user, anonymous
passwordStatic User PasswordDefault for the static user, anonymous
defaultUserRolesStatic User RoleNormally set to openidm-reg for self-registration

The following table applies to several authentication modules:

  • Managed User

  • Internal User

  • Client Cert

  • Passthrough

  • IWA

The IWA module includes several Kerberos-related properties listed at the end of the table.

Common Module Properties
Authentication PropertyProperty as Listed in the Admin UIDescription
enabledModule EnabledDoes IDM use the module?
queryOnResourceQuery on ResourceEndpoint to query
queryIdUse Query IDA defined queryId searches against the queryOnResource endpoint. An undefined queryId against queryOnResource with action=reauthenticate
defaultUserRolesDefault User RolesNormally blank for managed users
authenticationIdAuthentication IDDefines how account credentials are derived from a queryOnResource endpoint
userCredentialUser CredentialDefines how account credentials are derived from a queryOnResource endpoint; if required, typically password or userPassword
userRolesUser RolesDefines how account roles are derived from a queryOnResource endpoint
groupMembershipGroup MembershipProvides more information for calculated roles
groupRoleMappingGroup Role MappingProvides more information for calculated roles
groupComparisonMethodGroup Comparison MethodProvides more information for calculated roles
managedUserLinkManaged User Link For pass-through authentication, this property specifies the mapping from the system resource to the IDM managed user. For example, if the user authenticates using their account in an LDAP directory, the managedUserLink might be systemLdapAccounts_managedUser
augmentSecurityContextAugment Security Context Includes a script that is executed only after a successful authentication request. For more information on this property, see "Authenticate as a Different User".
servicePrincipalKerberos Service Principal(IWA only) For more information, see "IWA"
keytabFileNameKeytab File Name(IWA only) For more information, see "IWA"
kerberosRealmKerberos Realm(IWA only) For more information, see "IWA"
kerberosServerNameKerberos Server Name(IWA only) For more information, see "IWA"

Read a different version of :