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 Sheffield User API

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

University of Sheffield User API is one of 14 APIs that University of Sheffield publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a status page, a support channel, a JSON-LD context, and 2 JSON Schemas.

This API exposes 12 operations across 7 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against the base URL https://api.solar.sheffield.ac.uk.

12 operations 7 paths 7 schemas 7 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.solar.sheffield.ac.uk
Authentication
OAuth 2.0, API Key, HTTP Basic
Resource Areas
1

Authentication & Security 3

University of Sheffield User API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2PasswordBearer) using the password flow. An API key is passed in the cookie as ssapi_session (APIKeyCookie). It accepts HTTP basic authentication (HTTPBasic).

Paths & Operations 12

Across 7 paths, the API surfaces 12 operations — 7 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

User 12
GET
/user/login
Get Login Form
get_login_form_user_login_get 1 param → 200422
POST
/user/login
Handle Login
handle_login_user_login_post body → 200422
POST
/user/register
Handle Registration
handle_registration_user_register_post body → 200422
GET
/user/register
Get Register Form
get_register_form_user_register_get 1 param → 200422
GET
/user/logout
Handle Logout
handle_logout_user_logout_get → 200
GET
/user/user
Pvforecast User
pvforecast_user_user_user_get → 200
GET
/user/forgot-password
Forgot Password Page
forgot_password_page_user_forgot_password_get 1 param → 200422
POST
/user/forgot-password
Handle Forgot Password
handle_forgot_password_user_forgot_password_post body → 200422
GET
/user/reset-password
Reset Password Page
reset_password_page_user_reset_password_get 1 param → 200422
POST
/user/reset-password
Handle Reset Password Submission
handle_reset_password_submission_user_reset_password_post body → 200422
GET
/user/verify
Verify Page
verify_page_user_verify_get 2 params → 200422
POST
/user/verify
Handle Verify
handle_verify_user_verify_post body → 200422

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Body_handle_registration_user_register_post (9 properties), Body_handle_login_user_login_post (8 properties), ValidationError (5 properties), Body_handle_reset_password_submission_user_reset_password_post (2 properties). Each schema is shown below with its type and property counts.

Body_handle_registration_user_register_post
object
9 properties 2 required
ValidationError
object
5 properties 3 required
Body_handle_verify_user_verify_post
object
1 property 1 required
HTTPValidationError
object
1 property
Body_handle_reset_password_submission_user_reset_password_post
object
2 properties 2 required
Body_handle_forgot_password_user_forgot_password_post
object
1 property 1 required
Body_handle_login_user_login_post
object
8 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs University of Sheffield publishes across the network.

University of Sheffield Shibboleth Identity Provider
ORDA — Online Research Data (figshare tenant)
White Rose Research Online OAI-PMH
White Rose eTheses Online OAI-PMH
University of Sheffield Admin API
University of Sheffield API Auth API
University of Sheffield Auth API
University of Sheffield Health API
University of Sheffield Metrics API
University of Sheffield Pvforecast API
University of Sheffield Pvlive API
University of Sheffield Pvlive Eu API
Where this information came from

This is an independent, third-party profile of University of Sheffield 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.