Authaz logoAuthaz
DocumentationAPI Reference
  • Reference

    • API Reference
  • Management - Invitations

    • GET/api/v1/invitations
    • POST/api/v1/invitations
    • GET/api/v1/invitations/pending/count
    • GET/api/v1/invitations/{invitationId}
    • POST/api/v1/invitations/{invitationId}/cancel
  • Management - Tenants

    • GET/api/v1/tenants
    • POST/api/v1/tenants
    • GET/api/v1/tenants/{tenantId}
    • PUT/api/v1/tenants/{tenantId}
    • DELETE/api/v1/tenants/{tenantId}
    • POST/api/v1/tenants/{tenantId}/activate
    • POST/api/v1/tenants/{tenantId}/deactivate
    • GET/api/v1/applications/{appId}/tenants
    • POST/api/v1/applications/{appId}/tenants
    • GET/api/v1/applications/{appId}/tenants/{tenantId}
    • PUT/api/v1/applications/{appId}/tenants/{tenantId}
    • DELETE/api/v1/applications/{appId}/tenants/{tenantId}
    • POST/api/v1/applications/{appId}/tenants/{tenantId}/activate
    • POST/api/v1/applications/{appId}/tenants/{tenantId}/deactivate
  • Authorization - Roles

    • GET/api/v1/authorization/roles
    • POST/api/v1/authorization/roles
    • GET/api/v1/authorization/roles/{roleId}
    • PUT/api/v1/authorization/roles/{roleId}
    • DELETE/api/v1/authorization/roles/{roleId}
    • GET/api/v1/authorization/roles/{roleId}/effective-permissions
    • POST/api/v1/authorization/roles/{roleId}/permissions
    • DELETE/api/v1/authorization/roles/{roleId}/permissions
    • POST/api/v1/authorization/roles/bulk-assign
    • POST/api/v1/authorization/roles/{roleId}/assignments
    • DELETE/api/v1/authorization/roles/{roleId}/members/{userId}
    • GET/api/v1/authorization/roles/users
  • Authorization - Policies

    • GET/api/v1/authorization/policies
    • POST/api/v1/authorization/policies
    • GET/api/v1/authorization/policies/{policyId}
    • PUT/api/v1/authorization/policies/{policyId}
    • DELETE/api/v1/authorization/policies/{policyId}
  • Authorization - Relationships

    • POST/api/v1/authorization/relationships
    • DELETE/api/v1/authorization/relationships
    • POST/api/v1/authorization/relationships/bulk
    • GET/api/v1/authorization/relationships/by-resource
    • GET/api/v1/authorization/relationships/by-user
  • Management - Applications

    • GET/api/v1/applications
    • POST/api/v1/applications
    • GET/api/v1/applications/{appId}
    • PUT/api/v1/applications/{appId}
    • DELETE/api/v1/applications/{appId}
    • GET/api/v1/applications/{appId}/stats
    • GET/api/v1/applications/{appId}/authorization/resources
    • PUT/api/v1/applications/{appId}/authorization/resources
  • m TLS

    • POST/api/v1/m2m/credentials/{credentialId}/certificates
  • Authorization

    • POST/api/v1/authorization/check
    • POST/api/v1/authorization/check-role
    • POST/api/v1/authorization/check-bulk
    • POST/api/v1/authorization/explain
  • Management - API Keys

    • GET/api/v1/applications/{appId}/api-keys
    • POST/api/v1/applications/{appId}/api-keys
    • GET/api/v1/applications/{appId}/api-keys/{keyId}
    • PUT/api/v1/applications/{appId}/api-keys/{keyId}
    • POST/api/v1/applications/{appId}/api-keys/{keyId}/revoke
  • Management - Application API Keys

    • GET/api/v1/applications/{appId}/app-api-keys
    • POST/api/v1/applications/{appId}/app-api-keys
    • GET/api/v1/applications/{appId}/app-api-keys/{keyId}
    • PATCH/api/v1/applications/{appId}/app-api-keys/{keyId}
    • POST/api/v1/applications/{appId}/app-api-keys/{keyId}/revoke
    • POST/api/v1/api-keys/introspect
  • Management - Tenant O Auth

    • GET/api/v1/applications/{appId}/tenants/{tenantId}/oauth
    • GET/api/v1/applications/{appId}/tenants/{tenantId}/oauth/{provider}
    • PUT/api/v1/applications/{appId}/tenants/{tenantId}/oauth/{provider}
  • Management - Custom Domains

    • GET/api/v1/applications/{appId}/custom-domains
    • POST/api/v1/applications/{appId}/custom-domains
    • GET/api/v1/applications/{appId}/custom-domains/{domainId}
    • DELETE/api/v1/applications/{appId}/custom-domains/{domainId}
    • POST/api/v1/applications/{appId}/custom-domains/{domainId}/verify
  • Management - Credentials

    • GET/api/v1/applications/{appId}/credentials
    • POST/api/v1/applications/{appId}/credentials
    • GET/api/v1/applications/{appId}/credentials/{credentialId}
    • PUT/api/v1/applications/{appId}/credentials/{credentialId}
    • DELETE/api/v1/applications/{appId}/credentials/{credentialId}
    • POST/api/v1/applications/{appId}/credentials/{credentialId}/rotate-secret
    • PUT/api/v1/applications/{appId}/credentials/{credentialId}/jwks
    • PUT/api/v1/applications/{appId}/credentials/{credentialId}/jwks-uri
    • PUT/api/v1/applications/{appId}/credentials/{credentialId}/auth-method
  • Management - m TLS

    • GET/api/v1/applications/{appId}/ca-chain
  • Management - Email Provider

    • GET/api/v1/applications/{appId}/email-provider
    • PUT/api/v1/applications/{appId}/email-provider
    • DELETE/api/v1/applications/{appId}/email-provider
  • Management - Email Templates

    • GET/api/v1/applications/{appId}/email-templates
    • POST/api/v1/applications/{appId}/email-templates
    • GET/api/v1/applications/{appId}/email-templates/{templateId}
    • PUT/api/v1/applications/{appId}/email-templates/{templateId}
    • DELETE/api/v1/applications/{appId}/email-templates/{templateId}
    • GET/api/v1/applications/{appId}/tenants/{tenantId}/email-templates
    • POST/api/v1/applications/{appId}/tenants/{tenantId}/email-templates
    • GET/api/v1/applications/{appId}/tenants/{tenantId}/email-templates/{templateId}
    • PUT/api/v1/applications/{appId}/tenants/{tenantId}/email-templates/{templateId}
    • DELETE/api/v1/applications/{appId}/tenants/{tenantId}/email-templates/{templateId}
  • Management - Account Recovery

    • GET/api/v1/applications/{appId}/account-recovery/pending
    • POST/api/v1/applications/{appId}/account-recovery/{recoveryId}/approve
    • POST/api/v1/applications/{appId}/account-recovery/{recoveryId}/deny
  • Management - Configuration

    • POST/api/v1/applications/diff
    • POST/api/v1/applications/apply
    • POST/api/v1/applications/validate
    • GET/api/v1/applications/{appId}/export
    • POST/api/v1/applications/config/authorization/validate
    • PUT/api/v1/applications/config/authorization
  • Management - Debug

    • POST/api/v1/debug/introspect
  • Management - SAML Connections

    • GET/api/v1/applications/{appId}/saml-connections
    • POST/api/v1/applications/{appId}/saml-connections
    • GET/api/v1/applications/{appId}/saml-connections/{connectionId}
    • PATCH/api/v1/applications/{appId}/saml-connections/{connectionId}
    • DELETE/api/v1/applications/{appId}/saml-connections/{connectionId}
  • Management - Auth

    • POST/api/v1/auth/switch-organization
  • Management - M2 M Credentials

    • GET/api/v1/m2m-credentials
    • POST/api/v1/m2m-credentials
    • DELETE/api/v1/m2m-credentials/{credentialId}
  • Management - Users

    • GET/api/v1/users
    • GET/api/v1/users/{userId}
    • DELETE/api/v1/users/{userId}
    • POST/api/v1/users/{userId}/suspend
    • POST/api/v1/users/{userId}/activate
    • POST/api/v1/users/{userId}/unlock
    • POST/api/v1/users/{userId}/sessions/revoke
    • DELETE/api/v1/users/{userId}/sessions/{sessionId}
    • GET/api/v1/users/{userId}/roles
    • POST/api/v1/users/{userId}/mfa/reset
    • GET/api/v1/users/{userId}/activity
    • GET/api/v1/users/{userId}/sessions
    • GET/api/v1/users/{userId}/security
  • Management - Branding

    • GET/api/v1/applications/{appId}/branding
    • PUT/api/v1/applications/{appId}/branding
  • Management - Auth Flow

    • GET/api/v1/applications/{appId}/auth-flow
    • PUT/api/v1/applications/{appId}/auth-flow
  • Management - M2 M Certificates

    • GET/api/v1/m2m/credentials/{credentialId}/certificates
    • POST/api/v1/m2m/credentials/{credentialId}/certificates/{certificateId}/disable
  • Management - Policies

    • GET/api/v1/policies/mfa
    • PUT/api/v1/policies/mfa
    • DELETE/api/v1/policies/mfa
    • GET/api/v1/policies/password
    • PUT/api/v1/policies/password
    • DELETE/api/v1/policies/password
    • GET/api/v1/policies/session
    • PUT/api/v1/policies/session
    • DELETE/api/v1/policies/session
    • GET/api/v1/policies/account-lockout
    • PUT/api/v1/policies/account-lockout
    • DELETE/api/v1/policies/account-lockout
    • GET/api/v1/applications/{appId}/policies/mfa
    • PUT/api/v1/applications/{appId}/policies/mfa
    • DELETE/api/v1/applications/{appId}/policies/mfa
    • GET/api/v1/applications/{appId}/policies/password
    • PUT/api/v1/applications/{appId}/policies/password
    • DELETE/api/v1/applications/{appId}/policies/password
    • GET/api/v1/applications/{appId}/policies/session
    • PUT/api/v1/applications/{appId}/policies/session
    • DELETE/api/v1/applications/{appId}/policies/session
    • GET/api/v1/applications/{appId}/policies/account-lockout
    • PUT/api/v1/applications/{appId}/policies/account-lockout
    • DELETE/api/v1/applications/{appId}/policies/account-lockout
  • Management - Config

    • GET/api/v1/applications/{appId}/config/password/invitation
    • PUT/api/v1/applications/{appId}/config/password/invitation
    • GET/api/v1/applications/{appId}/config/oauth
    • GET/api/v1/applications/{appId}/config/oauth/{providerName}
    • PUT/api/v1/applications/{appId}/config/oauth/{providerName}
    • DELETE/api/v1/applications/{appId}/config/oauth/{providerName}
    • GET/api/v1/applications/{appId}/config/oauth/{providerName}/signup
    • PUT/api/v1/applications/{appId}/config/oauth/{providerName}/signup
    • GET/api/v1/applications/{appId}/config/magic-link/signup
    • PUT/api/v1/applications/{appId}/config/magic-link/signup
    • GET/api/v1/applications/{appId}/config/magic-link/invitation
    • PUT/api/v1/applications/{appId}/config/magic-link/invitation
    • GET/api/v1/applications/{appId}/config/m2m
    • PUT/api/v1/applications/{appId}/config/m2m
    • GET/api/v1/applications/{appId}/config/signup
    • PUT/api/v1/applications/{appId}/config/signup
    • GET/api/v1/applications/{appId}/config/invitation
    • PUT/api/v1/applications/{appId}/config/invitation
    • GET/api/v1/applications/{appId}/config/providers
    • GET/api/v1/applications/{appId}/config/email-password
    • PUT/api/v1/applications/{appId}/config/email-password
    • GET/api/v1/applications/{appId}/config/magic-link/auth
    • PUT/api/v1/applications/{appId}/config/magic-link/auth
    • GET/api/v1/applications/{appId}/config/passkey/auth
    • PUT/api/v1/applications/{appId}/config/passkey/auth
    • GET/api/v1/applications/{appId}/config/impersonation
    • PUT/api/v1/applications/{appId}/config/impersonation
    • GET/api/v1/applications/{appId}/config/api-key
    • PUT/api/v1/applications/{appId}/config/api-key
    • GET/api/v1/applications/{appId}/config/cli
    • PUT/api/v1/applications/{appId}/config/cli
  • Management - Trail Logs

    • GET/api/v1/trail-logs
  • Management - Support

    • POST/api/v1/feedback
    • POST/api/v1/support
  • Validate Session

    • POST/api/v1/sessions/validate
  • JWKS

    • GET/api/.well-known/jwks/applications/{applicationId}.json
  • Browser Logs

    • POST/api/logs
  • Bootstrap2

    • POST/api/v1/bootstrap
  • Bootstrap Production

    • POST/api/v1/bootstrap/production
  • Dashboard App Key Backfill

    • POST/api/v1/bootstrap/dashboard-app-key
  • Age Verification

    • POST/api/v1/age-verification
  • Tenant Auth Config

    • GET/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/email-password
    • PUT/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/email-password
    • GET/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/magic-link
    • PUT/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/magic-link
    • GET/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/oauth
    • GET/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/oauth/{providerName}
    • PUT/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/oauth/{providerName}
    • DELETE/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/oauth/{providerName}
    • GET/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/signup
    • PUT/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/signup
    • GET/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/invitation
    • PUT/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/invitation
  • Tenant Policies

    • GET/api/v1/applications/{appId}/tenants/{tenantId}/policies/mfa
    • PUT/api/v1/applications/{appId}/tenants/{tenantId}/policies/mfa
    • DELETE/api/v1/applications/{appId}/tenants/{tenantId}/policies/mfa
    • GET/api/v1/applications/{appId}/tenants/{tenantId}/policies/session
    • PUT/api/v1/applications/{appId}/tenants/{tenantId}/policies/session
    • DELETE/api/v1/applications/{appId}/tenants/{tenantId}/policies/session
    • GET/api/v1/applications/{appId}/tenants/{tenantId}/policies/account-lockout
    • PUT/api/v1/applications/{appId}/tenants/{tenantId}/policies/account-lockout
    • DELETE/api/v1/applications/{appId}/tenants/{tenantId}/policies/account-lockout
  • Branding

    • GET/api/v1/applications/{appId}/tenants/{tenantId}/branding
    • PUT/api/v1/applications/{appId}/tenants/{tenantId}/branding
    • DELETE/api/v1/applications/{appId}/tenants/{tenantId}/branding
  • Email Provider

    • GET/api/v1/applications/{appId}/tenants/{tenantId}/email-provider
    • PUT/api/v1/applications/{appId}/tenants/{tenantId}/email-provider
    • DELETE/api/v1/applications/{appId}/tenants/{tenantId}/email-provider
  1. Authaz
  2. Docs
  3. Reference
  4. API Reference

Reference

API Reference

4 min read·Updated Jun 19, 2026

The Authaz Management API is the same surface the dashboard uses. Every endpoint is documented in the interactive reference (rendered from our OpenAPI spec). This page covers how to authenticate and what's where.

Your first call#

curl https://your-app.authaz.io/api/v1/users \
  -H "X-API-Key: $AUTHAZ_API_KEY"

A 200 returns the first page of users — a data array plus a next cursor (see Pagination below). A 401 means the key is wrong. A 403 means it's valid but lacks the required permission. The interactive reference has the exact response schema for every endpoint.

Authentication#

Two methods work on every endpoint. Pick whichever fits the caller.

X-API-Key (Management API key)#

Long-lived keys generated in the dashboard. The default for backend services and CI:

curl https://your-app.authaz.io/api/v1/users \
  -H "X-API-Key: mgmt_01h..."

API keys are scoped to one application and (optionally) one tenant. They can also be restricted by permission — give your CI a key that can only users:read, not users:delete.

Authorization: Bearer (JWT)#

Use a user's access token to act as that user:

curl https://your-app.authaz.io/api/v1/users \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..."

Every endpoint enforces both API-key permissions and the user's permissions. This is what powers customer-facing dashboards: a single Management API key, plus a per-user Bearer token, gives the user exactly their own slice.

You can send both headers at once. The API key is the authentication; the Bearer adds tenant scoping and per-user permission narrowing on top.

Tenant scoping#

Tenant scope comes from one of three places, in order of precedence:

  1. The path. /applications/{appId}/tenants/{tenantId}/... always scopes to that tenant.
  2. The Bearer token. A user JWT with a tenant_id claim auto-scopes the call.
  3. The API key. Tenant-scoped API keys carry their tenant in their stored metadata.

You'll never see a ?tenantId= query parameter. If a path doesn't include /tenants/{tenantId}/, scope comes from the credentials.

Sections#

The OpenAPI spec groups endpoints into the categories below. Click through to the interactive browser to see every method, schema, and example response.

Identity#

SectionWhat's inside
OrganizationsRead your organization, manage billing settings, deactivate.
ApplicationsCRUD applications, stats, custom domains, branding.
TenantsCRUD tenants and per-tenant configuration.
UsersList, get, suspend, activate, unlock, delete, MFA reset, session listing.

Authentication & authorization#

SectionWhat's inside
Auth ProvidersPer-application config for password, OAuth, magic link, M2M, API keys, passkey.
RolesDefine roles and their permissions, per application or per tenant.
PermissionsAuthorization checks: check, bulk-check, role checks, listings.
Role AssignmentsAssign and revoke roles for users (and credentials, and API keys).
PoliciesPassword policy, MFA policy, session policy, account-lockout policy.

Access credentials#

SectionWhat's inside
Credentials (M2M)Create, rotate, revoke OAuth client-credential pairs and JWKS uploads.
API KeysUser-bound keys, standalone keys, introspection, rotation, revocation.

Operations#

SectionWhat's inside
InvitationsSend, list, resend, revoke invitations.
BrandingLogo, colors, copy overrides for Authaz Sign-In.
EmailEmail-provider config (Resend / SES) and per-flow templates.
SessionsValidate, list, revoke active user sessions.
Trail Logs (Audit)Search and stream audit events.
AnalyticsActive user counts, sign-in stats, MFA adoption.

OAuth 2.0 / OIDC#

EndpointWhat it does
GET /.well-known/openid-configurationDiscovery metadata.
GET /.well-known/jwks.jsonPublic keys for token verification.
GET /oauth2/authorizeStart the auth code flow.
POST /oauth2/tokenExchange code, refresh, or run client credentials.
POST /oauth2/revokeRevoke a refresh token.
GET /oauth2/userinfoOIDC userinfo claims.
POST /oauth2/device_authorizationDevice-code flow for CLIs and TVs.

Conventions#

  • IDs — all resource IDs are UUIDv7 strings. They sort lexically by creation time.
  • Idempotency — destructive operations (delete, revoke) accept an Idempotency-Key header. Pair with a UUID for safe retries.
  • Rate limits — every response carries X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset. 429s come with Retry-After (in seconds).

Pagination#

List endpoints use pageSize (default 20, max 100) and a cursor from the previous response's next field.

# First page
curl "https://your-app.authaz.io/api/v1/users?pageSize=50" \
  -H "X-API-Key: mgmt_01h..."
{
  "data": [ /* up to 50 records */ ],
  "next": "eyJjcmVhdGVkQXQiOiIyMDI1LTA0LTAxVDE1OjMyOjAwWiJ9"
}
# Next page — pass the cursor verbatim
curl "https://your-app.authaz.io/api/v1/users?cursor=eyJjcmVhdGVkQXQiOiIyMDI1LTA0LTAxVDE1OjMyOjAwWiJ9" \
  -H "X-API-Key: mgmt_01h..."

When next is null or absent, you've reached the end. Cursors are opaque — don't decode or construct them yourself; treat them as string.

Errors#

Every error response has the same shape:

{
  "code": "validation_error",
  "message": "email is required",
  "field": "email"
}

field is set on validation errors and points to the offending input. The HTTP status reflects the class:

StatusClassTypical cause
401UnauthenticatedMissing or invalid credentials
403ForbiddenCredentials valid; lack the required permission or wrong tenant
404Not foundResource doesn't exist or is scoped to another tenant
409ConflictDuplicate resource (e.g. user with that email already exists)
422Validationfield names the offending input
429Rate-limitedRetry after the seconds in Retry-After
5xxServerSafe to retry idempotent calls with backoff

Versioning#

The API is versioned in the URL: /api/v1/.... Breaking changes ship in a new version (/api/v2/...); the old version stays alive for at least 12 months. Non-breaking changes (new fields, new endpoints, new optional parameters) ship continuously and don't bump the version.

Next steps#

  • Quickstart — cURL — try the OAuth flow against the API.
  • Quickstart — .NET — typed client for the Management API.
  • Multi-tenancy — tenant-scoped variants of the endpoints above.

OpenAPI

Authaz | v1

v1.0.0226 endpoints
Surfaces
Auth server
https://your-app.authaz.io

OAuth, OIDC, SAML, discovery, and login endpoints.

API
https://your-app.authaz.io/api/v1

REST endpoints generated from the OpenAPI paths.

Servers
Production
https://your-app.authaz.io
Authentication
X-API-Key

Request authentication is configured in the project API settings.

Management - Invitations

GET/api/v1/invitations
operationId: Management_ListInvitationstag: Management - InvitationsProduction: https://your-app.authaz.io

Query Parameters

Cursorstring
PageSizestring
Statestring
Request
GET /api/v1/invitations HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/invitations'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/invitations
operationId: Management_SendInvitationtag: Management - InvitationsProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/invitations HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/invitations' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/invitations/pending/count
operationId: Management_GetPendingInvitationsCounttag: Management - InvitationsProduction: https://your-app.authaz.io
Request
GET /api/v1/invitations/pending/count HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/invitations/pending/count'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/invitations/{invitationId}
operationId: Management_GetInvitationtag: Management - InvitationsProduction: https://your-app.authaz.io

Path Parameters

invitationIdstringrequired
Request
GET /api/v1/invitations/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/invitations/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/invitations/{invitationId}/cancel
operationId: Management_CancelInvitationtag: Management - InvitationsProduction: https://your-app.authaz.io

Path Parameters

invitationIdstringrequired
Request
POST /api/v1/invitations//cancel HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/invitations//cancel'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Tenants

GET/api/v1/tenants
operationId: Management_ListTenantstag: Management - TenantsProduction: https://your-app.authaz.io

Query Parameters

Cursorstring
PageSizestring
Searchstring
Statusstring
Request
GET /api/v1/tenants HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/tenants'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/tenants
operationId: Management_CreateTenanttag: Management - TenantsProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/tenants HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/tenants' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/tenants/{tenantId}
operationId: Management_GetTenanttag: Management - TenantsProduction: https://your-app.authaz.io

Path Parameters

tenantIdstringrequired
Request
GET /api/v1/tenants/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/tenants/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/tenants/{tenantId}
operationId: Management_UpdateTenanttag: Management - TenantsProduction: https://your-app.authaz.io

Path Parameters

tenantIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/tenants/ HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/tenants/' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/tenants/{tenantId}
operationId: Management_DeleteTenanttag: Management - TenantsProduction: https://your-app.authaz.io

Path Parameters

tenantIdstringrequired
Request
DELETE /api/v1/tenants/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/tenants/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/tenants/{tenantId}/activate
operationId: Management_ActivateTenanttag: Management - TenantsProduction: https://your-app.authaz.io

Path Parameters

tenantIdstringrequired
Request
POST /api/v1/tenants//activate HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/tenants//activate'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/tenants/{tenantId}/deactivate
operationId: Management_DeactivateTenanttag: Management - TenantsProduction: https://your-app.authaz.io

Path Parameters

tenantIdstringrequired
Request
POST /api/v1/tenants//deactivate HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/tenants//deactivate'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/tenants
operationId: Management_ListAppTenantstag: Management - TenantsProduction: https://your-app.authaz.io

Query Parameters

Cursorstring
PageSizestring
Searchstring
Statusstring
Request
GET /api/v1/applications/{appId}/tenants HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications/{appId}/tenants'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/tenants
operationId: Management_CreateAppTenanttag: Management - TenantsProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/applications/{appId}/tenants HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications/{appId}/tenants' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/tenants/{tenantId}
operationId: Management_GetAppTenanttag: Management - TenantsProduction: https://your-app.authaz.io

Path Parameters

tenantIdstringrequired
Request
GET /api/v1/applications/{appId}/tenants/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications/{appId}/tenants/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/tenants/{tenantId}
operationId: Management_UpdateAppTenanttag: Management - TenantsProduction: https://your-app.authaz.io

Path Parameters

tenantIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications/{appId}/tenants/ HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications/{appId}/tenants/' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/tenants/{tenantId}
operationId: Management_DeleteAppTenanttag: Management - TenantsProduction: https://your-app.authaz.io

Path Parameters

tenantIdstringrequired
Request
DELETE /api/v1/applications/{appId}/tenants/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications/{appId}/tenants/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/tenants/{tenantId}/activate
operationId: Management_ActivateAppTenanttag: Management - TenantsProduction: https://your-app.authaz.io

Path Parameters

tenantIdstringrequired
Request
POST /api/v1/applications/{appId}/tenants//activate HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications/{appId}/tenants//activate'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/tenants/{tenantId}/deactivate
operationId: Management_DeactivateAppTenanttag: Management - TenantsProduction: https://your-app.authaz.io

Path Parameters

tenantIdstringrequired
Request
POST /api/v1/applications/{appId}/tenants//deactivate HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications/{appId}/tenants//deactivate'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Authorization - Roles

GET/api/v1/authorization/roles
operationId: Authorization_ListRolestag: Authorization - RolesProduction: https://your-app.authaz.io

Query Parameters

tenantIdstring
pageSizestring
pageNumberstring
Request
GET /api/v1/authorization/roles HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/authorization/roles'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/authorization/roles
operationId: Authorization_CreateRoletag: Authorization - RolesProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/authorization/roles HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/authorization/roles' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/authorization/roles/{roleId}
operationId: Authorization_GetRoletag: Authorization - RolesProduction: https://your-app.authaz.io

Path Parameters

roleIdstringrequired
Request
GET /api/v1/authorization/roles/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/authorization/roles/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/authorization/roles/{roleId}
operationId: Authorization_UpdateRoletag: Authorization - RolesProduction: https://your-app.authaz.io

Path Parameters

roleIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/authorization/roles/ HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/authorization/roles/' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/authorization/roles/{roleId}
operationId: Authorization_DeleteRoletag: Authorization - RolesProduction: https://your-app.authaz.io

Path Parameters

roleIdstringrequired
Request
DELETE /api/v1/authorization/roles/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/authorization/roles/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/authorization/roles/{roleId}/effective-permissions
operationId: Authorization_GetEffectivePermissionstag: Authorization - RolesProduction: https://your-app.authaz.io

Path Parameters

roleIdstringrequired
Request
GET /api/v1/authorization/roles//effective-permissions HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/authorization/roles//effective-permissions'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/authorization/roles/{roleId}/permissions
operationId: Authorization_AddPermissionToRoletag: Authorization - RolesProduction: https://your-app.authaz.io

Path Parameters

roleIdstringrequired

Request Body

application/jsonrequired
{}
Request
POST /api/v1/authorization/roles//permissions HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/authorization/roles//permissions' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/authorization/roles/{roleId}/permissions
operationId: Authorization_RemovePermissionFromRoletag: Authorization - RolesProduction: https://your-app.authaz.io

Path Parameters

roleIdstringrequired

Query Parameters

permissionstringrequired
Request
DELETE /api/v1/authorization/roles//permissions HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/authorization/roles//permissions'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/authorization/roles/bulk-assign
operationId: Authorization_BulkAssignRolestag: Authorization - RolesProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/authorization/roles/bulk-assign HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/authorization/roles/bulk-assign' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/authorization/roles/{roleId}/assignments
operationId: Authorization_AssignRoletag: Authorization - RolesProduction: https://your-app.authaz.io

Path Parameters

roleIdstringrequired

Request Body

application/jsonrequired
{}
Request
POST /api/v1/authorization/roles//assignments HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/authorization/roles//assignments' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/authorization/roles/{roleId}/members/{userId}
operationId: Authorization_UnassignRoletag: Authorization - RolesProduction: https://your-app.authaz.io

Path Parameters

roleIdstringrequired
userIdstringrequired

Query Parameters

tenantIdstring
Request
DELETE /api/v1/authorization/roles//members/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/authorization/roles//members/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/authorization/roles/users
operationId: Authorization_GetUsersWithRolestag: Authorization - RolesProduction: https://your-app.authaz.io

Query Parameters

tenantIdstring
Request
GET /api/v1/authorization/roles/users HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/authorization/roles/users'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Authorization - Policies

GET/api/v1/authorization/policies
operationId: Authorization_ListPoliciestag: Authorization - PoliciesProduction: https://your-app.authaz.io
Request
GET /api/v1/authorization/policies HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/authorization/policies'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/authorization/policies
operationId: Authorization_CreatePolicytag: Authorization - PoliciesProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/authorization/policies HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/authorization/policies' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/authorization/policies/{policyId}
operationId: Authorization_GetPolicytag: Authorization - PoliciesProduction: https://your-app.authaz.io

Path Parameters

policyIdstringrequired
Request
GET /api/v1/authorization/policies/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/authorization/policies/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/authorization/policies/{policyId}
operationId: Authorization_UpdatePolicytag: Authorization - PoliciesProduction: https://your-app.authaz.io

Path Parameters

policyIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/authorization/policies/ HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/authorization/policies/' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/authorization/policies/{policyId}
operationId: Authorization_DeletePolicytag: Authorization - PoliciesProduction: https://your-app.authaz.io

Path Parameters

policyIdstringrequired
Request
DELETE /api/v1/authorization/policies/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/authorization/policies/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Authorization - Relationships

POST/api/v1/authorization/relationships
operationId: Authorization_WriteRelationshiptag: Authorization - RelationshipsProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/authorization/relationships HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/authorization/relationships' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/authorization/relationships
operationId: Authorization_DeleteRelationshiptag: Authorization - RelationshipsProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
DELETE /api/v1/authorization/relationships HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/authorization/relationships'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/authorization/relationships/bulk
operationId: Authorization_BulkWriteRelationshipstag: Authorization - RelationshipsProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/authorization/relationships/bulk HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/authorization/relationships/bulk' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/authorization/relationships/by-resource
operationId: Authorization_ListResourceGrantstag: Authorization - RelationshipsProduction: https://your-app.authaz.io

Query Parameters

resourcestringrequired
resourceIdstringrequired
actionstring
tenantIdstring
Request
GET /api/v1/authorization/relationships/by-resource HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/authorization/relationships/by-resource'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/authorization/relationships/by-user
operationId: Authorization_ListUserGrantstag: Authorization - RelationshipsProduction: https://your-app.authaz.io

Query Parameters

userTypestringrequired
userIdstringrequired
resourcestring
tenantIdstring
Request
GET /api/v1/authorization/relationships/by-user HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/authorization/relationships/by-user'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Applications

GET/api/v1/applications
operationId: Management_ListApplicationstag: Management - ApplicationsProduction: https://your-app.authaz.io

Query Parameters

Cursorstring
PageSizestring
Namestring
Request
GET /api/v1/applications HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications
operationId: Management_CreateApplicationtag: Management - ApplicationsProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/applications HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}
operationId: Management_GetApplicationtag: Management - ApplicationsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}
operationId: Management_UpdateApplicationtag: Management - ApplicationsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications/ HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications/' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}
operationId: Management_DeleteApplicationtag: Management - ApplicationsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
DELETE /api/v1/applications/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/stats
operationId: Management_GetApplicationStatstag: Management - ApplicationsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//stats HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//stats'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/authorization/resources
operationId: Management_GetApplicationAuthorizationResourcestag: Management - ApplicationsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//authorization/resources HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//authorization/resources'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/authorization/resources
operationId: Management_UpdateApplicationAuthorizationResourcestag: Management - ApplicationsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//authorization/resources HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//authorization/resources' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

mTLS

POST/api/v1/m2m/credentials/{credentialId}/certificates
operationId: IssueM2MCertificatetag: mTLSProduction: https://your-app.authaz.io

Path Parameters

credentialIdstringrequired

Request Body

application/jsonoptional
{}
Request
POST /api/v1/m2m/credentials//certificates HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/m2m/credentials//certificates' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Authorization

POST/api/v1/authorization/check
operationId: Authorization_CheckPermissiontag: AuthorizationProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/authorization/check HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/authorization/check' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/authorization/check-role
operationId: Authorization_CheckRoletag: AuthorizationProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/authorization/check-role HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/authorization/check-role' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/authorization/check-bulk
operationId: Authorization_CheckBulktag: AuthorizationProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/authorization/check-bulk HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/authorization/check-bulk' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/authorization/explain
operationId: Authorization_Explaintag: AuthorizationProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/authorization/explain HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/authorization/explain' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - API Keys

GET/api/v1/applications/{appId}/api-keys
operationId: Management_ListApiKeystag: Management - API KeysProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//api-keys HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//api-keys'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/api-keys
operationId: Management_CreateApiKeytag: Management - API KeysProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
POST /api/v1/applications//api-keys HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications//api-keys' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/api-keys/{keyId}
operationId: Management_GetApiKeytag: Management - API KeysProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
keyIdstringrequired
Request
GET /api/v1/applications//api-keys/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//api-keys/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/api-keys/{keyId}
operationId: Management_UpdateApiKeytag: Management - API KeysProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
keyIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//api-keys/ HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//api-keys/' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/api-keys/{keyId}/revoke
operationId: Management_RevokeApiKeytag: Management - API KeysProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
keyIdstringrequired

Request Body

application/jsonoptional
{}
Request
POST /api/v1/applications//api-keys//revoke HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications//api-keys//revoke' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Application API Keys

GET/api/v1/applications/{appId}/app-api-keys
operationId: Management_ListAppApiKeystag: Management - Application API KeysProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Query Parameters

tenantIdstring
Request
GET /api/v1/applications//app-api-keys HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//app-api-keys'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/app-api-keys
operationId: Management_CreateAppApiKeytag: Management - Application API KeysProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
POST /api/v1/applications//app-api-keys HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications//app-api-keys' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/app-api-keys/{keyId}
operationId: Management_GetAppApiKeytag: Management - Application API KeysProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
keyIdstringrequired
Request
GET /api/v1/applications//app-api-keys/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//app-api-keys/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PATCH/api/v1/applications/{appId}/app-api-keys/{keyId}
operationId: Management_UpdateAppApiKeytag: Management - Application API KeysProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
keyIdstringrequired

Request Body

application/jsonrequired
{}
Request
PATCH /api/v1/applications//app-api-keys/ HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PATCH 'https://your-app.authaz.io/api/v1/applications//app-api-keys/' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/app-api-keys/{keyId}/revoke
operationId: Management_RevokeAppApiKeytag: Management - Application API KeysProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
keyIdstringrequired

Request Body

application/jsonoptional
{}
Request
POST /api/v1/applications//app-api-keys//revoke HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications//app-api-keys//revoke' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/api-keys/introspect
operationId: Management_IntrospectAppApiKeytag: Management - Application API KeysProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/api-keys/introspect HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/api-keys/introspect' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Tenant OAuth

GET/api/v1/applications/{appId}/tenants/{tenantId}/oauth
operationId: Management_ListTenantOAuthProviderstag: Management - Tenant OAuthProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
GET /api/v1/applications//tenants//oauth HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//oauth'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/tenants/{tenantId}/oauth/{provider}
operationId: Management_GetTenantOAuthProvidertag: Management - Tenant OAuthProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
providerstringrequired
Request
GET /api/v1/applications//tenants//oauth/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//oauth/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/tenants/{tenantId}/oauth/{provider}
operationId: Management_ConfigureTenantOAuthtag: Management - Tenant OAuthProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
providerstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//tenants//oauth/ HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//tenants//oauth/' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Custom Domains

GET/api/v1/applications/{appId}/custom-domains
operationId: Management_ListCustomDomainstag: Management - Custom DomainsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//custom-domains HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//custom-domains'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/custom-domains
operationId: Management_CreateCustomDomaintag: Management - Custom DomainsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
POST /api/v1/applications//custom-domains HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications//custom-domains' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/custom-domains/{domainId}
operationId: Management_GetCustomDomaintag: Management - Custom DomainsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
domainIdstringrequired
Request
GET /api/v1/applications//custom-domains/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//custom-domains/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/custom-domains/{domainId}
operationId: Management_DeleteCustomDomaintag: Management - Custom DomainsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
domainIdstringrequired
Request
DELETE /api/v1/applications//custom-domains/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications//custom-domains/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/custom-domains/{domainId}/verify
operationId: Management_VerifyCustomDomaintag: Management - Custom DomainsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
domainIdstringrequired
Request
POST /api/v1/applications//custom-domains//verify HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications//custom-domains//verify'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Credentials

GET/api/v1/applications/{appId}/credentials
operationId: Management_ListCredentialstag: Management - CredentialsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//credentials HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//credentials'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/credentials
operationId: Management_CreateCredentialtag: Management - CredentialsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
POST /api/v1/applications//credentials HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications//credentials' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/credentials/{credentialId}
operationId: Management_GetCredentialtag: Management - CredentialsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
credentialIdstringrequired
Request
GET /api/v1/applications//credentials/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//credentials/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/credentials/{credentialId}
operationId: Management_UpdateCredentialtag: Management - CredentialsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
credentialIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//credentials/ HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//credentials/' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/credentials/{credentialId}
operationId: Management_DeleteCredentialtag: Management - CredentialsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
credentialIdstringrequired
Request
DELETE /api/v1/applications//credentials/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications//credentials/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/credentials/{credentialId}/rotate-secret
operationId: Management_RotateCredentialSecrettag: Management - CredentialsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
credentialIdstringrequired
Request
POST /api/v1/applications//credentials//rotate-secret HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications//credentials//rotate-secret'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/credentials/{credentialId}/jwks
operationId: Management_UpdateCredentialJwkstag: Management - CredentialsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
credentialIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//credentials//jwks HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//credentials//jwks' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/credentials/{credentialId}/jwks-uri
operationId: Management_UpdateCredentialJwksUritag: Management - CredentialsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
credentialIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//credentials//jwks-uri HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//credentials//jwks-uri' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/credentials/{credentialId}/auth-method
operationId: Management_UpdateCredentialAuthMethodtag: Management - CredentialsProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
credentialIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//credentials//auth-method HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//credentials//auth-method' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - mTLS

GET/api/v1/applications/{appId}/ca-chain
operationId: Management_GetApplicationCaChaintag: Management - mTLSProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//ca-chain HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//ca-chain'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Email Provider

GET/api/v1/applications/{appId}/email-provider
operationId: Management_GetEmailProvidertag: Management - Email ProviderProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//email-provider HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//email-provider'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/email-provider
operationId: Management_UpdateEmailProvidertag: Management - Email ProviderProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//email-provider HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//email-provider' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/email-provider
operationId: Management_DeleteEmailProvidertag: Management - Email ProviderProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
DELETE /api/v1/applications//email-provider HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications//email-provider'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Email Templates

GET/api/v1/applications/{appId}/email-templates
operationId: Management_ListEmailTemplatestag: Management - Email TemplatesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//email-templates HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//email-templates'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/email-templates
operationId: Management_CreateEmailTemplatetag: Management - Email TemplatesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
POST /api/v1/applications//email-templates HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications//email-templates' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/email-templates/{templateId}
operationId: Management_GetEmailTemplatetag: Management - Email TemplatesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
templateIdstringrequired
Request
GET /api/v1/applications//email-templates/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//email-templates/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/email-templates/{templateId}
operationId: Management_UpdateEmailTemplatetag: Management - Email TemplatesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
templateIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//email-templates/ HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//email-templates/' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/email-templates/{templateId}
operationId: Management_DeleteEmailTemplatetag: Management - Email TemplatesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
templateIdstringrequired
Request
DELETE /api/v1/applications//email-templates/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications//email-templates/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/tenants/{tenantId}/email-templates
operationId: Management_ListTenantEmailTemplatestag: Management - Email TemplatesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
GET /api/v1/applications//tenants//email-templates HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//email-templates'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/tenants/{tenantId}/email-templates
operationId: Management_CreateTenantEmailTemplatetag: Management - Email TemplatesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired

Request Body

application/jsonrequired
{}
Request
POST /api/v1/applications//tenants//email-templates HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications//tenants//email-templates' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/tenants/{tenantId}/email-templates/{templateId}
operationId: Management_GetTenantEmailTemplatetag: Management - Email TemplatesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
templateIdstringrequired
Request
GET /api/v1/applications//tenants//email-templates/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//email-templates/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/tenants/{tenantId}/email-templates/{templateId}
operationId: Management_UpdateTenantEmailTemplatetag: Management - Email TemplatesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
templateIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//tenants//email-templates/ HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//tenants//email-templates/' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/tenants/{tenantId}/email-templates/{templateId}
operationId: Management_DeleteTenantEmailTemplatetag: Management - Email TemplatesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
templateIdstringrequired
Request
DELETE /api/v1/applications//tenants//email-templates/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications//tenants//email-templates/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Account Recovery

GET/api/v1/applications/{appId}/account-recovery/pending
operationId: Management_ListPendingRecoveriestag: Management - Account RecoveryProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//account-recovery/pending HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//account-recovery/pending'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/account-recovery/{recoveryId}/approve
operationId: Management_ApproveRecoverytag: Management - Account RecoveryProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
recoveryIdstringrequired
Request
POST /api/v1/applications//account-recovery//approve HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications//account-recovery//approve'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/account-recovery/{recoveryId}/deny
operationId: Management_DenyRecoverytag: Management - Account RecoveryProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
recoveryIdstringrequired

Request Body

application/jsonoptional
{}
Request
POST /api/v1/applications//account-recovery//deny HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications//account-recovery//deny' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Configuration

POST/api/v1/applications/diff
operationId: Management_ConfigDifftag: Management - ConfigurationProduction: https://your-app.authaz.io
Request
POST /api/v1/applications/diff HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications/diff'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/apply
operationId: Management_ConfigApplytag: Management - ConfigurationProduction: https://your-app.authaz.io
Request
POST /api/v1/applications/apply HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications/apply'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/validate
operationId: Management_ConfigValidatetag: Management - ConfigurationProduction: https://your-app.authaz.io
Request
POST /api/v1/applications/validate HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications/validate'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/export
operationId: Management_ConfigExporttag: Management - ConfigurationProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//export HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//export'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/config/authorization/validate
operationId: Management_AuthorizationConfigValidatetag: Management - ConfigurationProduction: https://your-app.authaz.io
Request
POST /api/v1/applications/config/authorization/validate HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications/config/authorization/validate'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/config/authorization
operationId: Management_AuthorizationConfigApplytag: Management - ConfigurationProduction: https://your-app.authaz.io
Request
PUT /api/v1/applications/config/authorization HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications/config/authorization'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Debug

POST/api/v1/debug/introspect
operationId: Management_TokenIntrospecttag: Management - DebugProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/debug/introspect HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/debug/introspect' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - SAML Connections

GET/api/v1/applications/{appId}/saml-connections
operationId: Management_ListSamlConnectionstag: Management - SAML ConnectionsProduction: https://your-app.authaz.io

Query Parameters

limitstring
offsetstring
Request
GET /api/v1/applications/{appId}/saml-connections HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications/{appId}/saml-connections'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/applications/{appId}/saml-connections
operationId: Management_CreateSamlConnectiontag: Management - SAML ConnectionsProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/applications/{appId}/saml-connections HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/applications/{appId}/saml-connections' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/saml-connections/{connectionId}
operationId: Management_GetSamlConnectiontag: Management - SAML ConnectionsProduction: https://your-app.authaz.io

Path Parameters

connectionIdstringrequired
Request
GET /api/v1/applications/{appId}/saml-connections/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications/{appId}/saml-connections/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PATCH/api/v1/applications/{appId}/saml-connections/{connectionId}
operationId: Management_UpdateSamlConnectiontag: Management - SAML ConnectionsProduction: https://your-app.authaz.io

Path Parameters

connectionIdstringrequired

Request Body

application/jsonrequired
{}
Request
PATCH /api/v1/applications/{appId}/saml-connections/ HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PATCH 'https://your-app.authaz.io/api/v1/applications/{appId}/saml-connections/' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/saml-connections/{connectionId}
operationId: Management_DeleteSamlConnectiontag: Management - SAML ConnectionsProduction: https://your-app.authaz.io

Path Parameters

connectionIdstringrequired
Request
DELETE /api/v1/applications/{appId}/saml-connections/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications/{appId}/saml-connections/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Auth

POST/api/v1/auth/switch-organization
operationId: Management_SwitchOrganizationtag: Management - AuthProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/auth/switch-organization HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/auth/switch-organization' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - M2M Credentials

GET/api/v1/m2m-credentials
operationId: Management_ListM2MCredentialstag: Management - M2M CredentialsProduction: https://your-app.authaz.io
Request
GET /api/v1/m2m-credentials HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/m2m-credentials'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/m2m-credentials
operationId: Management_CreateM2MCredentialtag: Management - M2M CredentialsProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/m2m-credentials HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/m2m-credentials' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/m2m-credentials/{credentialId}
operationId: Management_RevokeM2MCredentialtag: Management - M2M CredentialsProduction: https://your-app.authaz.io

Path Parameters

credentialIdstringrequired
Request
DELETE /api/v1/m2m-credentials/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/m2m-credentials/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Users

GET/api/v1/users
operationId: Management_ListUserstag: Management - UsersProduction: https://your-app.authaz.io

Query Parameters

Cursorstring
PageSizestring
Searchstring
Statusstring
Request
GET /api/v1/users HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/users'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/users/{userId}
operationId: Management_GetUsertag: Management - UsersProduction: https://your-app.authaz.io

Path Parameters

userIdstringrequired
Request
GET /api/v1/users/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/users/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/users/{userId}
operationId: Management_DeleteUsertag: Management - UsersProduction: https://your-app.authaz.io

Path Parameters

userIdstringrequired
Request
DELETE /api/v1/users/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/users/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/users/{userId}/suspend
operationId: Management_SuspendUsertag: Management - UsersProduction: https://your-app.authaz.io

Path Parameters

userIdstringrequired
Request
POST /api/v1/users//suspend HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/users//suspend'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/users/{userId}/activate
operationId: Management_ActivateUsertag: Management - UsersProduction: https://your-app.authaz.io

Path Parameters

userIdstringrequired
Request
POST /api/v1/users//activate HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/users//activate'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/users/{userId}/unlock
operationId: Management_UnlockUsertag: Management - UsersProduction: https://your-app.authaz.io

Path Parameters

userIdstringrequired
Request
POST /api/v1/users//unlock HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/users//unlock'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/users/{userId}/sessions/revoke
operationId: Management_RevokeUserSessionstag: Management - UsersProduction: https://your-app.authaz.io

Path Parameters

userIdstringrequired
Request
POST /api/v1/users//sessions/revoke HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/users//sessions/revoke'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/users/{userId}/sessions/{sessionId}
operationId: Management_RevokeUserSessiontag: Management - UsersProduction: https://your-app.authaz.io

Path Parameters

userIdstringrequired
sessionIdstringrequired
Request
DELETE /api/v1/users//sessions/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/users//sessions/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/users/{userId}/roles
operationId: Management_ListUserRolestag: Management - UsersProduction: https://your-app.authaz.io

Path Parameters

userIdstringrequired

Query Parameters

tenantIdstring
Request
GET /api/v1/users//roles HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/users//roles'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/users/{userId}/mfa/reset
operationId: Management_ResetUserMfatag: Management - UsersProduction: https://your-app.authaz.io

Path Parameters

userIdstringrequired
Request
POST /api/v1/users//mfa/reset HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/users//mfa/reset'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/users/{userId}/activity
operationId: Management_GetUserActivitytag: Management - UsersProduction: https://your-app.authaz.io

Path Parameters

userIdstringrequired

Query Parameters

daysstring
limitstring
Request
GET /api/v1/users//activity HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/users//activity'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/users/{userId}/sessions
operationId: Management_ListUserSessionstag: Management - UsersProduction: https://your-app.authaz.io

Path Parameters

userIdstringrequired

Query Parameters

daysstring
afterstring
limitstring
Request
GET /api/v1/users//sessions HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/users//sessions'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/users/{userId}/security
operationId: Management_GetUserSecuritytag: Management - UsersProduction: https://your-app.authaz.io

Path Parameters

userIdstringrequired
Request
GET /api/v1/users//security HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/users//security'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Branding

GET/api/v1/applications/{appId}/branding
operationId: Management_GetBrandingtag: Management - BrandingProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//branding HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//branding'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/branding
operationId: Management_UpdateBrandingtag: Management - BrandingProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//branding HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//branding' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Auth Flow

GET/api/v1/applications/{appId}/auth-flow
operationId: Management_GetAuthFlowtag: Management - Auth FlowProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//auth-flow HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//auth-flow'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/auth-flow
operationId: Management_UpdateAuthFlowtag: Management - Auth FlowProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//auth-flow HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//auth-flow' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - M2M Certificates

GET/api/v1/m2m/credentials/{credentialId}/certificates
operationId: Management_ListM2MCertificatestag: Management - M2M CertificatesProduction: https://your-app.authaz.io

Path Parameters

credentialIdstringrequired
Request
GET /api/v1/m2m/credentials//certificates HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/m2m/credentials//certificates'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/m2m/credentials/{credentialId}/certificates/{certificateId}/disable
operationId: Management_DisableM2MCertificatetag: Management - M2M CertificatesProduction: https://your-app.authaz.io

Path Parameters

credentialIdstringrequired
certificateIdstringrequired
Request
POST /api/v1/m2m/credentials//certificates//disable HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/m2m/credentials//certificates//disable'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Policies

GET/api/v1/policies/mfa
operationId: Management_GetMfaPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
GET /api/v1/policies/mfa HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/policies/mfa'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/policies/mfa
operationId: Management_UpdateMfaPolicytag: Management - PoliciesProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/policies/mfa HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/policies/mfa' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/policies/mfa
operationId: Management_DeleteMfaPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
DELETE /api/v1/policies/mfa HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/policies/mfa'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/policies/password
operationId: Management_GetPasswordPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
GET /api/v1/policies/password HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/policies/password'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/policies/password
operationId: Management_UpdatePasswordPolicytag: Management - PoliciesProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/policies/password HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/policies/password' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/policies/password
operationId: Management_DeletePasswordPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
DELETE /api/v1/policies/password HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/policies/password'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/policies/session
operationId: Management_GetSessionPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
GET /api/v1/policies/session HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/policies/session'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/policies/session
operationId: Management_UpdateSessionPolicytag: Management - PoliciesProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/policies/session HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/policies/session' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/policies/session
operationId: Management_DeleteSessionPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
DELETE /api/v1/policies/session HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/policies/session'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/policies/account-lockout
operationId: Management_GetAccountLockoutPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
GET /api/v1/policies/account-lockout HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/policies/account-lockout'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/policies/account-lockout
operationId: Management_UpdateAccountLockoutPolicytag: Management - PoliciesProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/policies/account-lockout HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/policies/account-lockout' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/policies/account-lockout
operationId: Management_DeleteAccountLockoutPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
DELETE /api/v1/policies/account-lockout HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/policies/account-lockout'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/policies/mfa
operationId: Management_App_GetMfaPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
GET /api/v1/applications/{appId}/policies/mfa HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications/{appId}/policies/mfa'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/policies/mfa
operationId: Management_App_UpdateMfaPolicytag: Management - PoliciesProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications/{appId}/policies/mfa HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications/{appId}/policies/mfa' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/policies/mfa
operationId: Management_App_DeleteMfaPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
DELETE /api/v1/applications/{appId}/policies/mfa HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications/{appId}/policies/mfa'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/policies/password
operationId: Management_App_GetPasswordPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
GET /api/v1/applications/{appId}/policies/password HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications/{appId}/policies/password'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/policies/password
operationId: Management_App_UpdatePasswordPolicytag: Management - PoliciesProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications/{appId}/policies/password HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications/{appId}/policies/password' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/policies/password
operationId: Management_App_DeletePasswordPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
DELETE /api/v1/applications/{appId}/policies/password HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications/{appId}/policies/password'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/policies/session
operationId: Management_App_GetSessionPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
GET /api/v1/applications/{appId}/policies/session HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications/{appId}/policies/session'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/policies/session
operationId: Management_App_UpdateSessionPolicytag: Management - PoliciesProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications/{appId}/policies/session HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications/{appId}/policies/session' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/policies/session
operationId: Management_App_DeleteSessionPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
DELETE /api/v1/applications/{appId}/policies/session HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications/{appId}/policies/session'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/policies/account-lockout
operationId: Management_App_GetAccountLockoutPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
GET /api/v1/applications/{appId}/policies/account-lockout HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications/{appId}/policies/account-lockout'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/policies/account-lockout
operationId: Management_App_UpdateAccountLockoutPolicytag: Management - PoliciesProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications/{appId}/policies/account-lockout HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications/{appId}/policies/account-lockout' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/policies/account-lockout
operationId: Management_App_DeleteAccountLockoutPolicytag: Management - PoliciesProduction: https://your-app.authaz.io
Request
DELETE /api/v1/applications/{appId}/policies/account-lockout HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications/{appId}/policies/account-lockout'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Config

GET/api/v1/applications/{appId}/config/password/invitation
operationId: Management_GetPasswordInvitationConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//config/password/invitation HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/password/invitation'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/config/password/invitation
operationId: Management_UpdatePasswordInvitationConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//config/password/invitation HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//config/password/invitation' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/oauth
operationId: Management_ListOAuthProviderstag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//config/oauth HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/oauth'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/oauth/{providerName}
operationId: Management_GetOAuthProvidertag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
providerNamestringrequired
Request
GET /api/v1/applications//config/oauth/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/oauth/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/config/oauth/{providerName}
operationId: Management_CreateOrUpdateOAuthProvidertag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
providerNamestringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//config/oauth/ HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//config/oauth/' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/config/oauth/{providerName}
operationId: Management_DeleteOAuthProvidertag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
providerNamestringrequired
Request
DELETE /api/v1/applications//config/oauth/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications//config/oauth/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/oauth/{providerName}/signup
operationId: Management_GetOAuthSignupConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
providerNamestringrequired
Request
GET /api/v1/applications//config/oauth//signup HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/oauth//signup'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/config/oauth/{providerName}/signup
operationId: Management_UpdateOAuthSignupConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
providerNamestringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//config/oauth//signup HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//config/oauth//signup' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/magic-link/signup
operationId: Management_GetMagicLinkSignupConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//config/magic-link/signup HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/magic-link/signup'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/config/magic-link/signup
operationId: Management_UpdateMagicLinkSignupConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//config/magic-link/signup HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//config/magic-link/signup' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/magic-link/invitation
operationId: Management_GetMagicLinkInvitationConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//config/magic-link/invitation HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/magic-link/invitation'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/config/magic-link/invitation
operationId: Management_UpdateMagicLinkInvitationConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//config/magic-link/invitation HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//config/magic-link/invitation' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/m2m
operationId: Management_GetM2MConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//config/m2m HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/m2m'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/config/m2m
operationId: Management_UpdateM2MConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//config/m2m HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//config/m2m' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/signup
operationId: Management_GetSignUpConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//config/signup HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/signup'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/config/signup
operationId: Management_UpdateSignUpConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//config/signup HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//config/signup' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/invitation
operationId: Management_GetInvitationConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//config/invitation HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/invitation'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/config/invitation
operationId: Management_UpdateInvitationConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//config/invitation HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//config/invitation' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/providers
operationId: Management_GetAuthProviderstag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//config/providers HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/providers'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/email-password
operationId: Management_GetEmailPasswordConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//config/email-password HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/email-password'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/config/email-password
operationId: Management_UpdateEmailPasswordConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//config/email-password HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//config/email-password' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/magic-link/auth
operationId: Management_GetMagicLinkAuthConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//config/magic-link/auth HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/magic-link/auth'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/config/magic-link/auth
operationId: Management_UpdateMagicLinkAuthConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//config/magic-link/auth HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//config/magic-link/auth' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/passkey/auth
operationId: Management_GetPasskeyAuthConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//config/passkey/auth HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/passkey/auth'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/config/passkey/auth
operationId: Management_UpdatePasskeyAuthConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//config/passkey/auth HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//config/passkey/auth' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/impersonation
operationId: Management_GetImpersonationConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//config/impersonation HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/impersonation'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/config/impersonation
operationId: Management_UpdateImpersonationConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//config/impersonation HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//config/impersonation' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/api-key
operationId: Management_GetApiKeyConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//config/api-key HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/api-key'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/config/api-key
operationId: Management_UpdateApiKeyConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//config/api-key HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//config/api-key' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/config/cli
operationId: Management_GetCliConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
Request
GET /api/v1/applications//config/cli HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//config/cli'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/config/cli
operationId: Management_UpdateCliConfigtag: Management - ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//config/cli HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//config/cli' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Trail Logs

GET/api/v1/trail-logs
operationId: Management_ListTrailLogstag: Management - Trail LogsProduction: https://your-app.authaz.io

Query Parameters

pageSizestring
cursorstring
searchTextstring
startDatestring
endDatestring
severitystring
Request
GET /api/v1/trail-logs HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/trail-logs'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Management - Support

POST/api/v1/feedback
operationId: Management_SendFeedbacktag: Management - SupportProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/feedback HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/feedback' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
POST/api/v1/support
operationId: Management_SendSupportTickettag: Management - SupportProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/support HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/support' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Validate Session

POST/api/v1/sessions/validate
tag: Validate SessionProduction: https://your-app.authaz.io

Request Body

multipart/form-datarequired
{}
Request
POST /api/v1/sessions/validate HTTP/1.1
Host: your-app.authaz.io
Content-Type: multipart/form-data
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/sessions/validate' \
  -H 'Content-Type: multipart/form-data' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

JWKS

GET/api/.well-known/jwks/applications/{applicationId}.json
tag: JWKSProduction: https://your-app.authaz.io

Path Parameters

applicationIdstringrequired
Request
GET /api/.well-known/jwks/applications/.json HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/.well-known/jwks/applications/.json'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Browser Logs

POST/api/logs
tag: Browser LogsProduction: https://your-app.authaz.io
Request
POST /api/logs HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/logs'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Bootstrap2

POST/api/v1/bootstrap
tag: Bootstrap2Production: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/bootstrap HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/bootstrap' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Bootstrap Production

POST/api/v1/bootstrap/production
tag: Bootstrap ProductionProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/bootstrap/production HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/bootstrap/production' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Dashboard App Key Backfill

POST/api/v1/bootstrap/dashboard-app-key
tag: Dashboard App Key BackfillProduction: https://your-app.authaz.io
Request
POST /api/v1/bootstrap/dashboard-app-key HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/bootstrap/dashboard-app-key'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Age Verification

POST/api/v1/age-verification
tag: Age VerificationProduction: https://your-app.authaz.io

Request Body

application/jsonrequired
{}
Request
POST /api/v1/age-verification HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X POST 'https://your-app.authaz.io/api/v1/age-verification' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Tenant Auth Config

GET/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/email-password
tag: Tenant Auth ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
GET /api/v1/applications//tenants//auth-config/email-password HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//auth-config/email-password'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/email-password
tag: Tenant Auth ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//tenants//auth-config/email-password HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//tenants//auth-config/email-password' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/magic-link
tag: Tenant Auth ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
GET /api/v1/applications//tenants//auth-config/magic-link HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//auth-config/magic-link'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/magic-link
tag: Tenant Auth ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//tenants//auth-config/magic-link HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//tenants//auth-config/magic-link' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/oauth
tag: Tenant Auth ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
GET /api/v1/applications//tenants//auth-config/oauth HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//auth-config/oauth'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/oauth/{providerName}
tag: Tenant Auth ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
providerNamestringrequired
Request
GET /api/v1/applications//tenants//auth-config/oauth/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//auth-config/oauth/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/oauth/{providerName}
tag: Tenant Auth ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
providerNamestringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//tenants//auth-config/oauth/ HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//tenants//auth-config/oauth/' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/oauth/{providerName}
tag: Tenant Auth ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
providerNamestringrequired
Request
DELETE /api/v1/applications//tenants//auth-config/oauth/ HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications//tenants//auth-config/oauth/'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/signup
tag: Tenant Auth ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
GET /api/v1/applications//tenants//auth-config/signup HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//auth-config/signup'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/signup
tag: Tenant Auth ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//tenants//auth-config/signup HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//tenants//auth-config/signup' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/invitation
tag: Tenant Auth ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
GET /api/v1/applications//tenants//auth-config/invitation HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//auth-config/invitation'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/tenants/{tenantId}/auth-config/invitation
tag: Tenant Auth ConfigProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//tenants//auth-config/invitation HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//tenants//auth-config/invitation' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Tenant Policies

GET/api/v1/applications/{appId}/tenants/{tenantId}/policies/mfa
tag: Tenant PoliciesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
GET /api/v1/applications//tenants//policies/mfa HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//policies/mfa'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/tenants/{tenantId}/policies/mfa
tag: Tenant PoliciesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//tenants//policies/mfa HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//tenants//policies/mfa' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/tenants/{tenantId}/policies/mfa
tag: Tenant PoliciesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
DELETE /api/v1/applications//tenants//policies/mfa HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications//tenants//policies/mfa'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/tenants/{tenantId}/policies/session
tag: Tenant PoliciesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
GET /api/v1/applications//tenants//policies/session HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//policies/session'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/tenants/{tenantId}/policies/session
tag: Tenant PoliciesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//tenants//policies/session HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//tenants//policies/session' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/tenants/{tenantId}/policies/session
tag: Tenant PoliciesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
DELETE /api/v1/applications//tenants//policies/session HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications//tenants//policies/session'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
GET/api/v1/applications/{appId}/tenants/{tenantId}/policies/account-lockout
tag: Tenant PoliciesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
GET /api/v1/applications//tenants//policies/account-lockout HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//policies/account-lockout'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/tenants/{tenantId}/policies/account-lockout
tag: Tenant PoliciesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//tenants//policies/account-lockout HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//tenants//policies/account-lockout' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/tenants/{tenantId}/policies/account-lockout
tag: Tenant PoliciesProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
DELETE /api/v1/applications//tenants//policies/account-lockout HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications//tenants//policies/account-lockout'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Branding

GET/api/v1/applications/{appId}/tenants/{tenantId}/branding
tag: BrandingProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
GET /api/v1/applications//tenants//branding HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//branding'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/tenants/{tenantId}/branding
tag: BrandingProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//tenants//branding HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//tenants//branding' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/tenants/{tenantId}/branding
tag: BrandingProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
DELETE /api/v1/applications//tenants//branding HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications//tenants//branding'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}

Email Provider

GET/api/v1/applications/{appId}/tenants/{tenantId}/email-provider
tag: Email ProviderProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
GET /api/v1/applications//tenants//email-provider HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X GET 'https://your-app.authaz.io/api/v1/applications//tenants//email-provider'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
PUT/api/v1/applications/{appId}/tenants/{tenantId}/email-provider
tag: Email ProviderProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired

Request Body

application/jsonrequired
{}
Request
PUT /api/v1/applications//tenants//email-provider HTTP/1.1
Host: your-app.authaz.io
Content-Type: application/json
{}
Code Samples
curl -X PUT 'https://your-app.authaz.io/api/v1/applications//tenants//email-provider' \
  -H 'Content-Type: application/json' \
  --data '{}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}
DELETE/api/v1/applications/{appId}/tenants/{tenantId}/email-provider
tag: Email ProviderProduction: https://your-app.authaz.io

Path Parameters

appIdstringrequired
tenantIdstringrequired
Request
DELETE /api/v1/applications//tenants//email-provider HTTP/1.1
Host: your-app.authaz.io
Code Samples
curl -X DELETE 'https://your-app.authaz.io/api/v1/applications//tenants//email-provider'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{}