Skip to content
Console
On this page

Auth configs

An Auth Config is the app scope of Sylphx Auth in one environment: which sign-in methods the customer's app offers, and its MFA, passkey,…

An Auth Config is the app scope of Sylphx Auth in one environment: which sign-in methods the customer's app offers, and its MFA, passkey, lockout, session, CAPTCHA, and Account Portal policy. Every Auth fact is scoped to one orgs/{o}/projects/{p}/envs/{e}; an environment has exactly one Auth Config, id default.

Service Sylphx Auth · Resource type auth.sylphx.com/AuthConfig · Name pattern orgs/{org}/projects/{project}/envs/{env}/auth_configs/{auth_config} · Shape singleton

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/auth_configs/{auth_config}.
uidstringacf_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specAuthConfigSpecDesired state. Required.
statusAuthConfigStatusObserved state. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets an auth config.
PATCHupdateUpdates an auth config.

get

Gets an auth config.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/auth_configs/auth-config · scope auth:read · effect read · Request, response and examples

update

Updates an auth config.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/auth_configs/auth-config · scope auth:write · effect write · Request, response and examples