Jump to Content
Home
Product documentation
API Reference
Release notes
Home
Support home
Support requests
System status
Trust center
Try for free
API Reference
Support home
Support requests
System status
Trust center
Try for free
Product documentation
API Reference
Release notes
Native Journey API
All
Pages
Start typing to search…
JUMP TO
Developer docs
Developers
Getting started for developers
SDK reference
API reference
OpenAPI specs
Developer tools
Native Journey API
Journey-flow API for native clients
Headless components rendering reference
Simple Authentication API
Authenticate with identifier and password
post
Simple token request
post
Admin Portal
Getting started with the admin API
Authenticating to the API
Exchange credentials for a token
post
Account
List accounts
get
Create an account
post
Delete an account
del
Get an account
get
Create authenticator for an account
post
Delete authenticator for an account
del
Disable an account
post
Enable an account
post
Assign groups to an account
post
Update identifier for an account
post
Request impersonation of an account
post
Lift passcode lock for an account
post
Lift password lock for an account
post
Update organization for an account
put
Change password for an account
post
Request password reset for an account
post
List role assignments for an account
get
Update metadata of an account
put
Assign multiple roles to an organization for an account
post
Delete an organization role assignment from an account
del
Clear sessions for an account
del
List sessions for an account
get
Delete session for an account
del
Account Attribute
List attributes
get
Create an attribute
post
Reorder attributes
put
Get an Attribute
get
Update an attribute
put
Account Event
List account events
get
Get an account event
get
List descriptors for account events
get
List notification events
get
Get a notification event
get
Account Event TTL
Get available account event TTLs
get
Account Identity
List identities for an account
get
Account Invitation
List account invitations
get
Create an account invitation
post
Revoke an account invitation
del
Get an account invitation
get
Resend an account invitation
post
Account Lifecycle Rule
List account lifecycle rules
get
Create an account lifecycle rule
post
Delete an account lifecycle rule
del
Get an account lifecycle rule
get
Update an account lifecycle rule
put
Active Telephony Provider Configuration
List active telephony service providers
get
Deactivate telephony service provider by type
del
Get active telephony service provider
get
Activate telephony service provider
post
Adaptive Access Policy (Adaptive MFA)
List adaptive access policies
get
Create an adaptive access policy
post
Filter for locations
get
Delete an adaptive access policy
del
Get an adaptive access policy
get
Update an adaptive access policy
put
Admin Principal
Get admin information
get
Update UI settings for admin account
post
API Security Policy
List API security policies
get
Create an API security policy
post
Delete an API security policy
del
Get an API security policy
get
Update an API security policy
put
Assign a client to an API security policy
post
Delete an API security policy assignment
del
Get an API security policy assignment
get
Update an API security policy assignment
put
API Security Policy Scope
Create a scope for an API security policy
post
Delete a scope for an API security policy
del
Get a scope for an API security policy
get
Update a scope for an API security policy
put
Application
List applications
get
Create an application
post
Delete an application
del
Get an application
get
Update an application
put
Application Client
List application clients
get
Create an application client
post
Delete an application client
del
Get an application client
get
Update an application client
put
Get SAML2 metadata for an application client
get
Application Variant
List variants
get
List application config A/B testing variants
get
Create an application config A/B testing variant
post
Update the order of application config A/B testing variants
put
Delete an application config A/B testing variant
del
Get an application config A/B testing variant
get
Update an application config A/B testing variant
put
Audit entry
List audit logs
get
Get an audit log
get
Available Role Scope
List available scopes
get
Branding Policy
List branding policies
get
Create a branding policy
post
Delete a branding policy
del
Get a branding policy
get
Update a branding policy
put
Bridge Policy
List bridge policies
get
Create a bridge policy
post
Delete a bridge policy
del
Get a bridge policy
get
Update a bridge policy
put
Bridge Policy Resource
List a bridge policy resources
get
Create a bridge policy resource
post
Update the order of bridge policy resources
put
Delete a bridge policy resource
del
Get a bridge policy resource
get
Update a bridge policy resource
put
Bulk Operation
Query if there is a running bulk operation
head
Create a bulk operation job
post
Get status of a job
get
Get errors for a job
get
Claim
List claims
get
Create a claim
post
Delete a claim
del
Get a claim
get
Update a claim
put
Consent
List consents
get
Create a consent
post
Get a consent
get
Update a consent
put
Dialect
List dialects
get
Create a dialect
post
Delete a dialect
del
Get a dialect
get
Update a dialect
put
Email Configuration
Get email configuration
get
Update email configuration
post
Enterprise Login Claim Mapping
List available native claims
get
List claim mappings
get
Create a claim mapping
post
Delete claim mapping
del
Get a claim mapping
get
Update claim mapping
put
Enterprise Login Provider
List enterprise login providers
get
Create an enterprise login provider
post
Delete an enterprise login provider
del
Get an enterprise login provider
get
Update an enterprise login provider
put
Event Streaming
List event streaming configurations
get
Create an event streaming configuration
post
Delete an event streaming configuration
del
Get an event streaming configuration
get
Update an event streaming configuration
put
Test an event streaming configuration
post
Group
List groups
get
Create a group
post
Delete a group
del
Get a group
get
Update a group
put
Group API Security Policy Assignment
List API security policy assignments for a group
get
Assign API security policy to a group
post
Delete a group API security policy assignment
del
Get API security policy assignment for a group
get
Update assigned scopes
put
Group Member
List group members
get
Add member to a group
post
Remove member from a group
del
Identity Store
List identity stores
get
Create an identity store
post
Delete an identity store
del
Get an identity store
get
Update an identity store
put
List available native claims
get
List native claim mappings
get
Identity Verification
List identity verifications
get
Create an identity verification
post
Delete attempts for an identity verification
del
Invalidate an identity verification
post
Identity Verification Policy
List identity verification policies
get
Create an identity verification policy
post
Delete an identity verification policy
del
Get an identity verification policy
get
Update an identity verification policy
put
Identity Verification Step
List identity verification steps
get
Create an identity verification step
post
Reorder verification steps
put
Delete an identity verification step
del
Get an identity verification step
get
Update an identity verification step
put
Instance Config
Get instance config
get
Update instance config
post
Get instance address
get
Lifecycle Event Hook
List lifecycle event hooks
get
Create a lifecycle event hook
post
Delete a lifecycle event hook
del
Get a lifecycle event hook
get
Update a lifecycle event hook
put
Deploy a lifecycle event hook
post
Get status of a lifecycle event hook
get
Lifecycle Event Hook Descriptor
List descriptors for event hooks
get
Lifecycle Event Hook Log
List event hook logs
get
Get an event hook log
get
Lifecycle Event Hook Tryout
Create a tryout function resource
post
Delete a tryout function resource
del
Call a tryout function resource
post
Native Claim
List native claims
get
Create a native claim
post
Delete a native claim
del
Get a native claim
get
Update a native claim
put
Notification Policy
List notification policies
get
Create a notification policy
post
Delete a notification policy
del
Get a notification policy
get
Update a notification policy
put
Notification Template
Update a notification template (email)
put
Update a notification template (SMS)
put
List notification templates
get
Get a notification template
get
NPM Dependency
List NPM dependency versions
post
Filter for NPM dependency suggestions for a lifecycle event hook
post
Organization
List organizations
get
Create an organization
post
Delete an organization
del
Get an organization
get
Update an organization
put
Organization Policy
List organization policies
get
Create an organization policy
post
Delete an organization policy
del
Get an organization policy
get
Update an organization policy
put
Password Quality Policy
List password quality policies
get
Create a password quality policy
post
Delete a password quality policy
del
Get a password quality policy
get
Update a password quality policy
put
Personal Data
Download account information
get
Plugin Library
Get categories for plugin library
get
Get snippets by hook type
get
Get snippet code
get
Get plugin library for lifecycle event hooks
get
Get an integration for lifecycle event hook
get
Get plugin library for journeys
get
Get an integration for journey
get
Restricted Password
List password word restrictions
get
Create a password word restriction
post
Get total size in MB
get
Delete a password word restriction
del
Get a password word restriction
get
Update a password word restriction
put
Export a password restriction
get
Role
List roles
get
Create a role
post
Delete a role
del
Get a role
get
Update a role
put
Self Service Policy
List self-service policies
get
Create a self-service policy
post
Delete a self-service policy
del
Get a self-service policy
get
Update a self-service policy
put
Social Login Claim Mapping
List available native claims
get
List claim mappings
get
Create a claim mapping
post
Delete claim mapping
del
Get a claim mapping
get
Update claim mapping
put
Social Login Provider
List social login providers
get
Create a social login provider
post
Delete a social login provider
del
Get a social login provider
get
Update a social login provider
put
Statistics
Query active account statistics
get
Query connector uptime statistics
get
Query consent acceptance statistics
get
Query statistics
get
Telephony Provider Configuration
List telephony service providers
get
Create telephony service provider
post
Delete telephony service provider
del
Get telephony service provider
get
Update telephony service provider
put
Translation
List translations
get
Reset a translation
del
Export a translation
get
Import a translation
post
Disable a translation
post
Enable a translation
post
Variables
List variables
get
Create a variable
post
Delete a variable
del
Get a variable
get
Update a variable
put
Web Analytics
List web analytics integrations
get
Create a web analytics integration
post
Delete a web analytics integration
del
Get a web analytics integration
get
Update a web analytics integration
put
Admin Portal - Admin Management
Adaptive Access Policy (Adaptive MFA)
Get the admin adaptive access policy
get
Update the admin adaptive access policy
put
Filter for locations
get
Admin Account
List admin accounts
get
Create an admin account
post
Delete an admin account
del
Get an admin account
get
Create authenticator for an admin account
post
Delete authenticator for an admin account
del
Disable an admin account
post
Download admin account information
get
Enable an admin account
post
List identities for an admin account
get
Update identifier for an admin account
post
Lift passcode lock for an admin account
post
Lift password lock for an admin account
post
Change password for an admin account
post
Request password reset for an admin account
post
Update metadata for an admin account
put
Assign multiple roles to an account
post
Clear sessions for an admin account
del
List sessions for an admin account
get
Delete session for an admin account
del
Admin Account Attribute
List admin account attributes
get
Admin Account Event
List admin account events
get
Get an admin account event
get
List descriptors for admin account events
get
List admin notification events
get
Get an admin notification event
get
Admin Account Invitation
List admin account invitations
get
Create an admin account invitation
post
Revoke an admin account invitation
del
Get an admin account invitation
get
Resend an admin account invitation
post
Admin API Security Policy
Get admin API security policy
get
Create a client assignment
post
Delete a client assignment
del
Get a client assignment
get
Update a client assignment
put
Admin Claim
List available native claims
get
List native claim mappings
get
Admin External Login Mapping
List available native claims
get
List claim mappings
get
Create a claim mapping
post
Delete claim mapping
del
Get a claim mapping
get
Update claim mapping
put
Admin External Login Provider
List admin external login providers
get
Create an admin external login provider
post
Delete an admin external login provider
del
Get an admin external login provider
get
Update an admin external login provider
put
Admin Role
List admin roles
get
Create an admin role
post
List scopes
get
Delete an admin role
del
Get an admin role
get
Update an admin role
put
Admin Role Assignee
List role assignees
get
Assign an admin account to a role
post
Remove an admin account from a role
del
Branding Policy
Get admin branding policy
get
Update admin branding policy
put
Custom Adaptive MFA
List custom mfas
get
Create a custom mfa policy
post
Delete a custom mfa
del
Get a custom mfa
get
Update a custom mfa
put
Notification Policy
Get admin notification policy
get
Update admin notification policy
put
Notification Template
Update an admin notification template (email)
put
Update an admin notification template (SMS)
put
List admin notification templates
get
Get an admin notification template
get
Policy Tag
List policy tags
get
Create a policy tag
post
Delete a policy tag
del
Get a policy tag
get
Update a policy tag
put
Tag Based Permission
List tag based permissions
get
Create tag based permissions for an admin role
post
Delete a tag based permission entry
del
Get a tag based permission entry
get
Update a tag based permission entry
put
MyAccount Portal
Authenticator management
Enroll an authenticator
post
Delete an authenticator
del
Update authenticator methods
post
Consent
List consents
get
Accept a consent
post
Revoke a consent
post
Personal Data
Download account information
get
Self Management
List attributes
get
Update identifier
post
List identities
get
Get account information
get
Change password
post
Get account metadata
get
Update metadata
put
Powered by
Native Journey API
Cookie Settings
