A front end for mod-users and mod-permissions
A front end for mod-users and mod-permissions
Get a number of user (and possibly related) records based on criteria in the user and related modules
indicates which referenced fields should be populated (de-referenced) by the service
2147483647
Skip over a number of elements by specifying an offset value for the query
10
Maximum:
2147483647
Limit the number of elements returned in the response
Example:10
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
Example:(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
active=true
Bad request
Bad request
Access denied
Access denied
Internal server error
Internal server error
Get a user by self reference
Whether or not to expand permissions listings
indicates which referenced fields should be populated (de-referenced) by the service
Bad request
Bad request
Access denied
Access denied
User not found
User not found
Internal server error
Internal server error
Get a user by id
indicates which referenced fields should be populated (de-referenced) by the service
Whether or not to expand permissions listings
Bad request
Bad request
Access denied
Access denied
User not found
User not found
Internal server error
Internal server error
Get a user by username
indicates which referenced fields should be populated (de-referenced) by the service
Whether or not to expand permissions listings
Bad request
Bad request
Access denied
Access denied
User not found
User not found
Internal server error
Internal server error
called when a user has forgotten a password
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
Bad request
Bad request
Internal server error
Internal server error
called when a user has forgotten a username
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
Bad request
Bad request
Internal server error
Internal server error
Allow a new user to login and return an authtoken, along with a composite user record
indicates which referenced fields should be populated (de-referenced) by the service
Whether or not to expand permissions listings
{
"title": "Login Credentials Schema",
"type": "object",
"properties": {
"username": {
"type": "string"
},
"userId": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
Bad request
Bad request
Internal server error
Internal server error
Allow change password for user
{
"title": "Update Credentials Schema",
"type": "object",
"properties": {
"username": {
"type": "string"
},
"userId": {
"type": "string"
},
"password": {
"type": "string"
},
"newPassword" : {
"type": "string"
}
}
}
Successful update
Bad request
Unauthorized
Unauthorized
Internal server error
Internal server error