Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hong Kong Baptist University user API

The user API from Hong Kong Baptist University — 7 operation(s) for user.

Hong Kong Baptist University user API is one of 34 APIs that Hong Kong Baptist University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include user. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.

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

Requests are made against a single base URL, https://scholars.hkbu.edu.hk/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.35.0
Base URL
https://scholars.hkbu.edu.hk/ws/api/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Hong Kong Baptist University 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_1 3 params → 200
PUT
/users
Create user
user_create_1 body → 201400
GET
/users/orderings
Lists available orderings
user_getOrderings_1 → 200
GET
/users/{uuid}
Get user
user_get_1 1 param → 200301404
PUT
/users/{uuid}
Update user
user_update_1 1 param body → 200400404409
DELETE
/users/{uuid}
Delete user
user_delete_1 1 param → 204404409
POST
/users/{uuid}/actions/lock
Lock the content
user_lock_1 1 param → 204404409
POST
/users/{uuid}/actions/reset-password
Reset user password
user_resetPassword_1 2 params → 202400
POST
/users/{uuid}/actions/unlock
Unlock the content
user_unlock_1 1 param → 204404409
GET
/users/{uuid}/roles
Lists all roles of a user
user_get_roles_for_user_1 1 param → 200
PUT
/users/{uuid}/roles
Updates roles
user_update_roles_for_user_1 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.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hong-kong-baptist-university-user-api-openapi.yml Raw ↑

Other APIs Hong Kong Baptist University publishes across the network.

HKBU Mobile App Backend (gated)
Hong Kong Baptist University activity API
Hong Kong Baptist University application API
Hong Kong Baptist University authorCollaboration API
Hong Kong Baptist University award API
Hong Kong Baptist University classificationScheme API
Hong Kong Baptist University concept API
Hong Kong Baptist University course API
Hong Kong Baptist University dataSet API
Hong Kong Baptist University education API
Hong Kong Baptist University equipment API
Hong Kong Baptist University ethicalReview API