Skip to main content
PUT
Update a Native Auth provider

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128
Idempotency-Key
string
required

Identifies one mutation and its canonical request payload.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
environment_id
string
required

Environment identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
provider
enum<string>
required
Available options:
google,
github

Body

application/json

The revision must match current configuration. Secrets are write-only and never echoed in responses or replay receipts.

configurationRevision
integer
required
Required range: x >= 0
enabled
boolean
required
clientId
string
Required string length: 1 - 1024
clientSecret
string
write-only

At most 5120 UTF-8 bytes. The value is accepted only by this write-only operation.

Required string length: 1 - 5120

Response

Current authorized resource.

Configuration presence does not establish provider approval or a successful flow.

provider
enum<string>
required
Available options:
google,
github
enabled
boolean
required
configured
boolean
required
clientId
string | null
required
secretPresent
boolean
required
callbackUrl
string<uri> | null
required

Null until a canonical origin is ready.

scopes
string[]
required
lastSuccessfulFlowAt
string<date-time> | null
required