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

The users API from University of Sheffield — 2 operation(s) for users.

University of Sheffield Users 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 5 operations across 2 paths, and defines 5 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.

5 operations 2 paths 5 schemas 1 DELETE2 GET2 PATCH

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 Users 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 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 PATCH. Each is listed below with its method, path, parameters, and response codes.

Users 5
GET
/users/me
Users:Current User
users_current_user_users_me_get → 200401
PATCH
/users/me
Users:Patch Current User
users_patch_current_user_users_me_patch body → 200401400422
GET
/users/{id}
Users:User
users_user_users__id__get 1 param → 200401403404422
PATCH
/users/{id}
Users:Patch User
users_patch_user_users__id__patch 1 param body → 200401403404400422
DELETE
/users/{id}
Users:Delete User
users_delete_user_users__id__delete 1 param → 204401403404422

Schemas 5

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

ValidationError
object
5 properties 3 required
UserRead
object
Schema returned for user reads. Extends the base with SSF extras.
10 properties 2 required
HTTPValidationError
object
1 property
ErrorModel
object
1 property 1 required
UserUpdate
object
Schema for user self-updates (PATCH /users/me).
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

university-of-sheffield-users-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 Users 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.