Sign in
OAuth Configuration

Create OAuth configuration

Changed on

Configure OAuth provider (Google, GitHub, Microsoft, Apple, Device)

post/projects/{id}/oauth/configs

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/oauth/configs
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

Request body

provider'google' | 'github' | 'microsoft' | 'apple' | 'device' required
client_idstring

Required for non-device providers. Must not be provided for provider=device; server always auto-generates it.

client_secretstring

Required for non-device providers. Must not be provided for provider=device; server always auto-generates it.

redirect_urlstring uri

Required for non-device providers. Not used for provider=device.

scopesstring[]

Optional for non-device providers, uses provider defaults if omitted. Not used for provider=device.

Example request

{
  "provider": "google",
  "client_id": "123456789.apps.googleusercontent.com",
  "client_secret": "GOCSPX-abc123def456",
  "redirect_url": "https://yourapp.com/auth/callback",
  "scopes": [
    "openid",
    "email",
    "profile"
  ]
}

Response

OAuth config created

idstring uuid
provider'google' | 'github' | 'microsoft' | 'apple' | 'device'
client_idstring
client_secretstring

Masked in responses (shows only first/last 4 chars)

enabledboolean
redirect_urlstring uri
scopesstring[]
created_atstring date-time
updated_atstring date-time

Example response

{
  "client_id": "123456789.apps.googleusercontent.com",
  "client_secret": "GOCS...****",
  "redirect_url": "https://yourapp.com/auth/callback",
  "scopes": [
    "openid",
    "email",
    "profile"
  ]
}

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter id

    • ▲

      added the new required request property

    • ▲

      the request's body type changed from no type to object

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status