University of Sheffield

University of Sheffield Admin API

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

Documentation GitHub OpenAPI

Operations 7

GET /admin/admin_page/{sort_col}/{direction} Admin Page #

GET /admin/admin_page/ Admin Page #

GET /admin/admin_form/{user_id} Admin User Form #

POST /admin/admin_page/region/{user_id} Submit Region #

POST /admin/admin_page/token/{user_id} Submit Token #

POST /admin/admin_page/token_gen/{user_id} Submit Token Gen #

POST /admin/admin_page/user/{user_id} Submit User #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/university-of-sheffield:university-of-sheffield-admin-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Sheffield Solar Admin API
  version: 0.1.0
tags:
- name: Admin
paths:
  /admin/admin_page/{sort_col}/{direction}:
    get:
      tags:
      - Admin
      summary: Admin Page
      description: 'Render the admin user list page, sorted by the specified column.

        Admin — requires superuser.


        Raises HTTP 400 if sort_col is not in the allowed whitelist (prevents SQL injection).

        Requires superuser privileges.'
      operationId: admin_page_admin_admin_page__sort_col___direction__get
      security:
      - OAuth2PasswordBearer: []
      - APIKeyCookie: []
      parameters:
      - name: sort_col
        in: path
        required: true
        schema:
          type: string
          title: Sort Col
      - name: direction
        in: path
        required: true
        schema:
          type: string
          title: Direction
      responses:
        '200':
          description: Successful Response
          content:
            text/html:
              schema:
                type: string
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/admin_page/:
    get:
      tags:
      - Admin
      summary: Admin Page
      description: 'Render the admin user list page, sorted by the specified column.

        Admin — requires superuser.


        Raises HTTP 400 if sort_col is not in the allowed whitelist (prevents SQL injection).

        Requires superuser privileges.'
      operationId: admin_page_admin_admin_page__get
      security:
      - OAuth2PasswordBearer: []
      - APIKeyCookie: []
      parameters:
      - name: sort_col
        in: query
        required: false
        schema:
          type: string
          default: id
          title: Sort Col
      - name: direction
        in: query
        required: false
        schema:
          type: string
          default: asc
          title: Direction
      responses:
        '200':
          description: Successful Response
          content:
            text/html:
              schema:
                type: string
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/admin_form/{user_id}:
    get:
      tags:
      - Admin
      summary: Admin User Form
      description: Show the admin user edit form (GET).
      operationId: admin_user_form_admin_admin_form__user_id__get
      security:
      - OAuth2PasswordBearer: []
      - APIKeyCookie: []
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: integer
          title: User Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/admin_page/region/{user_id}:
    post:
      tags:
      - Admin
      summary: Submit Region
      description: Replace all region assignments for a user (POST).
      operationId: submit_region_admin_admin_page_region__user_id__post
      security:
      - OAuth2PasswordBearer: []
      - APIKeyCookie: []
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: integer
          title: User Id
      responses:
        '200':
          description: Successful Response
          content:
            text/html:
              schema:
                type: string
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/admin_page/token/{user_id}:
    post:
      tags:
      - Admin
      summary: Submit Token
      description: Update token fields for a user (POST).
      operationId: submit_token_admin_admin_page_token__user_id__post
      security:
      - OAuth2PasswordBearer: []
      - APIKeyCookie: []
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: integer
          title: User Id
      responses:
        '200':
          description: Successful Response
          content:
            text/html:
              schema:
                type: string
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/admin_page/token_gen/{user_id}:
    post:
      tags:
      - Admin
      summary: Submit Token Gen
      description: Regenerate or freshly create the API key for a user (POST).
      operationId: submit_token_gen_admin_admin_page_token_gen__user_id__post
      security:
      - OAuth2PasswordBearer: []
      - APIKeyCookie: []
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: integer
          title: User Id
      responses:
        '200':
          description: Successful Response
          content:
            text/html:
              schema:
                type: string
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/admin_page/user/{user_id}:
    post:
      tags:
      - Admin
      summary: Submit User
      description: Update profile fields for a user (POST).
      operationId: submit_user_admin_admin_page_user__user_id__post
      security:
      - OAuth2PasswordBearer: []
      - APIKeyCookie: []
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: integer
          title: User Id
      responses:
        '200':
          description: Successful Response
          content:
            text/html:
              schema:
                type: string
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /auth/jwt/login
    APIKeyCookie:
      type: apiKey
      in: cookie
      name: ssapi_session
    HTTPBasic:
      type: http
      scheme: basic
x-provenance:
  method: harvested
  publisher: University of Sheffield
  source: https://api.solar.sheffield.ac.uk/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)

University of Sheffield Admin API

Operations 7

Documentation

Specifications

Schemas & Data

Other Resources