---
title: "POST /api/v1/oauth/begin-auth-code-flow"
method: POST
path: "/api/v1/oauth/begin-auth-code-flow"
tags: ["Oauth"]
---

# POST /api/v1/oauth/begin-auth-code-flow

`POST /api/v1/oauth/begin-auth-code-flow`

## Request

- Base URL: `https://api.immy.bot` (the document declares no server; this is the origin it was published from)
- URL: `https://api.immy.bot/api/v1/oauth/begin-auth-code-flow`
- Auth: none declared

## Request body

- BeginAuthCodeFlowRequest
  - `oauthConsentData` OauthConsentData
    - `authorizationEndpoint` string, uri, nullable
    - `tokenEndpoint` string, uri, nullable
    - `resource` string, nullable
    - `scopes` string, nullable
    - `clientId` string, nullable
    - `extraQueryParameters` object, nullable
    - `usePkce` boolean
  - `allowSilentRefresh` boolean

## Response `200`

OK

- BeginAuthCodeFlowResponse
  - `oauthHookId` string, uuid
  - `pkceCodeChallenge` string, nullable

---

[API](https://skmtc.dev/immy/apis/immy-bot-api-2.md) · [All operations](https://skmtc.dev/immy/apis/immy-bot-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/immy/apis/immy-bot-api-2/revisions/75b50268fa51?raw)