authentication-prod.yml

Owned by Technische Redaktion
Nov 12, 2021
3 min read

Parameters of the configuration file used by the AUTHENTICATION service in productive systems.

Characteristics

Configuration File Nameauthentication-prod.yml
Referenced by Servicesauthentication
Storage LocationGit root directory 

Parameters

ParameterDescriptionDefault Value
routing.defaultEntryPoint

Defines a path that will be added to the URL automatically if https://<host>/ is called.

'/client/index.html'
server.servlet.session.timeoutDefines the duration for which the session between gateway and client is authorized. Specified in seconds.1800
routing.endpoints

List of services for which the AUTHENTICATION service endpoints are available. Those services can be accessed via AUTHENTICATION service.

Also external services can be added here.
>> Accessing External Services via AUTHENTICATION Service

- 'authentication'
- 'api'
- 'search'
 - 'client'
- 'api-web'
- 'tenant-management'
- 'viewer'
- 'architect'
- 'custom'
- 'userservice'
- 'bpm-engine'

authorization.accesses

Definition of permissions for the access to individual endpoints and sub-paths.

Structured as a list of endpoints and their individual access conditions specified via the parameters endpoints, access, method and expose.

Any endpoint that should be accessible via AUTHENTICATION service has to be listed here.

Syntax and examples are described in the article on the AUTHENTICATION Service.

See code block below.



The values for the parameters can be modified as described here.
>> Configuring Services using Profiles.

Default Configuration for 'authorization.accesses:'
    ### manage-endpoints
      - endpoints: /manage/**
        expose: true
      - endpoints: /*/manage/**
        access: hasAuthority('YUUVIS_SYSTEM_INTEGRATOR')
    ### API-endpoints
      - endpoints: /api/system/**
        access: hasAuthority('YUUVIS_SYSTEM_INTEGRATOR')
      - endpoints: /api/admin/**
        access: hasAuthority('YUUVIS_TENANT_ADMIN')
      - endpoints: /api/dms/**
    ### endpoints for api swagger
      - endpoints: /api/swagger-ui.html/**,/api/**/springfox-swagger-ui/**,/api/**/swagger-resources/**,/api/**/v2/api-docs/**
      - endpoints: /api/swagger-ui/**,/api/swagger/v3/api-docs/**
      - endpoints: /api/api/system/**
        access: hasAuthority('YUUVIS_SYSTEM_INTEGRATOR')
      - endpoints: /api/api/admin/**
        access: hasAuthority('YUUVIS_TENANT_ADMIN')
      - endpoints: /api/api/dms/**
    ### Webclient
      - endpoints: /search/**,/viewer/**,/architect/**
      - endpoints: /client/**
        expose: true
      - endpoints: /custom/**
        expose: true
    ### api-web
      - endpoints: /api-web/swagger-ui.html/**,/api-web/**/springfox-swagger-ui/**,/api-web/**/swagger-resources/**,/api-web/**/v2/api-docs/**
      - endpoints: /api-web/api/resources/**,/api-web/api/users/**,/api-web/api/bpm/**,/api-web/api/dms/**
      - endpoints: /api-web/api/system/**
        access: hasAuthority('YUUVIS_SYSTEM_INTEGRATOR')
      - endpoints: /api-web/api/admin/**
        access: hasAuthority('YUUVIS_TENANT_ADMIN')
    ### tenant-management
      - endpoints: /tenant-management/swagger-ui.html/**,/tenant-management/**/springfox-swagger-ui/**,/tenant-management/**/swagger-resources/**,/tenant-management/**/v2/api-docs/**
      - endpoints: /tenant-management/api/system/**
        access: hasAuthority('YUUVIS_SYSTEM_INTEGRATOR')
      - endpoints: /tenant-management/api/admin/**
        access: hasAuthority('YUUVIS_TENANT_ADMIN')
    ### userservice
      - endpoints: /userservice/**
    ### bpm-engine
      - endpoints: /bpm-engine/swagger-ui.html,/bpm-engine/swagger-ui/**,/bpm-engine/v2/api-docs/**,/bpm-engine/v3/api-docs/**
      - endpoints: /bpm-engine/api/**
      - endpoints: /bpm-engine/internal/**
        access: hasAuthority('YUUVIS_SYSTEM_INTEGRATOR')