v1

latestOpenAPI 3.0.02026-07-231358118.3 KB

GET authorize

OAuth authorization request (consent screen)

Starts the authorization code flow and shows the consent screen when interaction is required. If the user is not signed in, they are redirected to sign-in and then returned here with the same query string. Optional parameters include PKCE (code_challenge, code_challenge_method) and state (recommended). Example request: https://healthsherpa.com/oauth/authorize?client_id=YOUR_OAUTH_APPLICATION_ID&redirect_uri=YOUR_OAUTH_APPLICATION_REDIRECT_URI&response_type=code&scope=intake_form_api

get/authorize

Query parameters

client_idstring required

Registered OAuth client id (public client identifier issued by HealthSherpa).

redirect_uristring required

Must exactly match a registered redirect URI for the client.

response_type'code' required

Authorization code flow uses code.

scopestring required

Space-delimited scopes requested for the grant.

statestring

Opaque value echoed back to the client to prevent CSRF.

Response

HTML consent page. Only displays when the user does not have any unrevoked access tokens. Otherwise, we'll redirect to client redirect_uri.