Authentication Component
The Scava Authentication service:
- Provides a centralized mechanisms to securize Scava's components and manage authentication for all services of the platform.
- Provides user management services, including user registration process, user profile editing and roles based authorization management.
Authentication API
The Authentication server is a component of The Scava platform which manages the authentication for all services accessible behind the API Gateway.
Authenticate User | POST | /api/authentication |
Login as a registered user. |
Register User | POST | /api/register |
Register new user. |
Activate User | GET | /api/activate |
Activate the registered user. |
Update User | PUT | /api/users |
Update an existing user. |
Retrieve Users | GET | /api/users |
Get all registered users. |
Retrieve Login User | GET | /api/users/{login} |
Get the "login" user. |
Delete User | DELETE | /api/users/{login} |
Delete the "login" user. |
Authentication Server Configuration
The Authentication server parametrize inside an external property file (application.properties) placed in the same execution directory of the Authentication component.
Server Configuration
id : server.port | default : 8085 | |
Port of the Authentication API server. Each REST request sent to the gateway must be adressed to this port. |
JWT Security Configuration
id : apigateway.security.jwt.secret | default : NA | |
Private key pair which allow to sign jwt tokens using RSA. |
Default ADMIN configuration
Property | Description | Default Value |
---|---|---|
scava.administration.username | The administrator username | admin |
scava.administration.password | The administrator password | admin |
scava.administration.admin-role | The admin role | ADMIN |
scava.administration.project-manager-role | The project manager role | PROJECT_MANAGER |
scava.administration.project-user-role | The user role | USER |
Mongodb Database Configuration
Property | Description | Default Value |
---|---|---|
spring.data.mongodb.uri | Url of the MongoDB database server | mongodb://localhost:27017 |
spring.data.mongodb.database | Name of the MongoDB database | scava |
Mail Server configuration
In order to register new users, you have to configure a mail server.
Property | Description | Default Value |
---|---|---|
spring.mail.host | Url of the mail service | smtp.gmail.com |
spring.mail.port | Port of the mail service | 587 |
spring.mail.username | Login of the mail account | |
spring.mail.password | Password of the mail account | |
spring.mail.protocol | mail protocole | smtp |
spring.mail.tls | - | true |
spring.mail.properties.mail.smtp.auth | - | true |
spring.mail.properties.mail.smtp.starttls.enable | - | true |
spring.mail.properties.mail.smtp.ssl.trust= | - | smtp.gmail.com |
Administration Dashboard Setting
id : scava.administration.base-url | default : http://localhost:4200 | |
The SCAVA administration base URL to generate the activation account URL. |
Packaging From Sources
Maven Packaging
mvn -Pprod install
Authentication Server Execution
- complete an put the "application.properties" configuration file in the execution directory.
- Execute the scava-auth-service-1.0.0.jar Jar.
java -jar scava-auth-service-1.0.0.jar