Skip to main content
POST
Create OAuth login config

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

appID
string
required

The id of the app the request refers to. An application's unique identifier.

Examples:

"54e9ujn"

"fvua38g"

provider
string
required

The OAuth provider identifier.

Examples:

"google"

"apple"

"github"

"microsoft"

"okta"

"facebook"

"linkedin"

Body

application/json
client_id
string
required
Example:

"123456789.apps.googleusercontent.com"

client_secret
string
required
Example:

"GOCSPX-abc123def456"

type
enum<string>
default:personal

personal is the classic social-login config (at most one per provider, addressed as …/oauth/{provider}). enterprise is a per-connection OIDC SSO config (any number per provider, addressed as …/oauth/{provider}/{connectionID}). Defaults to personal.

Available options:
personal,
enterprise
Example:

"enterprise"

enabled
boolean
Example:

true

scopes
string[]

Scopes requested from the OAuth provider (IdP).

granted_scopes
string[]

Prelude session scopes attached to the session when a login completes through this social provider (for example prld:pwd:write). Distinct from scopes, which are requested from the IdP.

Example:
options
object
apple
object
okta
object
enterprise
object

Required when type is enterprise, rejected otherwise. Its email_domain_allowlist must be non-empty and must not overlap another connection's, and the provider must be one of okta, google, or microsoft.

Response

Created

config
object
required