/APIs & SDKs/Authentication

Authentication

28 endpoints

Markdown for AI context

These endpoints manage team authentication for a program. OptiTech uses BankID and SSO through your identity provider, so access follows your central identity policy and offboarded employees lose access immediately.

Common uses include configuring SSO, managing roles (admin, contributor, viewer), and inspecting active sessions from platform automation.

These endpoints act at the program level: enabling SSO, managing roles, and inspecting configuration. For a full walkthrough of the management API, see Manage authentication via the API.

For managing who can access what, see User permissions to get started.

Setup

4

Enable OptiTech Auth for the framework Retrieve OptiTech Auth details for the framework Disable OptiTech Auth for the framework Update auth configuration

OAuth Providers

4

List OAuth providers for the framework Add an OAuth provider Update OAuth provider Delete OAuth provider

Users

3

Create new auth user Delete auth user Update auth user role

Trusted Domains

3

List domains in redirect_uri whitelist Add domain to redirect_uri whitelist Delete domain from redirect_uri whitelist

Email

5

Retrieve email and password configuration Update email and password configuration Retrieve email provider configuration Update email provider configuration Send test email

Plugins

5

Retrieve OptiTech Auth plugin configurations Update magic link plugin configuration Update organization plugin configuration Retrieve phone number plugin configuration Update phone number plugin configuration

Configuration

4

Retrieve localhost allow setting Update localhost allow setting Retrieve OptiTech Auth webhook configuration Update OptiTech Auth webhook configuration

PUT/programs/{program_id}/frameworks/{framework_id}/auth/users/{auth_user_id}/roleUpdate auth user role GET/programs/{program_id}/frameworks/{framework_id}/auth/email_and_passwordRetrieve email and password configuration PATCH/programs/{program_id}/frameworks/{framework_id}/auth/email_and_passwordUpdate email and password configuration GET/programs/{program_id}/frameworks/{framework_id}/auth/email_providerRetrieve email provider configuration PATCH/programs/{program_id}/frameworks/{framework_id}/auth/email_providerUpdate email provider configuration GET/programs/{program_id}/frameworks/{framework_id}/auth/allow_localhostRetrieve localhost allow setting PATCH/programs/{program_id}/frameworks/{framework_id}/auth/allow_localhostUpdate localhost allow setting GET/programs/{program_id}/frameworks/{framework_id}/auth/pluginsRetrieve OptiTech Auth plugin configurations PATCH/programs/{program_id}/frameworks/{framework_id}/auth/plugins/organizationUpdate organization plugin configuration PATCH/programs/{program_id}/frameworks/{framework_id}/auth/configUpdate auth configuration PATCH/programs/{program_id}/frameworks/{framework_id}/auth/plugins/magic-linkUpdate magic link plugin configuration GET/programs/{program_id}/frameworks/{framework_id}/auth/plugins/phone-numberRetrieve phone number plugin configuration PATCH/programs/{program_id}/frameworks/{framework_id}/auth/plugins/phone-numberUpdate phone number plugin configuration GET/programs/{program_id}/frameworks/{framework_id}/auth/webhooksRetrieve OptiTech Auth webhook configuration PUT/programs/{program_id}/frameworks/{framework_id}/auth/webhooksUpdate OptiTech Auth webhook configuration GET/programs/{program_id}/frameworks/{framework_id}/authRetrieve OptiTech Auth details for the framework POST/programs/{program_id}/frameworks/{framework_id}/authEnable OptiTech Auth for the framework DELETE/programs/{program_id}/frameworks/{framework_id}/authDisable OptiTech Auth for the framework GET/programs/{program_id}/frameworks/{framework_id}/auth/domainsList domains in redirect_uri whitelist POST/programs/{program_id}/frameworks/{framework_id}/auth/domainsAdd domain to redirect_uri whitelist DELETE/programs/{program_id}/frameworks/{framework_id}/auth/domainsDelete domain from redirect_uri whitelist POST/programs/{program_id}/frameworks/{framework_id}/auth/usersCreate new auth user DELETE/programs/{program_id}/frameworks/{framework_id}/auth/users/{auth_user_id}Delete auth user GET/programs/{program_id}/frameworks/{framework_id}/auth/oauth_providersList OAuth providers for the framework POST/programs/{program_id}/frameworks/{framework_id}/auth/oauth_providersAdd an OAuth provider PATCH/programs/{program_id}/frameworks/{framework_id}/auth/oauth_providers/{oauth_provider_id}Update OAuth provider DELETE/programs/{program_id}/frameworks/{framework_id}/auth/oauth_providers/{oauth_provider_id}Delete OAuth provider POST/programs/{program_id}/frameworks/{framework_id}/auth/send_test_emailSend test email

Was this page helpful?

Thank you for your feedback!

Previous Restart integration Next Retrieve OptiTech Auth details for the framework