How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

University of Bath user API

The user API from University of Bath — 7 operation(s) for user.

University of Bath user API is one of 26 APIs that University of Bath publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 11 operations across 7 paths, and defines 13 schemas. It is described by OpenAPI 3.0.1, at version 5.33.3-3.

Requests are made against a single base URL, /ws/api.

11 operations 7 paths 13 schemas 1 DELETE4 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5.33.3-3
Base URL
https://purehost.bath.ac.uk/ws/oai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

University of Bath user API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (api-key). By default, every request must be authenticated.

  • api-key — Security mechanism for the API

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 1 DELETE, 4 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

user 11
GET
/users
Lists all users
user_list 3 params → 200
PUT
/users
Create user
user_create body → 201400
GET
/users/orderings
Lists available orderings
user_getOrderings → 200
GET
/users/{uuid}
Get user
user_get 1 param → 200301404
PUT
/users/{uuid}
Update user
user_update 1 param body → 200400404409
DELETE
/users/{uuid}
Delete user
user_delete 1 param → 204404409
POST
/users/{uuid}/actions/lock
Lock the content
user_lock 1 param → 204404409
POST
/users/{uuid}/actions/reset-password
Reset user password
user_resetPassword 2 params → 202400
POST
/users/{uuid}/actions/unlock
Unlock the content
user_unlock 1 param → 204404409
GET
/users/{uuid}/roles
Lists all roles of a user
user_get_roles_for_user 1 param → 200
PUT
/users/{uuid}/roles
Updates roles
user_update_roles_for_user 1 param body → 200400403404409

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are User (18 properties), ConflictProblemDetails (7 properties), ProblemDetails (5 properties), UserRoles (3 properties). Each schema is shown below with its type and property counts.

Name
object
A name describing a person, made up of given- and family name
2 properties
ProblemDetails
object
RFC7807 Error details
5 properties
GlobalRoleAssignment
object
Assignment of a global role
1 property 1 required
ContentRef
object
2 properties 2 required
PageInformation
object
Information about pages
2 properties
Identifier
object
1 property 1 required
UserRoles
object
The complete picture of a users roles
3 properties 3 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
User
object
A user that can be attached to a person in Pure
18 properties 2 required
OrderingsList
object
List of available orderings
1 property
LocalRoleAssignment
object
The complete picture of where a local role is to be assigned
2 properties 1 required
AssignableRoleRef
object
A reference to an assignable role that can be either local or global
1 property 1 required
UserListResult
object
List of users. Can contain a subset of all items along with the full count
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

university-of-bath-user-api-openapi.yml Raw ↑

Other APIs University of Bath publishes across the network.

Research Portal (Pure) OAI-PMH
Research Data Archive OAI-PMH
Research Data Archive REST/Feeds
Library Discovery (Ex Libris Primo)
Azure API Management Developer Portal (non-production)
University of Bath activity API
University of Bath application API
University of Bath authorCollaboration API
University of Bath award API
University of Bath classificationScheme API
University of Bath dataSet API
University of Bath equipment API
Where this information came from

This is an independent, third-party profile of University of Bath user API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.