---
title: "Create an authorize"
method: POST
path: "/oauth/authorize"
tags: ["API authentication"]
---

# Create an authorize

`POST /oauth/authorize`

## Request

- Base URL: `https://core.sivo.com`
- URL: `https://core.sivo.com/oauth/authorize`
- Auth: one of:
  - API key in header `Authorization`
  - OAuth 2
    - Authorization code: `https://dashboard.sivo.com/oauth/authorize`
    - Client credentials
    - Token URL: `https://core.sivo.com/oauth/token`
- TypeScript: <https://skmtc.dev/sivo/apis/sivo-advance-api/docs/oauth/authorize/post.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `Idempotency-Key` string: A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 256 bytes. See [Idempotent Requests](/docs/idempotent-requests).

## Request body

- object
  - `response_type` 'code', required
  - `client_id` string, required: Non-empty text string
  - `redirect_uri` string, uri, required: HTTP(S) URL
  - `state` string: Non-empty text string
  - `scope` string[]
  - `code_challenge` string: Non-empty text string
  - `code_challenge_method` 'plain' | 'S256'
  - `prompt` 'none' | 'login' | 'consent' | 'select_account'
  - `audience` string: Non-empty text string
  - `access_type` 'online' | 'offline'
  - `resource` string, uri: HTTP(S) URL

## Response `200`

Successful operation

- object
  - `response_type` 'code', required
  - `client_id` string, required: Non-empty text string
  - `redirect_uri` string, uri, required: HTTP(S) URL
  - `state` string: Non-empty text string
  - `scope` string[]
  - `code_challenge` string: Non-empty text string
  - `code_challenge_method` 'plain' | 'S256'
  - `prompt` 'none' | 'login' | 'consent' | 'select_account'
  - `audience` string: Non-empty text string
  - `access_type` 'online' | 'offline'
  - `resource` string, uri: HTTP(S) URL
  - `id` string, required: An object id with prefix
  - `created_at` string, date-time, required: Creation date and time
  - `created_by` string, required: ID of the user that created this object
  - `updated_at` string, date-time, required: Last update date and time
  - `updated_by` string, required: ID of the user that last updated this object

## Changes

- **2026-11-03** `4bbab9699612`: 1 warning, 3 info
  - deleted the `header` request parameter `IdempotencyKey`
  - added the new optional `header` request parameter `Idempotency-Key`
  - the `created_by` response's property pattern was changed from `^[a-z]{3,7}_[0-9A-Za-z]{27}$` to `^[0-9A-Za-z_-]{1,255}$` for the status `200`
  - the `updated_by` response's property pattern was changed from `^[a-z]{3,7}_[0-9A-Za-z]{27}$` to `^[0-9A-Za-z_-]{1,255}$` for the status `200`

[Operation history](https://skmtc.dev/sivo/apis/sivo-advance-api/changes/oauth/authorize/post.md)

---

[API](https://skmtc.dev/sivo/apis/sivo-advance-api.md) - [All operations](https://skmtc.dev/sivo/apis/sivo-advance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sivo/apis/sivo-advance-api/revisions/4bbab9699612?raw)