Skip to main content
GET
Read Native Auth configuration

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

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}$

Response

Current authorized resource.

enabled
boolean
required

Persistent Owner setting; source deployment cannot clear a pause.

configurationRevision
integer
required
Required range: x >= 0
revocationEpoch
integer
required
Required range: x >= 0
signupPolicy
enum<string>
required
Available options:
open,
invite-only
canonicalOrigin
string<uri> | null
required
applicationName
string
required
Required string length: 1 - 128
allowedRedirectPaths
string[]
required
Required array length: 1 - 16 elements

Absolute application path without query, fragment, percent escapes, backslashes or dot segments.

Maximum string length: 256
Pattern: ^/(?!/)(?!.*//)(?!\.{1,2}(?:/|$))(?!.*\/\.{1,2}(?:/|$))[A-Za-z0-9/_~.-]*$
resetPasswordPath
string
required

Absolute application path without query, fragment, percent escapes, backslashes or dot segments.

Maximum string length: 256
Pattern: ^/(?!/)(?!.*//)(?!\.{1,2}(?:/|$))(?!.*\/\.{1,2}(?:/|$))[A-Za-z0-9/_~.-]*$
invitationPath
string
required

Absolute application path without query, fragment, percent escapes, backslashes or dot segments.

Maximum string length: 256
Pattern: ^/(?!/)(?!.*//)(?!\.{1,2}(?:/|$))(?!.*\/\.{1,2}(?:/|$))[A-Za-z0-9/_~.-]*$
readiness
object
required