Skip to main content
REST client

OAuth

The 4 operations under oauth, as typed calls on the generated REST client.

1 min read
View MarkdownEdit on GitHub

OAuth

Available from @codespar/sdk 0.12.0; the version on npm is 0.12.0. Every example on this page is compiled against the installed package when these docs build: a call that does not type-check fails the build.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import {  } from "@codespar/sdk";

const  = new ({ : .. });

GET /oauth/authorize

GET/oauth/authorize

Consent page (RFC 6749 §4.1.1 authorization request)

const  = await ..("/oauth/authorize", {
  : {
    : "code",
    : "client_0000000000000000",
    : "https://example.com/hook",
    : "string",
    : "S256"
  }
});

Parameters, body and every documented response: GET /oauth/authorize in the HTTP reference.

POST /oauth/authorize

POST/oauth/authorize

Consent submit — exchanges a pasted API key for an authorization code

const  = await ..("/oauth/authorize", {
  : {
    : "code",
    : "client_0000000000000000",
    : "https://example.com/hook",
    : "string",
    : "S256",
    : "string",
    : "string",
    : "string"
  }
});

Parameters, body and every documented response: POST /oauth/authorize in the HTTP reference.

POST /oauth/register

POST/oauth/register

Register a client (RFC 7591 dynamic client registration)

const  = await ..("/oauth/register", {
  : {
    : [
      "https://example.com/hook"
    ],
    : "Example",
    : "https://example.com/hook",
    : [
      "string"
    ],
    : [
      "string"
    ]
  }
});

Parameters, body and every documented response: POST /oauth/register in the HTTP reference.

POST /oauth/token

POST/oauth/token

Token endpoint — authorization_code and refresh_token grants

const  = await ..("/oauth/token", {
  : {
    : "authorization_code",
    : "string",
    : "string",
    : "https://example.com/hook",
    : "client_0000000000000000",
    : "string"
  }
});

Parameters, body and every documented response: POST /oauth/token in the HTTP reference.

OAuth | CodeSpar