HotDoc · OAuth Scopes

HotDoc OAuth Scopes

OAuth 2.0 searched

HotDoc publishes 1 OAuth 2.0 scope via the authorizationCode and implicit flows. Scopes are the fine-grained permissions an application requests at authorization time to act against the HotDoc API on a user’s behalf.

Tokens are issued from https://www.hotdoc.com.au/oauth/token.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

HealthcareAustraliaPatient EngagementOnline BookingAppointment SchedulingTelehealthPractice ManagementPrimary CareDigital Healthe-Prescribing
Scopes: 1 Flows: authorizationCode, implicit Method: searched

OAuth endpoints

Authorization URL
https://www.hotdoc.com.au/oauth/authorize
Token URL
https://www.hotdoc.com.au/oauth/token
Flows
authorizationCodeimplicit

Scopes (1)

ScopeDescriptionFlows
openid OpenID Connect authentication; returns an ID token with the subject and profile claims. authorizationCode, implicit

Source

OAuth Scopes

hotdoc-scopes.yml Raw ↑
generated: '2026-07-24'
method: searched
source: https://www.hotdoc.com.au/.well-known/openid-configuration
docs: https://www.hotdoc.com.au/.well-known/openid-configuration
note: >-
  HotDoc's OpenID Connect discovery document advertises a single OAuth 2.0 scope,
  "openid". No broader resource/API scope surface (read/write per-resource scopes)
  is published; the authorization server issues OIDC identity tokens whose claims
  (practice_name, pms_software, access_level, company) carry the authorization
  context rather than granular scopes. Additional scopes, if any, are gated behind
  partner/clinic client registration and are not publicly documented.
schemes:
- name: HotDocOAuth2
  source: well-known/hotdoc-oauth-authorization-server.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://www.hotdoc.com.au/oauth/authorize
    tokenUrl: https://www.hotdoc.com.au/oauth/token
  - flow: implicit
    authorizationUrl: https://www.hotdoc.com.au/oauth/authorize
scopes:
- scope: openid
  description: OpenID Connect authentication; returns an ID token with the subject and profile claims.
  flows:
  - authorizationCode
  - implicit
  sources:
  - well-known/hotdoc-openid-configuration.json