http://github.com/org/folio/mod-auth/login_module
This module provides a username/password based login mechanism for FOLIO credentials
Get login attempts for a single user
GET /authn/loginAttempts/{id}Get a new login token
POST /authn/loginMedia type: application/json
Type: json
Content:
{
"title": "Login Credentials Schema",
"type": "object",
"description": "An entity that describes the basic credentials for a user to log on to the system",
"properties": {
"username": {
"description": "Username in the system",
"type": "string"
},
"userId": {
"description": "Unique user id",
"type": "string"
},
"password": {
"description": "User password",
"type": "string"
}
}
}
Media type: application/json
Type: json
Content:
{
"title": "Login Credentials Schema",
"type": "object",
"description": "An entity that describes the basic credentials for a user to log on to the system",
"properties": {
"username": {
"description": "Username in the system",
"type": "string"
},
"userId": {
"description": "Unique user id",
"type": "string"
},
"password": {
"description": "User password",
"type": "string"
}
}
}
Bad request
Media type: text/plain
Type: any
Example:
Bad requestUnprocessable Entity
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Internal server error
Media type: text/plain
Type: any
Example:
Internal server errorSelf-update existing credentials
POST /authn/updateMedia type: application/json
Type: json
Content:
{
"title": "Update Credentials Schema",
"type": "object",
"description": "An entity that describes the necessary data to update a user password",
"properties": {
"username": {
"description": "username",
"type": "string"
},
"userId": {
"description": "Unique user id",
"type": "string"
},
"password": {
"description": "The current password of the user who will be replaced by the new one",
"type": "string"
},
"newPassword" : {
"description": "New user password",
"type": "string"
}
}
}
Successful update
Bad request
Media type: text/plain
Type: any
Example:
Bad requestUnauthorized
Media type: text/plain
Type: any
Example:
UnauthorizedUnprocessable Entity
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Internal server error
Media type: text/plain
Type: any
Example:
Internal server errorGet a list of user credentials
GET /authn/credentialsThe maximum number of results to return.
Example:
10The starting index in a list of results (starts at one).
A comma-separated list of fieldnames to sort by
A query string to filter users based on matching criteria in fields.
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Credentials List Object",
"type": "object",
"description": "Response entity describing a list of user data, as well as their number in db",
"properties": {
"credentials": {
"type": "array",
"description": "List of user credentials",
"id": "credentialsListObject",
"items": {
"type": "object",
"$ref": "credentials.json"
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"credentials",
"totalRecords"
]
}
Bad request
Media type: text/plain
Type: any
Example:
Bad requestInternal server error
Media type: text/plain
Type: any
Example:
Internal server errorAdd a new login to the system
POST /authn/credentialsMedia type: application/json
Type: json
Content:
{
"title": "Login Credentials Schema",
"type": "object",
"description": "An entity that describes the basic credentials for a user to log on to the system",
"properties": {
"username": {
"description": "Username in the system",
"type": "string"
},
"userId": {
"description": "Unique user id",
"type": "string"
},
"password": {
"description": "User password",
"type": "string"
}
}
}
Media type: application/json
Type: json
Content:
{
"title": "Credentials Schema",
"type": "object",
"description": "An entity that describes the basic user login data",
"properties": {
"id": {
"description": "Unique credentials id",
"type": "string"
},
"userId": {
"description": "Unique user id",
"type": "string"
},
"hash": {
"description": "The generated hash that participates in decoding the password",
"type": "string"
},
"salt": {
"description": "The generated salt that is involved in decrypting the password",
"type": "string"
},
"metadata": {
"type": "object",
"$ref": "raml-util/schemas/metadata.schema"
}
}
}
Bad request
Media type: text/plain
Type: any
Example:
Bad requestValidation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error
Media type: text/plain
Type: any
Example:
Internal server errorGet login credentials for a single user
GET /authn/credentials/{id}Media type: application/json
Type: json
Content:
{
"title": "Credentials Schema",
"type": "object",
"description": "An entity that describes the basic user login data",
"properties": {
"id": {
"description": "Unique credentials id",
"type": "string"
},
"userId": {
"description": "Unique user id",
"type": "string"
},
"hash": {
"description": "The generated hash that participates in decoding the password",
"type": "string"
},
"salt": {
"description": "The generated salt that is involved in decrypting the password",
"type": "string"
},
"metadata": {
"type": "object",
"$ref": "raml-util/schemas/metadata.schema"
}
}
}
User not found
Media type: text/plain
Type: any
Example:
User not foundInternal server error
Media type: text/plain
Type: any
Example:
Internal server errorModify a user's login credentials
PUT /authn/credentials/{id}Media type: application/json
Type: json
Content:
{
"title": "Login Credentials Schema",
"type": "object",
"description": "An entity that describes the basic credentials for a user to log on to the system",
"properties": {
"username": {
"description": "Username in the system",
"type": "string"
},
"userId": {
"description": "Unique user id",
"type": "string"
},
"password": {
"description": "User password",
"type": "string"
}
}
}
Media type: application/json
Type: json
Content:
{
"title": "Login Credentials Schema",
"type": "object",
"description": "An entity that describes the basic credentials for a user to log on to the system",
"properties": {
"username": {
"description": "Username in the system",
"type": "string"
},
"userId": {
"description": "Unique user id",
"type": "string"
},
"password": {
"description": "User password",
"type": "string"
}
}
}
User not found
Media type: text/plain
Type: any
Example:
User not foundInternal server error
Media type: text/plain
Type: any
Example:
Internal server errorRemove a user's login credentials from the system
DELETE /authn/credentials/{id}Validate password for repeatability
POST /authn/password/repeatableMedia type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Object with password property",
"type": "object",
"properties": {
"password": {
"type": "string",
"description": "Password"
}
},
"required": [
"password"
]
}
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "result",
"type": "object",
"properties": {
"result": {
"type": "string",
"description": "result"
}
},
"required": [
"result"
]
}
Internal server error
Media type: text/plain
Type: any
Example:
Internal server errorResets password for user in record and deletes action record
POST /authn/reset-passwordMedia type: application/json
Saves action to storage
POST /authn/password-reset-actionRetrieves action record by id
GET /authn/password-reset-action/{actionId}Returns a list of events retrieved from storage
GET /authn/log/eventsThe maximum number of results to return.
Example:
10The starting index in a list of results (starts at one).
A query string to filter users based on matching criteria in fields.
Saves received event into the storage
POST /authn/log/eventsRemoves events by filter
DELETE /authn/log/events/{id}Returns single property 'credentialsExist' with true, if user has local password
GET /authn/credentials-existence