Jump to Content
Site Home
Guides
API Reference
Changelog
v1.0
Site Home
Login
Try for Free
API Reference
Login
Try for Free
v1.0
Guides
API Reference
Changelog
Patch Requests
All
Pages
Start typing to search…
JUMP TO
Overview
Introduction To Our APIs
URL Domains
API Authentication
API Authorization
Error Responses
Field-Level Filtering
Patch Requests
Pagination
Query Expressions
Pretty Printing Responses
Authentication APIs
Token
Create Tokens
post
Introspect Token
post
Get JSON Web Keys Set
get
Revoke Token
post
Logout
Logout
get
Discovery
Get OpenID Provider Configuration
get
Login
Authorize
get
User Info
Get User Info
get
Resource Management APIs
Active Tenants
Count Distinct Active Tenants For Application
post
Active Users
Count Distinct Active Users For Application
post
Count Distinct Active Users For Tenant
post
Count Distinct Active Users Grouped By Tenant For Application
post
Applications
Get Application
get
Patch Application
patch
Delete Application
del
Auth Factors
Get Auth Factor
get
Delete Auth Factor
del
Query User Auth Factors
get
Enroll TOTP Auth Factor
post
Verify TOTP Auth Factor Challenge
post
Enroll Recovery Code Auth Factor
post
Verify Recovery Code Auth Factor Challenge
post
Regenerate Recovery Code
post
Auth Sessions
Get Auth Session
get
Delete Auth Session
del
Query User Auth Sessions
get
Delete User Auth Sessions
del
Auth Session Policies
Create Auth Session Policy
post
Get Auth Session Policy
get
Resolve Application Auth Session Policy Overrides
post
Resolve Tenant Auth Session Policy Overrides
post
Create Auth Session Policy Override Toggle
post
Get Auth Session Policy Override Toggle
get
Query Tenant Auth Session Policy Override Toggles
get
Bot Detection Policies
Create Bot Detection Policy
post
Get Bot Detection Policy
get
Resolve Application Bot Detection Policy Overrides
post
Custom Claims
Create Custom Claim
post
Get Custom Claim
get
Patch Custom Claim
patch
Delete Custom Claim
del
Query Application Custom Claims
get
Custom Domains
Create Custom Domain
post
Get Custom Domain
get
Delete Custom Domain
del
Verify Custom Domain
post
Activate Custom Domain
post
Deactivate Custom Domain
post
Query Application Custom Domains
get
Query Tenant Custom Domains
get
Email Brandings
Create Email Branding
post
Get Email Branding
get
Resolve Application Email Branding Overrides
post
Resolve Tenant Email Branding Overrides
post
Create Email Branding Override Toggle
post
Get Email Branding Override Toggle
get
Query Tenant Email Branding Override Toggles
get
Email Domains
Create Email Domain
post
Get Email Domain
get
Delete Email Domain
del
Verify Email Domain
post
Query Application Email Domains
get
Query Tenant Email Domains
get
Email Policies
Create Email Policy
post
Get Email Policy
get
Resolve Application Email Policy Overrides
post
Resolve Tenant Email Policy Overrides
post
Create Email Policy Override Toggle
post
Get Email Policy Override Toggle
get
Query Tenant Email Policy Override Toggles
get
External IdP Profiles
Query User External IdP Profiles
get
Query External IdP Profiles For Authenticated User
get
External IdP Tokens
Query User External IdP Tokens
get
Query External IdP Tokens For Authenticated User
get
Refresh User External IdP Tokens
post
Refresh External IdP Tokens For Authenticated User
post
Identity Providers
Create Identity Provider
post
Get Identity Provider
get
Patch Identity Provider
patch
Delete Identity Provider
del
Query Tenant Identity Providers
get
Resolve Application Identity Provider Overrides
post
Resolve Tenant Identity Provider Overrides
post
Resolve Application Identity Provider Redirect URLs
post
Resolve Tenant Identity Provider Redirect URLs
post
Get Identity Provider SAML 2 Metadata
get
Create Identity Provider Override Toggle
post
Get Identity Provider Override Toggle
get
Query Tenant Identity Provider Override Toggles
get
IdP Attribute Mappings
Create IdP Attribute Mapping
post
Get IdP Attribute Mapping
get
Delete IdP Attribute Mapping
del
Query Identity Provider IdP Attribute Mappings
get
IdP Role Mappings
Create IdP Role Mapping
post
Get IdP Role Mapping
get
Delete IdP Role Mapping
del
Query Identity Provider IdP Role Mappings
get
MFA Policies
Create MFA Policy
post
Get MFA Policy
get
Resolve Application MFA Policy Overrides
post
Resolve Tenant MFA Policy Overrides
post
Create MFA Policy Override Toggle
post
Get MFA Policy Override Toggle
get
Query Tenant MFA Policy Override Toggles
get
OAuth2 Clients
Create Client
post
Get Client
get
Patch Client
patch
Delete Client
del
Query Application Clients
get
Query Tenant Clients
get
Verify Client Secret
post
Rotate Client Secret
post
Delete Secondary Client Secret
post
Page Brandings
Create Page Branding
post
Get Page Branding
get
Resolve Application Page Branding Overrides
post
Resolve Tenant Page Branding Overrides
post
Create Page Branding Override Toggle
post
Get Page Branding Override Toggle
get
Query Tenant Page Branding Override Toggles
get
Password Policies
Create Password Policy
post
Get Password Policy
get
Resolve Application Password Policy Overrides
post
Resolve Tenant Password Policy Overrides
post
Create Password Policy Override Toggle
post
Get Password Policy Override Toggle
get
Query Tenant Password Policy Override Toggles
get
Permissions
Create Permission
post
Get Permission
get
Delete Permission
del
Query Application Permissions
get
Get Permission Info For Subject
get
Get Permissions Assigned to a Role
get
Resolve Assignable Permissions for a Role
post
Assign Permissions to Role
post
Unassign Permissions from Role
post
Get Permissions Assigned to a Permission Group
get
Resolve Assignable Permissions for a Permission Group
post
Assign Permissions to Permission Group
post
Unassign Permissions from Permission Group
post
Permission Boundaries
Create Permission Boundary
post
Get Permission Boundary
get
Patch Permission Boundary
patch
Delete Permission Boundary
del
Query Application Permission Boundaries
get
Resolve Assignable Permission Boundaries for a Role
post
Resolve Assignable Permission Boundaries for a Permission Group
post
Permission Groups
Create Permission Group
post
Get Permission Group
get
Patch Permission Group
patch
Delete Permission Group
del
Query Application Permission Groups
get
Query Tenant Permission Groups
get
Get Permission Groups Assigned to a Role
get
Resolve Assignable Permission Groups for a Role
post
Assign Permission Groups to Role
post
Unassign Permission Groups from Role
post
Refresh Tokens
Revoke Refresh Token
post
Revoke User Refresh Tokens
post
Query User Refresh Tokens
get
Remembered Tenants
Remember Tenant
get
Get Remembered Tenants
get
Delete Remembered Tenant
del
Roles
Create Role
post
Get Role
get
Patch Role
patch
Delete Role
del
Query Application Roles
get
Query Tenant Roles
get
Get Roles Assigned to a User
get
Update User Role Assignments
put
Resolve Assignable Roles for a User
post
Resolve Assigned Roles For Users
post
Assign Roles to User
post
Unassign Roles from User
post
Get Roles Assigned to a Client
get
Update Client Role Assignments
put
Resolve Assignable Roles for a Client
post
Assign Roles to Client
post
Unassign Roles from Client
post
Get Role Assignments
get
Role Assignment Policies
Create Role Assignment Policy
post
Get Role Assignment Policy
get
Resolve Application Role Assignment Policy Overrides
post
Resolve Tenant Role Assignment Policy Overrides
post
Create Role Assignment Policy Override Toggle
post
Get Role Assignment Policy Override Toggle
get
Query Tenant Role Assignment Policy Override Toggles
get
Signing Keys
Rotate Application Signing Keys
post
Get Signing Key
get
Delete Signing Key
del
Query Application Signing Keys
get
Tenants
Create Tenant
post
Get Tenant
get
Patch Tenant
patch
Delete Tenant
del
Query Application Tenants
get
Users
Create User
post
Get User
get
Patch User
patch
Delete User
del
Query Application Users
get
Query Tenant Users
get
User Schemas
Create User Schema
post
Get User Schema
get
Resolve Application User Schema Overrides
post
Resolve Tenant User Schema Overrides
post
Create User Schema Override Toggle
post
Get User Schema Override Toggle
get
Query Tenant User Schema Override Toggles
get
Vanity Domains
Get Application Vanity Domains
get
Get Tenant Vanity Domains
get
Workflow Policies
Create Workflow Policy
post
Get Workflow Policy
get
Resolve Application Workflow Policy Overrides
post
Resolve Tenant Workflow Policy Overrides
post
Create Workflow Policy Override Toggle
post
Get Workflow Policy Override Toggle
get
Query Tenant Workflow Policy Override Toggles
get
Workflow APIs
Change Email
Request Email Change
post
Cancel Email Change
post
Confirm New Email For Password Auth Flow
post
Confirm New Email For Passwordless Email Auth Flow
post
Confirm Current Email For Passwordless Email Auth Flow
post
Authorize External IdP User for Change Email
get
Confirm New Email For External IdP Auth Flow
post
Introspect Change Email Request Email Auth Code
post
Introspect Change Email External IdP Auth Code
post
Get Change Email Request
get
Query Change Email Requests Filtered By User
get
Change Password
Change Password
post
Email Verification
Request Email Verification
post
Verify Email
post
Introspect Email Verification Email Auth Code
post
Get Email Verification Request
get
Existing User Invitation
Invite Existing User
post
Cancel Existing User Invite
post
Accept Existing User Invite
post
Create Auth Session for Existing User Invite
get
Introspect Existing User Invitation Email Auth Code
post
Get Existing User Invitation Request
get
Query Existing User Invitation Requests Filtered By User
get
Login
Verify Password for Login
post
Introspect Authorization Request Token
post
Create Auth Session For Password Login
get
Request Magic Link for Login
post
Verify Magic Link
post
Create Auth Session For Magic Link Login
get
Introspect Magic Link Email Auth Code
post
Authorize External IdP User for Login
get
Fetch External IdP User Info on Login
post
Provision External IdP User on Login
post
Verify User For External IdP Login
post
Verify Email For External IdP Login
post
Resend Email Verification Code For External IdP Login
post
Create Auth Session For External IdP Login
get
Introspect Login External IdP Auth Code
post
Complete External IdP Login
post
Get Magic Link Login Request
get
Get External IdP Login Request
get
MFA Challenge
Verify MFA Challenge
post
Create Auth Session
get
Introspect MFA Challenge Token
post
Get MFA Challenge Request
get
MFA Enrollment
Verify MFA Enrollment
post
Create Auth Session
get
Introspect MFA Enrollment Token
post
Get MFA Enrollment Request
get
New User Invitation
Invite New User
post
Create Invite Link
post
Cancel New User Invite
post
Accept New User Invite
post
Create Auth Session for New User Invite
get
Introspect New User Invitation Token
post
Authorize External IdP User on New User Invitation
get
Fetch External IdP User Info For New User Invitation
post
Accept New User Invitation For External IdP User
post
Introspect New User Invitation External IdP Auth Code
post
Get New User Invitation Request
get
Query New User Invitation Requests Filtered By Application
get
Query New User Invitation Requests Filtered By Tenant
get
Password Reset
Create Password Reset Link
post
Send Password Reset Email
post
Request Password Reset
post
Reset Password
post
Verify Code
post
Cancel Password Reset
post
Create Auth Session for Password Reset
get
Introspect Password Reset Email Auth Code
post
Get Password Reset Request
get
Query Password Reset Requests Filtered By User
get
Signup
Provision Wristband IdP User on Signup
post
Create Auth Session for Wristband IdP User on Signup
get
Authorize External IdP User on Signup
get
Fetch External IdP User Info on Signup
post
Provision External IdP User on Signup
post
Create Auth Session for External IdP User
get
Introspect Signup External IdP Auth Code
post
Get External IdP Signup Request
get
Tenant Discovery
Find User Tenant
post
Fetch Tenants
post
Resolve Tenant Login URL
post
Complete Tenant Discovery
post
Introspect Tenant Discovery Email Auth Code
post
User Activation
Request User Activation
post
Activate User
post
Create Auth Session for Activated User
get
Introspect User Activation Email Auth Code
post
Get User Activation Request
get
Powered by
Patch Requests
Ask AI
Learn how Wristband patch requests work.
