FusionAuth Tenant API is one of 37 APIs that FusionAuth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Tenant. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
9 operations
across 5 paths,
and defines 75 schemas.
It is described by OpenAPI 3.2.0, at version 1.66.0.
Requests are made against 2 base URLs: http://localhost:9011, https://sandbox.fusionauth.io.
9 operations5 paths75 schemas1 DELETE3 GET1 PATCH3 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.0
API Version
1.66.0
Base URL
https://sandbox.fusionauth.io
Authentication
API Key, HTTP Bearer
License
Apache2
Resource Areas
1
Authentication & Security 2
FusionAuth Tenant API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (ApiKeyAuth).
It accepts HTTP bearer tokens (JWT) (BearerAuth).
By default, every request must be authenticated.
Paths & Operations 9
Across 5 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Tenant 9
POST
/api/tenant
Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.
createTenant1 parambody→ 200default
GET
/api/tenant/password-validation-rules
Retrieves the password validation rules for a specific tenant. This method requires a tenantId to be provided through the use of a Tenant scoped API key or an HTTP header X-FusionAuth-TenantId to spe…
retrievePasswordValidationRulesWithId→ 200default
GET
/api/tenant/password-validation-rules/{tenantId}
Retrieves the password validation rules for a specific tenant. This API does not require an API key.
Searches tenants with the specified criteria and pagination.
searchTenantsWithIdbody→ 200default
POST
/api/tenant/{tenantId}
Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.
createTenantWithId2 paramsbody→ 200default
DELETE
/api/tenant/{tenantId}
Deletes the tenant based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated with the tenant and everything under the tenant…
deleteTenantWithId3 paramsbody→ 200default
PATCH
/api/tenant/{tenantId}
Updates, via PATCH, the tenant with the given Id.
patchTenantWithId2 paramsbody→ 200default
GET
/api/tenant/{tenantId}
Retrieves the tenant for the given Id.
retrieveTenantWithId2 params→ 200default
PUT
/api/tenant/{tenantId}
Updates the tenant with the given Id.
updateTenantWithId2 paramsbody→ 200default
Schemas 75
The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are Tenant (37 properties), ExternalIdentifierConfiguration (33 properties), EmailConfiguration (29 properties), TenantPhoneConfiguration (19 properties). Each schema is shown below with its type and property counts.
TenantSearchCriteria
object
Search criteria for Tenants
4 properties
UserVerificationRequirement
string
Used to express whether the Relying Party requires user verification for the current operation.
PasswordValidationRules
object
9 properties
TenantAccessControlConfiguration
object
1 property
TenantUsernameConfiguration
object
1 property
Errors
object
Standard error domain object that can also be used as the response from an API call.
2 properties
SecureGeneratorType
string
TenantRequest
object
4 properties
RememberPreviousPasswords
object
2 properties
TenantUserDeletePolicy
object
A Tenant-level policy for deleting Users.
1 property
TenantPhoneConfiguration
object
Hold tenant phone configuration for passwordless and verification cases.
19 properties
TenantLoginConfiguration
object
1 property
VerificationStrategy
string
Location
object
Location information. Useful for IP addresses and other displayable data objects.
7 properties
PasswordBreachDetection
object
4 properties
FailedAuthenticationConfiguration
object
Configuration for the behavior of failed login attempts. This helps us protect against brute force password attacks.
7 properties
PasswordEncryptionConfiguration
object
Password Encryption Scheme Configuration
3 properties
TenantWebAuthnWorkflowConfiguration
object
3 properties
TenantSCIMServerConfiguration
object
4 properties
TenantSSOConfiguration
object
2 properties
EmailConfiguration
object
29 properties
TransactionType
string
The transaction types for Webhooks and other event systems within FusionAuth.
TenantWebAuthnConfiguration
object
Tenant-level configuration for WebAuthn
6 properties
MultiFactorEmailMethod
object
2 properties
JWTConfiguration
object
JWT Configuration. A JWT Configuration for an Application may not be active if it is using the global configuration, the configuration may be enabled = false .
10 properties
ZonedDateTime
integer
The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.
TenantMultiFactorConfiguration
object
5 properties
EventConfiguration
object
1 property
PhoneUnverifiedOptions
object
Configuration for unverified phone number identities.
2 properties
UniqueUsernameConfiguration
object
4 properties
BreachMatchMode
string
TenantDeleteRequest
object
Request for the Tenant API to delete a tenant rather than using the URL parameters.
2 properties
RefreshTokenExpirationPolicy
string
RefreshTokenUsagePolicy
string
EventConfigurationData
object
2 properties
Error
object
Defines an error.
3 properties
EventInfo
object
Information about a user event (login, register, etc) that helps identify the source of the event (location, device type, OS, etc).
8 properties
EmailUnverifiedOptions
object
2 properties
ExternalIdentifierConfiguration
object
33 properties
CaptchaMethod
string
UnverifiedBehavior
string
EmailHeader
object
2 properties
TimeBasedDeletePolicy
object
A policy for deleting Users based upon some external criteria.
3 properties
ExpiryUnit
string
TOTPAlgorithm
string
TenantRateLimitConfiguration
object
8 properties
ConnectorPolicy
object
4 properties
EmailSecurityType
string
TenantLambdaConfiguration
object
8 properties
TenantSearchRequest
object
Search request for Tenants
1 property
RefreshTokenOneTimeUseConfiguration
object
Refresh token one-time use configuration. This configuration is utilized when the usage policy is configured for one-time use.
1 property
MaximumPasswordAge
object
2 properties
TenantFormConfiguration
object
1 property
RefreshTokenSlidingWindowConfiguration
object
1 property
FamilyConfiguration
object
10 properties
MultiFactorSMSMethod
object
3 properties
PasswordValidationRulesResponse
object
1 property
Tenant
object
37 properties
MultiFactorLoginPolicy
string
RefreshTokenRevocationPolicy
object
4 properties
BreachAction
string
TenantCaptchaConfiguration
object
5 properties
TenantOAuth2Configuration
object
1 property
MinimumPasswordAge
object
2 properties
MultiFactorVoiceMethod
object
3 properties
TenantResponse
object
2 properties
FailedAuthenticationActionCancelPolicy
object
A policy to configure if and when the user-action is canceled prior to the expiration of the action.
1 property
AuthenticatorAttachmentPreference
string
Describes the authenticator attachment modality preference for a WebAuthn workflow. See {@link AuthenticatorAttachment}
UniqueUsernameStrategy
string
MultiFactorAuthenticatorMethod
object
4 properties
TenantSearchResponse
object
Tenant search response
2 properties
ObjectState
string
SecureGeneratorConfiguration
object
2 properties
TenantRegistrationConfiguration
object
1 property
RateLimitedRequestConfiguration
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of FusionAuth Tenant API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
