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 Auth API

The auth API from University of Sheffield — 6 operation(s) for auth.

University of Sheffield Auth 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 Authentication. 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 6 operations across 6 paths, and defines 9 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.

6 operations 6 paths 9 schemas 6 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 Auth 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 6

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

Auth 6
POST
/auth/forgot-password
Reset:Forgot Password
reset_forgot_password_auth_forgot_password_post body → 202422
POST
/auth/reset-password
Reset:Reset Password
reset_reset_password_auth_reset_password_post body → 200400422
POST
/auth/request-verify-token
Verify:Request-Token
verify_request_token_auth_request_verify_token_post body → 202422
POST
/auth/verify
Verify:Verify
verify_verify_auth_verify_post body → 200400422
POST
/auth/cookie/login
Auth:Cookie.Login
auth_cookie_login_auth_cookie_login_post body → 200400204422
POST
/auth/cookie/logout
Auth:Cookie.Logout
auth_cookie_logout_auth_cookie_logout_post → 200401204

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are UserRead (10 properties), Body_auth_cookie_login_auth_cookie_login_post (6 properties), ValidationError (5 properties), Body_reset_reset_password_auth_reset_password_post (2 properties). Each schema is shown below with its type and property counts.

Body_auth_cookie_login_auth_cookie_login_post
object
6 properties 2 required
ValidationError
object
5 properties 3 required
UserRead
object
Schema returned for user reads. Extends the base with SSF extras.
10 properties 2 required
Body_verify_request_token_auth_request_verify_token_post
object
1 property 1 required
HTTPValidationError
object
1 property
Body_reset_reset_password_auth_reset_password_post
object
2 properties 2 required
ErrorModel
object
1 property 1 required
Body_reset_forgot_password_auth_forgot_password_post
object
1 property 1 required
Body_verify_verify_auth_verify_post
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

university-of-sheffield-auth-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 Health API
University of Sheffield Metrics API
University of Sheffield Pvforecast API
University of Sheffield Pvlive API
University of Sheffield Pvlive Eu API
University of Sheffield User API
Where this information came from

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