Skip to main content
POST
/
workspaces
/
{workspace_id}
/
providers
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "requires_config": true,
  "enabled": true
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

fastapiusersauth
string
cookie
required

Path Parameters

workspace_id
string<uuid>
required

Body

application/json

Request payload for creating a custom OAuth provider.

name
string
required
Required string length: 3 - 120
grant_type
enum<string>
required

Grant type for OAuth 2.0.

Available options:
authorization_code,
client_credentials
authorization_endpoint
string
required

OAuth authorization endpoint URL

Minimum string length: 8
token_endpoint
string
required

OAuth token endpoint URL

Minimum string length: 8
client_id
string
required

OAuth client identifier

Required string length: 1 - 512
description
string | null
Maximum string length: 512
scopes
string[] | null

Default OAuth scopes to request

provider_id
string | null

Optional custom identifier for the provider

Required string length: 3 - 255
client_secret
string<password> | null

OAuth client secret for the provider

Minimum string length: 1

Response

Successful Response

id
string
required
name
string
required
description
string
required
requires_config
boolean
required
integration_status
enum<string>
required

Status of an integration.

Available options:
not_configured,
configured,
connected
enabled
boolean
required
grant_type
enum<string>
required

Grant type for OAuth 2.0.

Available options:
authorization_code,
client_credentials