City University of Hong Kong

aid: cityu
name: City University of Hong Kong
x-type: university
x-category: Public Research University
description: 'City University of Hong Kong (CityUHK) is a publicly funded (UGC) research university in Kowloon, Hong Kong
  SAR. IT Services runs a real API programme — a gateway and API management practice on MuleSoft Anypoint connecting campus
  systems — but none of it is published or callable outside the university, and there is no public developer portal. The publicly
  reachable machine-readable footprint is small and, with one exception, TENANTED rather than built: CityUHK Scholars is an
  Elsevier Pure deployment (scholars.cityu.edu.hk CNAMEs to cityu.elsevierpure.com) with an open OAI-PMH endpoint and a gated
  REST service on Elsevier''s contract; Canvas is an Instructure tenant; single sign-on is an Okta tenant at auth.cityu.edu.hk.
  The exception is the one contract CityUHK operates itself: its Shibboleth Identity Provider at idp2.cityu.edu.hk, registered
  in eduGAIN via the Hong Kong Access Federation. The official GitHub organisation publishes zero public repositories.'
type: Index
deliveryModel:
  model: saas
  open_source: false
  commercial: false
  callable_host: true
  label: Hosted service · one open endpoint, the rest gated
  confidence: medium
  source:
  - authentication
  - conformance
  generated: '2026-08-30'
  method: probed
accessModel:
  pricing: free
  onboarding: institutional
  trial: false
  try_now: true
  public: false
  label: Free · Institutional affiliation required for everything but OAI-PMH
  confidence: high
  source:
  - authentication
  - conformance
  generated: '2026-08-30'
  method: probed
position: Consuming
access: 3rd-Party
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/cityu.png
url: https://raw.githubusercontent.com/api-evangelist/cityu/refs/heads/main/apis.yml
tags:
- Education
- Higher Education
- University
- Hong Kong
- China
- Research
- Institutional Repository
- OAI-PMH
- Identity Federation
- Research Data
- Learning Management
created: '2026-06-03'
modified: '2026-08-30'
specificationVersion: '0.23'
x-enrichment:
  pipeline: pipeline-university
  run: '2026-08-30'
  note: Re-profiled under the university pipeline's operator-attribution rule. The 34 OpenAPI definitions this repository
    carried were Elsevier's generic Pure API contract (info.title "Pure … API", info.contact pure-support@elsevier.com, servers
    ["/ws/api"]) shipped by at least nine other institutions in the cohort, together with 84 collections, schemas, examples,
    rules, vocabularies and agentic-access files derived from them. All 118 were removed and the Pure deployment is now recorded
    once, as a tenant relationship.
apis:
- aid: cityu:scholars-oai
  name: CityUHK Scholars OAI-PMH
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/cityu.png
  x-operator: tenant
  description: Public OAI-PMH 2.0 endpoint for CityUHK Scholars, the university's research information system and institutional
    repository. The Identify verb returns repositoryName "CityUHK Scholars" with records from 2016-12-19 onward, and ListSets
    exposes persons, publications, student theses, datasets and an OpenAIRE set. No authentication required. The data and
    the repository are CityUHK's; the software is Elsevier Pure and the host resolves to cityu.elsevierpure.com, so the operator
    is recorded as tenant. OAI-PMH itself is an Open Archives Initiative standard, not a vendor contract.
  humanURL: https://scholars.cityu.edu.hk/
  baseURL: https://scholars.cityu.edu.hk/ws/oai
  tags:
  - Research
  - Institutional Repository
  - OAI-PMH
  - Metadata
  - Open Access
  properties:
  - type: Documentation
    url: https://scholars.cityu.edu.hk/
  - type: x-conformance
    url: conformance/cityu-education-standards-conformance.yml
- aid: cityu:scholars-pure-ws
  name: CityUHK Scholars Pure Web Service (tenant deployment)
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/cityu.png
  x-operator: tenant
  description: CityUHK's deployment of the Elsevier Pure REST web service, reachable at https://scholars.cityu.edu.hk/ws/api
    and gated by an api-key header. The deployment is CityUHK's; the contract is Elsevier's Pure API 5.35.1-2, a generic product
    specification shipped identically by many Pure customers, and it is deliberately NOT stored in this repository. Score
    the contract against Elsevier, and this entry as the institution's tenancy of it.
  humanURL: https://scholars.cityu.edu.hk/
  baseURL: https://scholars.cityu.edu.hk/ws/api
  tags:
  - Research
  - Institutional Repository
  - CRIS
  - Pure
  - Gated
  properties:
  - type: Documentation
    url: https://scholars.cityu.edu.hk/
  - type: x-vendor
    url: https://www.elsevier.com/products/pure
  - type: x-vendor-contract
    url: https://scholars.cityu.edu.hk/ws/api/openapi.yaml
- aid: cityu:shibboleth-idp
  name: CityUHK Shibboleth Identity Provider
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/cityu.png
  x-operator: institution
  description: CityUHK's own SAML 2.0 Identity Provider, running Shibboleth on the university's own host and publishing live
    IdP metadata with both an IDPSSODescriptor and an AttributeAuthorityDescriptor. Registered in eduGAIN via the Hong Kong
    Access Federation (HKAF, registration authority https://hkaf.edu.hk) under the display name "City University of Hong Kong".
    This is the one machine-readable contract in this profile that CityUHK operates itself rather than tenants.
  humanURL: https://idp2.cityu.edu.hk/idp/shibboleth
  baseURL: https://idp2.cityu.edu.hk/idp
  tags:
  - Identity Federation
  - SAML
  - Shibboleth
  - eduGAIN
  - Single Sign-On
  properties:
  - type: x-saml-metadata
    url: authentication/cityu-shibboleth-idp-metadata.xml
  - type: Authentication
    url: authentication/cityu-authentication.yml
  - type: x-conformance
    url: conformance/cityu-education-standards-conformance.yml
  - type: Documentation
    url: https://www.hkaf.edu.hk/
- aid: cityu:auth-oidc
  name: CityUHK Single Sign-On (OpenID Connect / OAuth 2.0)
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/cityu.png
  x-operator: tenant
  description: CityUHK's OpenID Connect and OAuth 2.0 authorization server on the university's own hostname auth.cityu.edu.hk,
    which CNAMEs to cityu.customdomains.okta.com. Serves an OpenID Connect Discovery 1.0 document and an RFC 8414 authorization-server
    metadata document, both publicly readable, with issuer https://auth.cityu.edu.hk. The configuration is CityUHK's; the
    platform is Okta.
  humanURL: https://auth.cityu.edu.hk/
  baseURL: https://auth.cityu.edu.hk/oauth2/v1
  tags:
  - Identity
  - OpenID Connect
  - Authentication
  - Single Sign-On
  tags_raw:
  - Identity
  - OpenID Connect
  - OAuth 2.0
  - Single Sign-On
  properties:
  - type: x-openid-configuration
    url: https://auth.cityu.edu.hk/.well-known/openid-configuration
  - type: x-oauth-authorization-server
    url: https://auth.cityu.edu.hk/.well-known/oauth-authorization-server
  - type: Authentication
    url: authentication/cityu-authentication.yml
- aid: cityu:canvas
  name: CityUHK Canvas Learning Management System (tenant deployment)
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/cityu.png
  x-operator: tenant
  description: CityUHK's Canvas tenant. canvas.cityu.edu.hk CNAMEs to cityuhk-vanity.instructure.com and redirects unauthenticated
    traffic to the university's Okta SSO with a SAMLRequest. The Canvas REST API and LTI surfaces belong to Instructure's
    contract, not CityUHK's, and no CityUHK LTI registration or tool configuration is publicly readable, so no contract is
    stored here.
  humanURL: https://canvas.cityu.edu.hk/
  baseURL: https://canvas.cityu.edu.hk/api/v1
  tags:
  - Learning Management
  - Canvas
  - LTI
  - Gated
  properties:
  - type: x-vendor
    url: https://www.instructure.com/canvas
common:
- type: Website
  url: https://www.cityu.edu.hk/
- type: GitHubOrganization
  url: https://github.com/cityu
- type: LinkedIn
  url: https://hk.linkedin.com/school/cityu/
- type: ResearchRepository
  url: https://scholars.cityu.edu.hk/
- type: IdentityFederation
  url: https://idp2.cityu.edu.hk/idp/shibboleth
- type: AIPolicy
  url: https://www.cityu.edu.hk/GenAI/guidelines.htm
- type: AITooling
  url: https://www.cityu.edu.hk/GenAI/gpt-services.htm
- type: Documentation
  name: CityUHK IT Services — API Gateway and API Management
  url: https://www.cityu.edu.hk/its/services-facilities/api-gateway-and-api-management
- type: Authentication
  url: authentication/cityu-authentication.yml
- type: x-conformance
  url: conformance/cityu-education-standards-conformance.yml
- type: DomainSecurity
  url: security/cityu-domain-security.yml
- type: Plans
  url: plans/cityu-plans-pricing.yml
- type: RateLimits
  url: rate-limits/cityu-rate-limits.yml
- type: FinOps
  url: finops/cityu-finops.yml
- type: Review
  url: review.yml
x-coverage:
  state: covered
  reason: tenant_only
  detail: 'CityUHK''s publicly reachable machine-readable footprint is almost entirely tenanted, not built. The research information
    system is an Elsevier Pure deployment, the LMS is an Instructure tenant, and single sign-on is an Okta tenant on a CityUHK
    hostname; the only contract CityUHK operates itself is the Shibboleth IdP metadata at idp2.cityu.edu.hk, registered in
    eduGAIN via HKAF. CityUHK does run a genuine internal API programme on MuleSoft Anypoint per its own IT Services service
    catalogue, but nothing in it is published or callable off-campus and there is no developer portal. Probing the main web
    estate is additionally limited: every deep path under www.cityu.edu.hk returns HTTP 200 carrying an Imperva/Incapsula
    bot-challenge body rather than page content, so the AI-policy and IT-Services pointers below are recorded from search-engine-indexed
    titles plus a live-but-challenged response, not from a body we could read. No open-data portal, course or timetable API,
    status page, or institution-operated REST API was found; data.cityu.edu.hk and opendata.cityu.edu.hk do not resolve, and
    api.cityu.edu.hk resolves inside CityUHK''s own 144.214.0.0/16 range but does not answer from the public internet.'
  generated: '2026-08-30'
  method: probed
  evidence:
  - url: https://scholars.cityu.edu.hk/ws/oai?verb=Identify
    status: 200
  - url: https://scholars.cityu.edu.hk/ws/oai?verb=ListSets
    status: 200
  - url: https://scholars.cityu.edu.hk/ws/api/openapi.yaml
    status: 200
    note: Elsevier's generic Pure API 5.35.1-2 contract, not CityUHK's.
  - url: https://idp2.cityu.edu.hk/idp/shibboleth
    status: 200
  - url: https://auth.cityu.edu.hk/.well-known/openid-configuration
    status: 200
  - url: https://auth.cityu.edu.hk/.well-known/oauth-authorization-server
    status: 200
  - url: https://auth.cityu.edu.hk/app/exk1h9fleyX6q1zrz5d7/sso/saml/metadata
    status: 200
  - url: https://canvas.cityu.edu.hk/
    status: 200
    note: Redirects to auth.cityu.edu.hk with a SAMLRequest.
  - url: https://technical.edugain.org/api.php?action=list_entities&e_id=cityu&search_type=entityid
    status: 200
  - url: https://api.github.com/orgs/cityu/repos
    status: 200
    note: Empty array — zero public repositories.
  - url: https://www.cityu.edu.hk/robots.txt
    status: 200
  - url: https://www.cityu.edu.hk/llms.txt
    status: 404
  - url: https://www.cityu.edu.hk/its/services-facilities/api-gateway-and-api-management
    status: 200
    note: Imperva/Incapsula bot challenge body; live but unreadable.
  - url: https://www.cityu.edu.hk/GenAI/guidelines.htm
    status: 200
    note: Imperva/Incapsula bot challenge body; live but unreadable.
  - url: https://data.cityu.edu.hk/
    status: 0
    note: NXDOMAIN.
  - url: https://api.cityu.edu.hk/
    status: 0
    note: Resolves to 144.214.2.78 but does not answer publicly.
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com