API Documentation

/credentials

Credential is the login data belonging to an employee. Credentials have the same id as the belonging employee.

Endpoints

MethodPath
GET/
GET/{id}
GET/search/findByEmail
POST/
PUT/{id}
DELETE/{id}

Projections

NameDescription
allRolesOverviewContains all authorities.

Structure

FieldnameFieldtypeValidations
idLong
emailStringvalid email address, unique
enabledboolean
localeStringnot empty
LinksSecurity
employeedeletable, updateable by ROLE_ADMIN
authoritiesdeletable, updateable by ROLE_ADMIN

GET /▲

Get all credentials.

Returns

A page of credentials.

Parameters

pageable

GET /{id}▲

Get a single credential by its id.

Returns

One credential.

GET /search/findByEmail▲

Find credentials by an email address.

Returns

A list of credentials.

Parameters

nametyperequireddescription
emailStringtrueThe email to search for.

POST /▲

Create a new credential. Returns the created object.

Security

ROLE_ADMIN

Returns

A single credential.

PUT /{id}▲

Update the credential identified by id. Returns the updated object.

Security

ROLE_ADMIN

Returns

A credential.

DELETE /{id}▲

Delete the credential identified by id.

Security

ROLE_ADMIN

Returns

Nothing