FusionAuth API
This is a FusionAuth server. Find out more at [https://fusionauth.io](https://fusionauth.io). You need to [set up an API…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This is a FusionAuth server. Find out more at https://fusionauth.io. You need to set up an API key in the FusionAuth instance you are using to test out the API calls.
Endpoints 364
- GETretrieveJsonWebKeySetWithId
/.well-known/jwks.jsonReturns public keys used by FusionAuth to cryptographically verify JWTs using the JSON Web Key format. - GETretrieveOpenIdConfigurationWithId
/.well-known/openid-configurationReturns the well known OpenID Configuration JSON document - POSTcreateAPIKey
/api/api-keyCreates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. an API key can only be created with equal or… - GETretrieveAPIKeyWithId
/api/api-key/:keyIdRetrieves an authentication API key for the given Id. - PUTupdateAPIKeyWithId
/api/api-key/:keyIdUpdates an API key with the given Id. - POSTcreateAPIKeyWithId
/api/api-key/:keyIdCreates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. an API key can only be created with equal or… - DELETEdeleteAPIKeyWithId
/api/api-key/:keyIdDeletes the API key for the given Id. - PATCHpatchAPIKeyWithId
/api/api-key/:keyIdUpdates an API key with the given Id. - GETretrieveApplication
/api/application?inactive=stringRetrieves all the applications that are currently inactive. OR Retrieves the application for the given Id or all the applications if the Id is null. - POSTcreateApplication
/api/applicationCreates an application. You can optionally specify an Id for the application, if not provided one will be generated. - POSTsearchApplicationsWithId
/api/application/searchSearches applications with the specified criteria and pagination. - GETretrieveApplicationWithId
/api/application/:applicationIdRetrieves the application for the given Id or all the applications if the Id is null. - PUTupdateApplicationWithId
/api/application/:applicationId?reactivate=stringUpdates the application with the given Id. OR Reactivates the application with the given Id. - POSTcreateApplicationWithId
/api/application/:applicationIdCreates an application. You can optionally specify an Id for the application, if not provided one will be generated. - DELETEdeleteApplicationWithId
/api/application/:applicationId?hardDelete=stringHard deletes an application. This is a dangerous operation and should not be used in most circumstances. This will delete the application, any registrations… - PATCHpatchApplicationWithId
/api/application/:applicationIdUpdates, via PATCH, the application with the given Id. - GETretrieveOauthConfigurationWithId
/api/application/:applicationId/oauth-configurationRetrieves the Oauth2 configuration for the application for the given Application Id. - POSTcreateApplicationRole
/api/application/:applicationId/roleCreates a new role for an application. You must specify the Id of the application you are creating the role for. You can optionally specify an Id for the role… - PUTupdateApplicationRoleWithId
/api/application/:applicationId/role/:roleIdUpdates the application role with the given Id for the application. - POSTcreateApplicationRoleWithId
/api/application/:applicationId/role/:roleIdCreates a new role for an application. You must specify the Id of the application you are creating the role for. You can optionally specify an Id for the role… - DELETEdeleteApplicationRoleWithId
/api/application/:applicationId/role/:roleIdHard deletes an application role. This is a dangerous operation and should not be used in most circumstances. This permanently removes the given role from all… - PATCHpatchApplicationRoleWithId
/api/application/:applicationId/role/:roleIdUpdates, via PATCH, the application role with the given Id for the application. - POSTcreateOAuthScope
/api/application/:applicationId/scopeCreates a new custom OAuth scope for an application. You must specify the Id of the application you are creating the scope for. You can optionally specify an… - GETretrieveOAuthScopeWithId
/api/application/:applicationId/scope/:scopeIdRetrieves a custom OAuth scope. - PUTupdateOAuthScopeWithId
/api/application/:applicationId/scope/:scopeIdUpdates the OAuth scope with the given Id for the application. - POSTcreateOAuthScopeWithId
/api/application/:applicationId/scope/:scopeIdCreates a new custom OAuth scope for an application. You must specify the Id of the application you are creating the scope for. You can optionally specify an… - DELETEdeleteOAuthScopeWithId
/api/application/:applicationId/scope/:scopeIdHard deletes a custom OAuth scope. OAuth workflows that are still requesting the deleted OAuth scope may fail depending on the application's unknown scope… - PATCHpatchOAuthScopeWithId
/api/application/:applicationId/scope/:scopeIdUpdates, via PATCH, the custom OAuth scope with the given Id for the application. - GETretrieveCimdDomainsWithId
/api/cimd/domainRetrieves all the CIMD domains for the tenant in context. - POSTcreateCimdDomain
/api/cimd/domainCreates a CIMD domain. You can optionally provide an Id for the CIMD domain, if not provided one will be generated. - POSTsearchCimdDomainsWithId
/api/cimd/domain/searchSearches the CIMD domains with the specified criteria and pagination. - GETretrieveCimdDomainWithId
/api/cimd/domain/:domainIdRetrieves the CIMD domain for the given Id. - PUTupdateCimdDomainWithId
/api/cimd/domain/:domainIdUpdates the CIMD domain with the given Id. - POSTcreateCimdDomainWithId
/api/cimd/domain/:domainIdCreates a CIMD domain. You can optionally provide an Id for the CIMD domain, if not provided one will be generated. - DELETEdeleteCimdDomainWithId
/api/cimd/domain/:domainIdDeletes the CIMD domain for the given Id. - PATCHpatchCimdDomainWithId
/api/cimd/domain/:domainIdUpdates, via PATCH, the CIMD domain with the given Id. - POSTcreateCimdDomainOAuthScope
/api/cimd/domain/:domainId/scopeCreates a new custom OAuth scope for a CIMD Domain. You must specify the Id of the CIMD domain you are creating the scope for. You can optionally specify an… - GETretrieveCimdDomainOAuthScopeWithId
/api/cimd/domain/:domainId/scope/:scopeIdRetrieves a custom OAuth scope for a CIMD Domain. - PUTupdateCimdDomainOAuthScopeWithId
/api/cimd/domain/:domainId/scope/:scopeIdUpdates the OAuth scope with the given Id for the CIMD domain. - POSTcreateCimdDomainOAuthScopeWithId
/api/cimd/domain/:domainId/scope/:scopeIdCreates a new custom OAuth scope for a CIMD Domain. You must specify the Id of the CIMD domain you are creating the scope for. You can optionally specify an… - DELETEdeleteCimdDomainOAuthScopeWithId
/api/cimd/domain/:domainId/scope/:scopeIdHard deletes a custom OAuth scope for a CIMD Domain. OAuth workflows that are still requesting the deleted OAuth scope may fail depending on the CIMD domain's… - PATCHpatchCimdDomainOAuthScopeWithId
/api/cimd/domain/:domainId/scope/:scopeIdUpdates, via PATCH, the custom OAuth scope with the given Id for the CIMD domain. - POSTsearchCimdClientRegistrationsWithId
/api/cimd/registration/searchSearches the CIMD client registrations with the specified criteria and pagination. - GETretrieveCimdClientRegistrationWithId
/api/cimd/registration/:registrationIdRetrieves the CIMD client registration for the given Id. - DELETEdeleteCimdClientRegistrationWithId
/api/cimd/registration/:registrationIdDeletes the CIMD client registration for the given Id, along with its refresh tokens. - GETretrieveConnectorsWithId
/api/connectorRetrieves all the connectors. - POSTcreateConnector
/api/connectorCreates a connector. You can optionally specify an Id for the connector, if not provided one will be generated. - GETretrieveConnectorWithId
/api/connector/:connectorIdRetrieves the connector with the given Id. - PUTupdateConnectorWithId
/api/connector/:connectorIdUpdates the connector with the given Id. - POSTcreateConnectorWithId
/api/connector/:connectorIdCreates a connector. You can optionally specify an Id for the connector, if not provided one will be generated. - DELETEdeleteConnectorWithId
/api/connector/:connectorIdDeletes the connector for the given Id. - PATCHpatchConnectorWithId
/api/connector/:connectorIdUpdates, via PATCH, the connector with the given Id. - GETretrieveConsentsWithId
/api/consentRetrieves all the consent. - POSTcreateConsent
/api/consentCreates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated. - GETsearchConsentsByParametersWithId
/api/consent/search?name=string&numberOfResults=string&orderBy=string&startRow=stringSearches consents with the specified criteria and pagination. - POSTsearchConsentsWithId
/api/consent/searchSearches consents with the specified criteria and pagination. - GETretrieveConsentWithId
/api/consent/:consentIdRetrieves the Consent for the given Id. - PUTupdateConsentWithId
/api/consent/:consentIdUpdates the consent with the given Id. - POSTcreateConsentWithId
/api/consent/:consentIdCreates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated. - DELETEdeleteConsentWithId
/api/consent/:consentIdDeletes the consent for the given Id. - PATCHpatchConsentWithId
/api/consent/:consentIdUpdates, via PATCH, the consent with the given Id. - POSTsendEmailWithId
/api/email/send/:emailTemplateIdSend an email using an email template Id. You can optionally provide <code>requestData</code> to access key value pairs in the email template. - GETretrieveEmailTemplate
/api/email/templateRetrieves the email template for the given Id. If you don't specify the Id, this will return all the email templates. - POSTcreateEmailTemplate
/api/email/templateCreates an email template. You can optionally specify an Id for the template, if not provided one will be generated. - POSTretrieveEmailTemplatePreviewWithId
/api/email/template/previewCreates a preview of the email template provided in the request. This allows you to preview an email template that hasn't been saved to the database yet. The… - POSTsearchEmailTemplatesWithId
/api/email/template/searchSearches email templates with the specified criteria and pagination. - GETretrieveEmailTemplateWithId
/api/email/template/:emailTemplateIdRetrieves the email template for the given Id. If you don't specify the Id, this will return all the email templates. - PUTupdateEmailTemplateWithId
/api/email/template/:emailTemplateIdUpdates the email template with the given Id. - POSTcreateEmailTemplateWithId
/api/email/template/:emailTemplateIdCreates an email template. You can optionally specify an Id for the template, if not provided one will be generated. - DELETEdeleteEmailTemplateWithId
/api/email/template/:emailTemplateIdDeletes the email template for the given Id. - PATCHpatchEmailTemplateWithId
/api/email/template/:emailTemplateIdUpdates, via PATCH, the email template with the given Id. - POSTcreateEntity
/api/entityCreates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated. - GETsearchEntityGrantsByParametersWithId
/api/entity/grant/search?entityId=string&name=string&userId=string&numberOfResults=string&orderBy=string&startRow=stringSearches entity grants with the specified criteria and pagination. - POSTsearchEntityGrantsWithId
/api/entity/grant/searchSearches Entity Grants with the specified criteria and pagination. - GETsearchEntitiesByIdsWithId
/api/entity/search?ids=stringRetrieves the entities for the given Ids. If any Id is invalid, it is ignored. - PUTrefreshEntitySearchIndexWithId
/api/entity/searchRequest a refresh of the Entity search index. This API is not generally necessary and the search index will become consistent in a reasonable amount of time.… - POSTsearchEntitiesWithId
/api/entity/searchSearches entities with the specified criteria and pagination. - GETretrieveEntityTypesWithId
/api/entity/typeRetrieves all the Entity Types. - POSTcreateEntityType
/api/entity/typeCreates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated. - GETsearchEntityTypesByParametersWithId
/api/entity/type/search?name=string&numberOfResults=string&orderBy=string&startRow=stringSearches entity types with the specified criteria and pagination. - POSTsearchEntityTypesWithId
/api/entity/type/searchSearches the entity types with the specified criteria and pagination. - GETretrieveEntityTypeWithId
/api/entity/type/:entityTypeIdRetrieves the Entity Type for the given Id. - PUTupdateEntityTypeWithId
/api/entity/type/:entityTypeIdUpdates the Entity Type with the given Id. - POSTcreateEntityTypeWithId
/api/entity/type/:entityTypeIdCreates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated. - DELETEdeleteEntityTypeWithId
/api/entity/type/:entityTypeIdDeletes the Entity Type for the given Id. - PATCHpatchEntityTypeWithId
/api/entity/type/:entityTypeIdUpdates, via PATCH, the Entity Type with the given Id. - POSTcreateEntityTypePermission
/api/entity/type/:entityTypeId/permissionCreates a new permission for an entity type. You must specify the Id of the entity type you are creating the permission for. You can optionally specify an Id… - PUTupdateEntityTypePermissionWithId
/api/entity/type/:entityTypeId/permission/:permissionIdUpdates the permission with the given Id for the entity type. - POSTcreateEntityTypePermissionWithId
/api/entity/type/:entityTypeId/permission/:permissionIdCreates a new permission for an entity type. You must specify the Id of the entity type you are creating the permission for. You can optionally specify an Id… - DELETEdeleteEntityTypePermissionWithId
/api/entity/type/:entityTypeId/permission/:permissionIdHard deletes a permission. This is a dangerous operation and should not be used in most circumstances. This permanently removes the given permission from all… - PATCHpatchEntityTypePermissionWithId
/api/entity/type/:entityTypeId/permission/:permissionIdPatches the permission with the given Id for the entity type. - GETretrieveEntityWithId
/api/entity/:entityIdRetrieves the Entity for the given Id. - PUTupdateEntityWithId
/api/entity/:entityIdUpdates the Entity with the given Id. - POSTcreateEntityWithId
/api/entity/:entityIdCreates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated. - DELETEdeleteEntityWithId
/api/entity/:entityIdDeletes the Entity for the given Id. - PATCHpatchEntityWithId
/api/entity/:entityIdUpdates, via PATCH, the Entity with the given Id. - GETretrieveEntityGrantWithId
/api/entity/:entityId/grant?recipientEntityId=string&userId=stringRetrieves an Entity Grant for the given Entity and User/Entity. - POSTupsertEntityGrantWithId
/api/entity/:entityId/grantCreates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity. - DELETEdeleteEntityGrantWithId
/api/entity/:entityId/grant?recipientEntityId=string&userId=stringDeletes an Entity Grant for the given User or Entity. - GETretrieveFormsWithId
/api/formRetrieves all the forms. - POSTcreateForm
/api/formCreates a form. You can optionally specify an Id for the form, if not provided one will be generated. - GETretrieveFormFieldsWithId
/api/form/fieldRetrieves all the forms fields - POSTcreateFormField
/api/form/fieldCreates a form field. You can optionally specify an Id for the form, if not provided one will be generated. - GETretrieveFormFieldWithId
/api/form/field/:fieldIdRetrieves the form field with the given Id. - PUTupdateFormFieldWithId
/api/form/field/:fieldIdUpdates the form field with the given Id. - POSTcreateFormFieldWithId
/api/form/field/:fieldIdCreates a form field. You can optionally specify an Id for the form, if not provided one will be generated. - DELETEdeleteFormFieldWithId
/api/form/field/:fieldIdDeletes the form field for the given Id. - PATCHpatchFormFieldWithId
/api/form/field/:fieldIdPatches the form field with the given Id. - GETretrieveFormWithId
/api/form/:formIdRetrieves the form with the given Id. - PUTupdateFormWithId
/api/form/:formIdUpdates the form with the given Id. - POSTcreateFormWithId
/api/form/:formIdCreates a form. You can optionally specify an Id for the form, if not provided one will be generated. - DELETEdeleteFormWithId
/api/form/:formIdDeletes the form for the given Id. - PATCHpatchFormWithId
/api/form/:formIdPatches the form with the given Id. - GETretrieveGroupsWithId
/api/groupRetrieves all the groups. - POSTcreateGroup
/api/groupCreates a group. You can optionally specify an Id for the group, if not provided one will be generated. - PUTupdateGroupMembersWithId
/api/group/memberCreates a member in a group. - POSTcreateGroupMembersWithId
/api/group/memberCreates a member in a group. - DELETEdeleteGroupMembersWithId
/api/group/memberRemoves users as members of a group. - POSTsearchGroupMembersWithId
/api/group/member/searchSearches group members with the specified criteria and pagination. - POSTsearchGroupsWithId
/api/group/searchSearches groups with the specified criteria and pagination. - GETretrieveGroupWithId
/api/group/:groupIdRetrieves the group for the given Id. - PUTupdateGroupWithId
/api/group/:groupIdUpdates the group with the given Id. - POSTcreateGroupWithId
/api/group/:groupIdCreates a group. You can optionally specify an Id for the group, if not provided one will be generated. - DELETEdeleteGroupWithId
/api/group/:groupIdDeletes the group for the given Id. - PATCHpatchGroupWithId
/api/group/:groupIdUpdates, via PATCH, the group with the given Id. - GETretrieveSystemHealthWithId
/api/healthRetrieves the FusionAuth system health. This API will return 200 if the system is healthy, and 500 if the system is un-healthy. - GETretrieveIdentityProviderByTypeWithId
/api/identity-provider?type=stringRetrieves one or more identity provider for the given type. For types such as Google, Facebook, Twitter and LinkedIn, only a single identity provider can… - POSTcreateIdentityProvider
/api/identity-providerCreates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated. - GETretrieveIdentityProviderLink
/api/identity-provider/link?identityProviderId=string&userId=string&identityProviderUserId=stringRetrieve all Identity Provider users (links) for the user. Specify the optional identityProviderId to retrieve links for a particular IdP. OR Retrieve a… - POSTcreateUserLinkWithId
/api/identity-provider/linkLink an external user from a 3rd party identity provider to a FusionAuth user. - DELETEdeleteUserLinkWithId
/api/identity-provider/link?identityProviderId=string&identityProviderUserId=string&userId=stringRemove an existing link that has been made from a 3rd party identity provider to a FusionAuth user. - GETretrievePendingLinkWithId
/api/identity-provider/link/pending/:pendingLinkId?userId=stringRetrieve a pending identity provider link. This is useful to validate a pending link and retrieve meta-data about the identity provider link. - POSTidentityProviderLoginWithId
/api/identity-provider/loginHandles login via third-parties including Social login, external OAuth and OpenID Connect, and other login systems. - GETretrieveIdentityProviderLookup
/api/identity-provider/lookup?domain=string&tenantId=stringRetrieves the identity provider for the given domain and tenantId. A 200 response code indicates the domain is managed by a registered identity provider. A… - GETsearchIdentityProvidersByParametersWithId
/api/identity-provider/search?applicationId=string&name=string&numberOfResults=string&orderBy=string&startRow=string&tenantId=string&type=stringSearches identity providers with the specified criteria and pagination. - POSTsearchIdentityProvidersWithId
/api/identity-provider/searchSearches identity providers with the specified criteria and pagination. - POSTstartIdentityProviderLoginWithId
/api/identity-provider/startBegins a login request for a 3rd party login that requires user interaction such as HYPR. - GETretrieveIdentityProviderConnectionTestResultsWithId
/api/identity-provider/test?connectionTestId=stringRetrieves the results for an identity provider connection test. - POSTstartIdentityProviderConnectionTestWithId
/api/identity-provider/testBegins an identity provider connection test. - GETretrieveIdentityProviderWithId
/api/identity-provider/:identityProviderIdRetrieves the identity provider for the given Id or all the identity providers if the Id is null. - PUTupdateIdentityProviderWithId
/api/identity-provider/:identityProviderIdUpdates the identity provider with the given Id. - POSTcreateIdentityProviderWithId
/api/identity-provider/:identityProviderIdCreates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated. - DELETEdeleteIdentityProviderWithId
/api/identity-provider/:identityProviderIdDeletes the identity provider for the given Id. - PATCHpatchIdentityProviderWithId
/api/identity-provider/:identityProviderIdUpdates, via PATCH, the identity provider with the given Id. - POSTverifyIdentityWithId
/api/identity/verifyAdministratively verify a user identity. - POSTcompleteVerifyIdentityWithId
/api/identity/verify/completeCompletes verification of an identity using verification codes from the Verify Start API. - POSTsendVerifyIdentityWithId
/api/identity/verify/sendSend a verification code using the appropriate transport for the identity type being verified. - POSTstartVerifyIdentityWithId
/api/identity/verify/startStart a verification of an identity by generating a code. This code can be sent to the User using the Verify Send API Verification Code API or using a… - GETretrieveIntegrationWithId
/api/integrationRetrieves the available integrations. - PUTupdateIntegrationsWithId
/api/integrationUpdates the available integrations. - PATCHpatchIntegrationsWithId
/api/integrationUpdates, via PATCH, the available integrations. - POSTcreateIPAccessControlList
/api/ip-aclCreates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated. - GETsearchIPAccessControlListsByParametersWithId
/api/ip-acl/search?name=string&numberOfResults=string&orderBy=string&startRow=stringSearches IP access control lists with the specified criteria and pagination. - POSTsearchIPAccessControlListsWithId
/api/ip-acl/searchSearches the IP Access Control Lists with the specified criteria and pagination. - PUTupdateIPAccessControlListWithId
/api/ip-acl/:accessControlListIdUpdates the IP Access Control List with the given Id. - POSTcreateIPAccessControlListWithId
/api/ip-acl/:accessControlListIdCreates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated. - PATCHpatchIPAccessControlListWithId
/api/ip-acl/:accessControlListIdUpdate the IP Access Control List with the given Id. - GETretrieveIPAccessControlListWithId
/api/ip-acl/:ipAccessControlListIdRetrieves the IP Access Control List with the given Id. - DELETEdeleteIPAccessControlListWithId
/api/ip-acl/:ipAccessControlListIdDeletes the IP Access Control List for the given Id. - GETissueJWTWithId
/api/jwt/issue?applicationId=string&refreshToken=stringIssue a new access token (JWT) for the requested Application after ensuring the provided JWT is valid. A valid access token is properly signed and not… - GETretrieveJwtPublicKey
/api/jwt/public-key?applicationId=string&kid=stringRetrieves the Public Key configured for verifying the JSON Web Tokens (JWT) issued by the Login API by the Application Id. OR Retrieves the Public Key… - POSTreconcileJWTWithId
/api/jwt/reconcileReconcile a User to FusionAuth using JWT issued from another Identity Provider. - GETretrieveRefreshTokensWithId
/api/jwt/refresh?userId=stringRetrieves the refresh tokens that belong to the user with the given Id. - POSTexchangeRefreshTokenForJWTWithId
/api/jwt/refreshExchange a refresh token for a new JWT. - DELETEdeleteJwtRefresh
/api/jwt/refresh?userId=string&applicationId=string&token=stringRevokes refresh tokens using the information in the JSON body. The handling for this method is the same as the revokeRefreshToken method and is based on the… - GETretrieveRefreshTokenByIdWithId
/api/jwt/refresh/:tokenIdRetrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token. If you have that, you already have what… - DELETErevokeRefreshTokenByIdWithId
/api/jwt/refresh/:tokenIdRevokes a single refresh token by the unique Id. The unique Id is not sensitive as it cannot be used to obtain another JWT. - GETvalidateJWTWithId
/api/jwt/validateValidates the provided JWT (encoded JWT string) to ensure the token is valid. A valid access token is properly signed and not expired. <p> This API may be… - POSTvendJWTWithId
/api/jwt/vendIt's a JWT vending machine! Issue a new access token (JWT) with the provided claims in the request. This JWT is not scoped to a tenant or user, it is a free… - GETretrieveKeysWithId
/api/keyRetrieves all the keys. - POSTgenerateKey
/api/key/generateGenerate a new RSA or EC key pair or an HMAC secret. - POSTgenerateKeyWithId
/api/key/generate/:keyIdGenerate a new RSA or EC key pair or an HMAC secret. - POSTimportKey
/api/key/importImport an existing RSA or EC key pair or an HMAC secret. - POSTimportKeyWithId
/api/key/import/:keyIdImport an existing RSA or EC key pair or an HMAC secret. - GETsearchKeysByParametersWithId
/api/key/search?algorithm=string&name=string&numberOfResults=string&orderBy=string&startRow=string&type=stringSearches keys with the specified criteria and pagination. - POSTsearchKeysWithId
/api/key/searchSearches keys with the specified criteria and pagination. - GETretrieveKeyWithId
/api/key/:keyIdRetrieves the key for the given Id. - PUTupdateKeyWithId
/api/key/:keyIdUpdates the key with the given Id. - DELETEdeleteKeyWithId
/api/key/:keyIdDeletes the key for the given Id. - GETretrieveLambdasByTypeWithId
/api/lambda?type=stringRetrieves all the lambdas for the provided type. - POSTcreateLambda
/api/lambdaCreates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated. - POSTsearchLambdasWithId
/api/lambda/searchSearches lambdas with the specified criteria and pagination. - GETretrieveLambdaWithId
/api/lambda/:lambdaIdRetrieves the lambda for the given Id. - PUTupdateLambdaWithId
/api/lambda/:lambdaIdUpdates the lambda with the given Id. - POSTcreateLambdaWithId
/api/lambda/:lambdaIdCreates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated. - DELETEdeleteLambdaWithId
/api/lambda/:lambdaIdDeletes the lambda for the given Id. - PATCHpatchLambdaWithId
/api/lambda/:lambdaIdUpdates, via PATCH, the lambda with the given Id. - PUTloginPingWithRequestWithId
/api/loginSends a ping to FusionAuth indicating that the user was automatically logged into an application. When using FusionAuth's SSO or your own, you should call… - POSTloginWithId
/api/loginAuthenticates a user to FusionAuth. This API optionally requires an API key. See <code>Application.loginConfiguration.requireAuthentication</code>. - PUTloginPingWithId
/api/login/:userId/:applicationId?ipAddress=stringSends a ping to FusionAuth indicating that the user was automatically logged into an application. When using FusionAuth's SSO or your own, you should call… - POSTcreateLogout
/api/logout?global=string&refreshToken=stringThe Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the client and revoke the refresh token stored.… - GETretrieveMessageTemplate
/api/message/templateRetrieves the message template for the given Id. If you don't specify the Id, this will return all the message templates. - POSTcreateMessageTemplate
/api/message/templateCreates an message template. You can optionally specify an Id for the template, if not provided one will be generated. - POSTretrieveMessageTemplatePreviewWithId
/api/message/template/previewCreates a preview of the message template provided in the request, normalized to a given locale. - GETretrieveMessageTemplateWithId
/api/message/template/:messageTemplateIdRetrieves the message template for the given Id. If you don't specify the Id, this will return all the message templates. - PUTupdateMessageTemplateWithId
/api/message/template/:messageTemplateIdUpdates the message template with the given Id. - POSTcreateMessageTemplateWithId
/api/message/template/:messageTemplateIdCreates an message template. You can optionally specify an Id for the template, if not provided one will be generated. - DELETEdeleteMessageTemplateWithId
/api/message/template/:messageTemplateIdDeletes the message template for the given Id. - PATCHpatchMessageTemplateWithId
/api/message/template/:messageTemplateIdUpdates, via PATCH, the message template with the given Id. - GETretrieveMessengersWithId
/api/messengerRetrieves all the messengers. - POSTcreateMessenger
/api/messengerCreates a messenger. You can optionally specify an Id for the messenger, if not provided one will be generated. - GETretrieveMessengerWithId
/api/messenger/:messengerIdRetrieves the messenger with the given Id. - PUTupdateMessengerWithId
/api/messenger/:messengerIdUpdates the messenger with the given Id. - POSTcreateMessengerWithId
/api/messenger/:messengerIdCreates a messenger. You can optionally specify an Id for the messenger, if not provided one will be generated. - DELETEdeleteMessengerWithId
/api/messenger/:messengerIdDeletes the messenger for the given Id. - PATCHpatchMessengerWithId
/api/messenger/:messengerIdUpdates, via PATCH, the messenger with the given Id. - POSTpasswordlessLoginWithId
/api/passwordless/loginComplete a login request using a passwordless code - POSTsendPasswordlessCodeWithId
/api/passwordless/sendSend a passwordless authentication code in an email to complete login. - POSTstartPasswordlessLoginWithId
/api/passwordless/startStart a passwordless login request by generating a passwordless code. This code can be sent to the User using the Send Passwordless Code API or using a… - GETretrieveReactorStatusWithId
/api/reactorRetrieves the FusionAuth Reactor status. - PUTregenerateReactorKeysWithId
/api/reactorRegenerates any keys that are used by the FusionAuth Reactor. - POSTactivateReactorWithId
/api/reactorActivates the FusionAuth Reactor using a license Id and optionally a license text (for air-gapped deployments) - DELETEdeactivateReactorWithId
/api/reactorDeactivates the FusionAuth Reactor. - GETretrieveReactorMetricsWithId
/api/reactor/metricsRetrieves the FusionAuth Reactor metrics. - GETretrieveDailyActiveReportWithId
/api/report/daily-active-user?applicationId=string&start=string&end=stringRetrieves the daily active user report between the two instants. If you specify an application Id, it will only return the daily active counts for that… - GETretrieveReportLogin
/api/report/login?applicationId=string&loginId=string&start=string&end=string&loginIdTypes=string&userId=stringRetrieves the login report between the two instants for a particular user by login Id, using specific loginIdTypes. If you specify an application id, it will… - GETretrieveMonthlyActiveReportWithId
/api/report/monthly-active-user?applicationId=string&start=string&end=stringRetrieves the monthly active user report between the two instants. If you specify an application Id, it will only return the monthly active counts for that… - GETretrieveRegistrationReportWithId
/api/report/registration?applicationId=string&start=string&end=stringRetrieves the registration report between the two instants. If you specify an application Id, it will only return the registration counts for that application. - GETretrieveTotalReportWithExcludesWithId
/api/report/totals?excludes=stringRetrieves the totals report. This allows excluding applicationTotals from the report. An empty list will include the applicationTotals. - GETretrieveSystemStatusWithId
/api/statusRetrieves the FusionAuth system status. This request is anonymous and does not require an API key. When an API key is not provided the response will contain a… - GETretrieveSystemConfigurationWithId
/api/system-configurationRetrieves the system configuration. - PUTupdateSystemConfigurationWithId
/api/system-configurationUpdates the system configuration. - PATCHpatchSystemConfigurationWithId
/api/system-configurationUpdates, via PATCH, the system configuration. - POSTcreateAuditLogWithId
/api/system/audit-logCreates an audit log with the message and user name (usually an email). Audit logs should be written anytime you make changes to the FusionAuth database. When… - POSTsearchAuditLogsWithId
/api/system/audit-log/searchSearches the audit logs with the specified criteria and pagination. - GETretrieveAuditLogWithId
/api/system/audit-log/:auditLogIdRetrieves a single audit log for the given Id. - POSTsearchEventLogsWithId
/api/system/event-log/searchSearches the event logs with the specified criteria and pagination. - GETretrieveEventLogWithId
/api/system/event-log/:eventLogIdRetrieves a single event log for the given Id. - POSTsearchLoginRecordsWithId
/api/system/login-record/searchSearches the login records with the specified criteria and pagination. - GETretrieveReindexStatusWithId
/api/system/reindexRetrieve the status of a re-index process. A status code of 200 indicates the re-index is in progress, a status code of 404 indicates no re-index is in… - POSTreindexWithId
/api/system/reindexRequests Elasticsearch to delete and rebuild the index for FusionAuth users or entities. Be very careful when running this request as it will increase the CPU… - GETretrieveVersionWithId
/api/system/versionRetrieves the FusionAuth version string. - GETretrieveWebhookAttemptLogWithId
/api/system/webhook-attempt-log/:webhookAttemptLogIdRetrieves a single webhook attempt log for the given Id. - POSTsearchWebhookEventLogsWithId
/api/system/webhook-event-log/searchSearches the webhook event logs with the specified criteria and pagination. - GETretrieveWebhookEventLogWithId
/api/system/webhook-event-log/:webhookEventLogIdRetrieves a single webhook event log for the given Id. - GETretrieveTenantsWithId
/api/tenantRetrieves all the tenants. - POSTcreateTenant
/api/tenantCreates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated. - GETretrieveTenantManagerConfigurationWithId
/api/tenant-managerRetrieves the Tenant Manager configuration. - PUTupdateTenantManagerConfigurationWithId
/api/tenant-managerUpdates the Tenant Manager configuration. - PATCHpatchTenantManagerConfigurationWithId
/api/tenant-managerUpdates, via PATCH, the Tenant Manager configuration. - PUTupdateTenantManagerIdentityProviderTypeConfigurationWithId
/api/tenant-manager/identity-provider/:typeUpdates the tenant manager identity provider type configuration for the given identity provider type. - POSTcreateTenantManagerIdentityProviderTypeConfigurationWithId
/api/tenant-manager/identity-provider/:typeCreates a tenant manager identity provider type configuration for the given identity provider type. - DELETEdeleteTenantManagerIdentityProviderTypeConfigurationWithId
/api/tenant-manager/identity-provider/:typeDeletes the tenant manager identity provider type configuration for the given identity provider type. - PATCHpatchTenantManagerIdentityProviderTypeConfigurationWithId
/api/tenant-manager/identity-provider/:typePatches the tenant manager identity provider type configuration for the given identity provider type. - GETretrievePasswordValidationRulesWithId
/api/tenant/password-validation-rulesRetrieves 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… - GETretrievePasswordValidationRulesWithTenantIdWithId
/api/tenant/password-validation-rules/:tenantIdRetrieves the password validation rules for a specific tenant. This API does not require an API key. - POSTsearchTenantsWithId
/api/tenant/searchSearches tenants with the specified criteria and pagination. - GETretrieveTenantWithId
/api/tenant/:tenantIdRetrieves the tenant for the given Id. - PUTupdateTenantWithId
/api/tenant/:tenantIdUpdates the tenant with the given Id. - POSTcreateTenantWithId
/api/tenant/:tenantIdCreates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated. - DELETEdeleteTenantWithId
/api/tenant/:tenantId?async=stringDeletes the tenant based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated with… - PATCHpatchTenantWithId
/api/tenant/:tenantIdUpdates, via PATCH, the tenant with the given Id. - GETretrieveThemesWithId
/api/themeRetrieves all the themes. - POSTcreateTheme
/api/themeCreates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated. - POSTsearchThemesWithId
/api/theme/searchSearches themes with the specified criteria and pagination. - GETretrieveThemeWithId
/api/theme/:themeIdRetrieves the theme for the given Id. - PUTupdateThemeWithId
/api/theme/:themeIdUpdates the theme with the given Id. - POSTcreateThemeWithId
/api/theme/:themeIdCreates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated. - DELETEdeleteThemeWithId
/api/theme/:themeIdDeletes the theme for the given Id. - PATCHpatchThemeWithId
/api/theme/:themeIdUpdates, via PATCH, the theme with the given Id. - POSTtwoFactorLoginWithId
/api/two-factor/loginComplete login using a 2FA challenge - GETgenerateTwoFactorSecretUsingJWTWithId
/api/two-factor/secretGenerate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain both the secret and a Base32 encoded… - POSTsendTwoFactorCodeForEnableDisableWithId
/api/two-factor/sendSend a Two Factor authentication code to assist in setting up Two Factor authentication or disabling. - POSTsendTwoFactorCodeForLoginUsingMethodWithId
/api/two-factor/send/:twoFactorIdSend a Two Factor authentication code to allow the completion of Two Factor authentication. - POSTstartTwoFactorLoginWithId
/api/two-factor/startStart a Two-Factor login request by generating a two-factor identifier. This code can then be sent to the Two Factor Send API (/api/two-factor/send)in order… - POSTretrieveTwoFactorStatusWithRequestWithId
/api/two-factor/statusRetrieve a user's two-factor status. This can be used to see if a user will need to complete a two-factor challenge to complete a login, and optionally… - GETretrieveTwoFactorStatusWithId
/api/two-factor/status/:twoFactorTrustId?userId=string&applicationId=stringRetrieve a user's two-factor status. This can be used to see if a user will need to complete a two-factor challenge to complete a login, and optionally… - GETretrieveUser
/api/user?verificationId=string&username=string&loginId=string&loginIdTypes=string&email=string&changePasswordId=stringRetrieves the user by a verificationId. The intended use of this API is to retrieve a user after the forgot password workflow has been initiated and you may… - POSTcreateUser
/api/userCreates a user. You can optionally specify an Id for the user, if not provided one will be generated. - GETretrieveUserAction
/api/user-action?inactive=stringRetrieves the user action for the given Id. If you pass in null for the Id, this will return all the user actions. OR Retrieves all the user actions that are… - POSTcreateUserAction
/api/user-actionCreates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be applied to any… - GETretrieveUserActionReason
/api/user-action-reasonRetrieves the user action reason for the given Id. If you pass in null for the Id, this will return all the user action reasons. - POSTcreateUserActionReason
/api/user-action-reasonCreates a user reason. This user action reason cannot be used when actioning a user until this call completes successfully. Anytime after that the user action… - GETretrieveUserActionReasonWithId
/api/user-action-reason/:userActionReasonIdRetrieves the user action reason for the given Id. If you pass in null for the Id, this will return all the user action reasons. - PUTupdateUserActionReasonWithId
/api/user-action-reason/:userActionReasonIdUpdates the user action reason with the given Id. - POSTcreateUserActionReasonWithId
/api/user-action-reason/:userActionReasonIdCreates a user reason. This user action reason cannot be used when actioning a user until this call completes successfully. Anytime after that the user action… - DELETEdeleteUserActionReasonWithId
/api/user-action-reason/:userActionReasonIdDeletes the user action reason for the given Id. - PATCHpatchUserActionReasonWithId
/api/user-action-reason/:userActionReasonIdUpdates, via PATCH, the user action reason with the given Id. - GETretrieveUserActionWithId
/api/user-action/:userActionIdRetrieves the user action for the given Id. If you pass in null for the Id, this will return all the user actions. - PUTupdateUserActionWithId
/api/user-action/:userActionId?reactivate=stringUpdates the user action with the given Id. OR Reactivates the user action with the given Id. - POSTcreateUserActionWithId
/api/user-action/:userActionIdCreates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be applied to any… - DELETEdeleteUserActionWithId
/api/user-action/:userActionId?hardDelete=stringDeletes the user action for the given Id. This permanently deletes the user action and also any history and logs of the action being applied to any users. OR… - PATCHpatchUserActionWithId
/api/user-action/:userActionIdUpdates, via PATCH, the user action with the given Id. - GETretrieveUserActioning
/api/user/action?userId=string&active=string&preventingLogin=stringRetrieves all the actions for the user with the given Id that are currently inactive. An inactive action means one that is time based and has been canceled or… - POSTactionUserWithId
/api/user/actionTakes an action on a user. The user being actioned is called the "actionee" and the user taking the action is called the "actioner". Both user ids are… - GETretrieveActionWithId
/api/user/action/:actionIdRetrieves a single action log (the log of a user action that was taken on a user previously) for the given Id. - PUTmodifyActionWithId
/api/user/action/:actionIdModifies a temporal user action by changing the expiration of the action and optionally adding a comment to the action. - DELETEcancelActionWithId
/api/user/action/:actionIdCancels the user action. - DELETEdeleteUserBulk
/api/user/bulk?userId=string&dryRun=string&hardDelete=stringDeletes the users with the given Ids, or users matching the provided JSON query or queryString. The order of preference is Ids, query and then queryString, it… - GETretrieveUserChangePassword
/api/user/change-password?loginId=string&loginIdTypes=string&ipAddress=stringCheck to see if the user must obtain a Trust Request Id in order to complete a change password request. When a user has enabled Two-Factor authentication,… - POSTcreateUserChangePassword
/api/user/change-passwordChanges a user's password using their access token (JWT) instead of the changePasswordId A common use case for this method will be if you want to allow the… - GETretrieveUserChangePasswordWithId
/api/user/change-password/:changePasswordId?ipAddress=stringCheck to see if the user must obtain a Trust Token Id in order to complete a change password request. When a user has enabled Two-Factor authentication,… - POSTchangePasswordWithId
/api/user/change-password/:changePasswordIdChanges a user's password using the change password Id. This usually occurs after an email has been sent to the user and they clicked on a link to reset their… - POSTcommentOnUserWithId
/api/user/commentAdds a comment to the user's account. - POSTsearchUserCommentsWithId
/api/user/comment/searchSearches user comments with the specified criteria and pagination. - GETretrieveUserCommentsWithId
/api/user/comment/:userIdRetrieves all the comments for the user with the given Id. - GETretrieveUserConsentsWithId
/api/user/consent?userId=stringRetrieves all the consents for a User. - POSTcreateUserConsent
/api/user/consentCreates a single User consent. - GETretrieveUserConsentWithId
/api/user/consent/:userConsentIdRetrieve a single User consent by Id. - PUTupdateUserConsentWithId
/api/user/consent/:userConsentIdUpdates a single User consent by Id.
Showing 300 of 364 endpoints. Fork the collection to see all of them.
API details
- Base URL
http://localhost:9011https://sandbox.fusionauth.io- Authentication
- An API key in the Authorization header
A bearer token in the Authorization header - Operations
- 364 operations on 183 pathsPOST 138GET 107PUT 44DELETE 43PATCH 32
- Response formats
application/json- Description format
- OpenAPI 3.0.3, API version
1.71.0 - Links
- OpenAPI document
- Listed from
- FusionAuth's published OpenAPI description (fusionauth/fusionauth-openapi) (Apache-2.0)
How to test the FusionAuth API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the FusionAuth API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “retrieveJsonWebKeySetWithId” (GET /.well-known/jwks.json), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the FusionAuth API?
This is a FusionAuth server. Find out more at [https://fusionauth.io](https://fusionauth.io). You need to [set up an API… It is listed under Identity & security and has 364 endpoints.
Who publishes the FusionAuth API?
It is listed from FusionAuth's public API description (an OpenAPI document), not published by FusionAuth on Swastik Codes. Anyone who controls fusionauth.io can claim the profile by adding a DNS TXT record.
What is the base URL of the FusionAuth API?
Its description lists 2 base URLs: http://localhost:9011, https://sandbox.fusionauth.io. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the FusionAuth API?
It accepts 2 methods: an API key in the Authorization header; A bearer token in the Authorization header.
How many endpoints does the FusionAuth API have?
364 operations on 183 paths (138 POST, 107 GET, 44 PUT, 43 DELETE, 32 PATCH).
Is forking the FusionAuth API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.