Sign in

v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
OAuth2

Authorize

Initiates OAuth authorization flow.

get/oauth/authorize

Query parameters

client_idstring required

Application's client ID.

Application's client ID.

audiencestring

Identifier of the target API. Should be left empty by default.

Identifier of the target API. Should be left empty by default.

scopestring

A space-separated list of permissions your app requires. Should be left empty by default.

Example:customers.read customers.write

A space-separated list of permissions your app requires. Should be left empty by default.

response_type'code' required
redirect_uristring required

The URL to which Hyperline will redirect the browser after authorization has been granted by the user. It must match one of the callback URL you set when registering your app.

The URL to which Hyperline will redirect the browser after authorization has been granted by the user. It must match one of the callback URL you set when registering your app.

statestring required

A random string generated by your app to prevent CSRF attacks. This value will be included in the query parameter when redirecting to the redirect_uri after authorizing your app.

A random string generated by your app to prevent CSRF attacks. This value will be included in the query parameter when redirecting to the redirect_uri after authorizing your app.

resourcestring

The canonical URI of the resource server (RFC 8707). For MCP clients, this should be the MCP server endpoint URL. Example: https://api.hyperline.co/mcp

Example:https://api.hyperline.co/mcp

The canonical URI of the resource server (RFC 8707). For MCP clients, this should be the MCP server endpoint URL. Example: https://api.hyperline.co/mcp

code_challengestring

PKCE code challenge. Required for public clients (e.g., MCP clients).

PKCE code challenge. Required for public clients (e.g., MCP clients).

code_challenge_method'S256' | 'plain'

PKCE code challenge method. S256 is recommended for security.

PKCE code challenge method. S256 is recommended for security.

promptstring

OAuth prompt parameter. MCP clients send 'consent' when requesting offline_access.

OAuth prompt parameter. MCP clients send 'consent' when requesting offline_access.