Mod-Users BL API documentation

/bl-users

/bl-users get

get

Get a number of user (and possibly related) records based on criteria in the user and related modules

Request
Response

Query Parameters

include: (string - repeat: true)
indicates which referenced fields should be populated (de-referenced) by the service
offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response
Example:
```
10
```
query: (string)
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
```

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "compositeUsers": {
      "type": "array",
      "id": "compositeUserList",
      "items": {
        "type": "object",
        "$ref": "compositeUser.json"
      }
    },
    "totalResults": {
      "type": "integer"
    },
    "recordCount": {
      "type": "integer"
    }
  },
  "required": [
    "compositeUsers",
    "totalResults",
    "recordCount"
  ]
}

HTTP status code 400

Bad request

Body

Type: text/plain

Example:

Bad request

HTTP status code 403

Access denied

Body

Type: text/plain

Example:

Access denied

HTTP status code 500

Internal server error

Body

Type: text/plain

Example:

Internal server error

/bl-users/by-id/{id} get

get

Get a user by id

Request
Response

URI Parameters

id: required (string)

Query Parameters

include: (string - repeat: true)
indicates which referenced fields should be populated (de-referenced) by the service
expandPermissions: (boolean)
Whether or not to expand permissions listings

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "$ref": "mod-users/userdata.json"
    },
    "patronGroup": {
      "type": "object",
      "$ref": "mod-users/usergroup.json"
    },
    "permissions": {
      "type": "object",
      "$ref": "mod-permissions/permissionUser.json"
    },
    "credentials": {
      "type": "object",
      "$ref": "mod-login/credentials.json"
    },
    "proxiesFor": {
      "type": "array",
      "id": "proxyFor",
      "items": {
        "type": "object",
        "$ref": "mod-users/proxyfor.json"
      }
    }
  }
}

HTTP status code 400

Bad request

Body

Type: text/plain

Example:

Bad request

HTTP status code 403

Access denied

Body

Type: text/plain

Example:

Access denied

HTTP status code 404

User not found

Body

Type: text/plain

Example:

User not found

HTTP status code 500

Internal server error

Body

Type: text/plain

Example:

Internal server error

/bl-users/by-username/{username} get

get

Get a user by username

Request
Response

URI Parameters

username: required (string)

Query Parameters

include: (string - repeat: true)
indicates which referenced fields should be populated (de-referenced) by the service
expandPermissions: (boolean)
Whether or not to expand permissions listings

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "$ref": "mod-users/userdata.json"
    },
    "patronGroup": {
      "type": "object",
      "$ref": "mod-users/usergroup.json"
    },
    "permissions": {
      "type": "object",
      "$ref": "mod-permissions/permissionUser.json"
    },
    "credentials": {
      "type": "object",
      "$ref": "mod-login/credentials.json"
    },
    "proxiesFor": {
      "type": "array",
      "id": "proxyFor",
      "items": {
        "type": "object",
        "$ref": "mod-users/proxyfor.json"
      }
    }
  }
}

HTTP status code 400

Bad request

Body

Type: text/plain

Example:

Bad request

HTTP status code 403

Access denied

Body

Type: text/plain

Example:

Access denied

HTTP status code 404

User not found

Body

Type: text/plain

Example:

User not found

HTTP status code 500

Internal server error

Body

Type: text/plain

Example:

Internal server error

/bl-users/_self get

get

Get a user by self reference

Request
Response

Query Parameters

expandPermissions: (boolean)
Whether or not to expand permissions listings
include: (string - repeat: true)
indicates which referenced fields should be populated (de-referenced) by the service

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "$ref": "mod-users/userdata.json"
    },
    "patronGroup": {
      "type": "object",
      "$ref": "mod-users/usergroup.json"
    },
    "permissions": {
      "type": "object",
      "$ref": "mod-permissions/permissionUser.json"
    },
    "credentials": {
      "type": "object",
      "$ref": "mod-login/credentials.json"
    },
    "proxiesFor": {
      "type": "array",
      "id": "proxyFor",
      "items": {
        "type": "object",
        "$ref": "mod-users/proxyfor.json"
      }
    }
  }
}

HTTP status code 400

Bad request

Body

Type: text/plain

Example:

Bad request

HTTP status code 403

Access denied

Body

Type: text/plain

Example:

Access denied

HTTP status code 404

User not found

Body

Type: text/plain

Example:

User not found

HTTP status code 500

Internal server error

Body

Type: text/plain

Example:

Internal server error

/bl-users/login post

post

Allow a new user to login and return an authtoken, along with a composite user record

Request
Response

Query Parameters

include: (string - repeat: true)
indicates which referenced fields should be populated (de-referenced) by the service
expandPermissions: (boolean)
Whether or not to expand permissions listings

Body

Type: application/json

Schema:

{
  "title": "Login Credentials Schema",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "userId": {
      "type": "string"
    },
    "password": {
      "type": "string"
    }
  }
}

HTTP status code 201

Headers

x-okapi-token: (string)

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "$ref": "mod-users/userdata.json"
    },
    "patronGroup": {
      "type": "object",
      "$ref": "mod-users/usergroup.json"
    },
    "permissions": {
      "type": "object",
      "$ref": "mod-permissions/permissionUser.json"
    },
    "credentials": {
      "type": "object",
      "$ref": "mod-login/credentials.json"
    },
    "proxiesFor": {
      "type": "array",
      "id": "proxyFor",
      "items": {
        "type": "object",
        "$ref": "mod-users/proxyfor.json"
      }
    }
  }
}

HTTP status code 400

Bad request

Body

Type: text/plain

Example:

Bad request

HTTP status code 500

Internal server error

Body

Type: text/plain

Example:

Internal server error

/bl-users/forgotten/password post

post

called when a user has forgotten a password

Request
Response

Query Parameters

include: (string - repeat: true)
indicates which referenced fields should be populated (de-referenced) by the service
expandPermissions: (boolean)
Whether or not to expand permissions listings

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 204

HTTP status code 400

Bad request

Body

Type: text/plain

Example:

Bad request

HTTP status code 500

Internal server error

Body

Type: text/plain

Example:

Internal server error

/bl-users/forgotten/username post

post

called when a user has forgotten a username

Request
Response

Query Parameters

include: (string - repeat: true)
indicates which referenced fields should be populated (de-referenced) by the service
expandPermissions: (boolean)
Whether or not to expand permissions listings

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 204

HTTP status code 400

Bad request

Body

Type: text/plain

Example:

Bad request

HTTP status code 500

Internal server error

Body

Type: text/plain

Example:

Internal server error

Mod-Users BL API documentation

/bl-users

get /bl-users

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 403

Body

HTTP status code 500

Body

get /bl-users/by-id/{id}

URI Parameters

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 403

Body

HTTP status code 404

Body

HTTP status code 500

Body

get /bl-users/by-username/{username}

URI Parameters

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 403

Body

HTTP status code 404

Body

HTTP status code 500

Body

get /bl-users/_self

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 403

Body

HTTP status code 404

Body

HTTP status code 500

Body

post /bl-users/login

Query Parameters

Body

HTTP status code 201

Headers

Body

HTTP status code 400

Body

HTTP status code 500

Body

post /bl-users/forgotten/password

Query Parameters

Body

HTTP status code 204

HTTP status code 400

Body

HTTP status code 500

Body

post /bl-users/forgotten/username

Query Parameters

Body

HTTP status code 204

HTTP status code 400

Body

HTTP status code 500

Body