diff --git a/docs/classes/FusionAuth-BodyHandler.html b/docs/classes/FusionAuth-BodyHandler.html index 16204d1..b3b58ed 100644 --- a/docs/classes/FusionAuth-BodyHandler.html +++ b/docs/classes/FusionAuth-BodyHandler.html @@ -118,6 +118,7 @@

+

Table of Contents @@ -140,19 +141,19 @@

- body() + body()  : string
- bodyObject() + bodyObject()  : mixed
- setHeaders() + setHeaders()  : mixed
@@ -199,6 +200,7 @@

+ @@ -240,6 +242,7 @@

+ @@ -280,6 +283,7 @@

+

Parameters
@@ -411,9 +415,9 @@
Parameters
  • Methods
    • diff --git a/docs/classes/FusionAuth-ClientResponse.html b/docs/classes/FusionAuth-ClientResponse.html index c84fe7d..3fe708c 100644 --- a/docs/classes/FusionAuth-ClientResponse.html +++ b/docs/classes/FusionAuth-ClientResponse.html @@ -127,6 +127,7 @@

    +

    Table of Contents @@ -148,37 +149,37 @@

    - $errorResponse + $errorResponse  : mixed
    - $exception + $exception  : mixed
    - $method + $method  : mixed
    - $request + $request  : mixed
    - $status + $status  : mixed
    - $successResponse + $successResponse  : mixed
    @@ -192,13 +193,13 @@

    - __construct() + __construct()  : mixed
    - wasSuccessful() + wasSuccessful()  : mixed
    @@ -238,6 +239,7 @@

    + public mixed @@ -273,6 +275,7 @@

    + public mixed @@ -308,6 +311,7 @@

    + public mixed @@ -343,6 +347,7 @@

    + public mixed @@ -378,6 +383,7 @@

    + public mixed @@ -413,6 +419,7 @@

    + public mixed @@ -462,6 +469,7 @@

    + @@ -495,6 +503,7 @@

    + @@ -613,20 +622,20 @@

  • Properties
  • Methods
    • diff --git a/docs/classes/FusionAuth-FormDataBodyHandler.html b/docs/classes/FusionAuth-FormDataBodyHandler.html index 8105693..ef042c5 100644 --- a/docs/classes/FusionAuth-FormDataBodyHandler.html +++ b/docs/classes/FusionAuth-FormDataBodyHandler.html @@ -130,6 +130,7 @@

    +

    Table of Contents @@ -158,13 +159,13 @@

    - $body + $body  : mixed
    - $bodyObject + $bodyObject  : mixed
    @@ -178,25 +179,25 @@

    - __construct() + __construct()  : mixed
    - body() + body()  : string
    - bodyObject() + bodyObject()  : mixed
    - setHeaders() + setHeaders()  : mixed
    @@ -237,6 +238,7 @@

    + private mixed @@ -272,6 +274,7 @@

    + private mixed @@ -319,6 +322,7 @@

    +

    Parameters
    @@ -364,6 +368,7 @@

    + @@ -405,6 +410,7 @@

    + @@ -445,6 +451,7 @@

    +

    Parameters
    @@ -577,18 +584,18 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/FusionAuth-FusionAuthClient.html b/docs/classes/FusionAuth-FusionAuthClient.html index bee3eb5..03eb42b 100644 --- a/docs/classes/FusionAuth-FusionAuthClient.html +++ b/docs/classes/FusionAuth-FusionAuthClient.html @@ -121,6 +121,7 @@

    Client that connects to a FusionAuth server and provides access to the full set of FusionAuth APIs.

    +

    When any method is called the return value is always a ClientResponse object. When an API call was successful, the response will contain the response from the server. This might be empty or contain an success object or an error @@ -172,31 +173,31 @@

    - $connectTimeout + $connectTimeout  : int
    - $readTimeout + $readTimeout  : int
    - $apiKey + $apiKey  : string
    - $baseURL + $baseURL  : string
    - $tenantId + $tenantId  : string
    @@ -210,13 +211,13 @@

    - __construct() + __construct()  : mixed
    - actionUser() + actionUser()  : ClientResponse
    @@ -224,35 +225,35 @@

    "actioner". Both user ids are required in the request object.
    - activateReactor() + activateReactor()  : ClientResponse
    Activates the FusionAuth Reactor using a license Id and optionally a license text (for air-gapped deployments)
    - addUserToFamily() + addUserToFamily()  : ClientResponse
    Adds a user to an existing family. The family Id must be specified.
    - approveDevice() + approveDevice()  : ClientResponse
    Approve a device grant.
    - cancelAction() + cancelAction()  : ClientResponse
    Cancels the user action.
    - changePassword() + changePassword()  : ClientResponse
    @@ -260,7 +261,7 @@

    and they clicked on a link to reset their password.
    - changePasswordByIdentity() + changePasswordByIdentity()  : ClientResponse
    @@ -269,84 +270,84 @@

    method.
    - checkChangePasswordUsingId() + checkChangePasswordUsingId()  : ClientResponse
    Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
    - checkChangePasswordUsingJWT() + checkChangePasswordUsingJWT()  : ClientResponse
    Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
    - checkChangePasswordUsingLoginId() + checkChangePasswordUsingLoginId()  : ClientResponse
    Check to see if the user must obtain a Trust Request Id in order to complete a change password request.
    - clientCredentialsGrant() + clientCredentialsGrant()  : ClientResponse
    Make a Client Credentials grant request to obtain an access token.
    - commentOnUser() + commentOnUser()  : ClientResponse
    Adds a comment to the user's account.
    - completeWebAuthnAssertion() + completeWebAuthnAssertion()  : ClientResponse
    Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge without logging the user in
    - completeWebAuthnLogin() + completeWebAuthnLogin()  : ClientResponse
    Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge and then login the user in
    - completeWebAuthnRegistration() + completeWebAuthnRegistration()  : ClientResponse
    Complete a WebAuthn registration ceremony by validating the client request and saving the new credential
    - createAPIKey() + createAPIKey()  : ClientResponse
    Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated.
    - createApplication() + createApplication()  : ClientResponse
    Creates an application. You can optionally specify an Id for the application, if not provided one will be generated.
    - createApplicationRole() + createApplicationRole()  : ClientResponse
    Creates a new role for an application. You must specify the Id of the application you are creating the role for.
    - createAuditLog() + createAuditLog()  : ClientResponse
    @@ -355,49 +356,49 @@

    written to the audit log. However, if you are accessing the API, you must write the audit logs yourself.
    - createConnector() + createConnector()  : ClientResponse
    Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated.
    - createConsent() + createConsent()  : ClientResponse
    Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.
    - createEmailTemplate() + createEmailTemplate()  : ClientResponse
    Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
    - createEntity() + createEntity()  : ClientResponse
    Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated.
    - createEntityType() + createEntityType()  : ClientResponse
    Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated.
    - createEntityTypePermission() + createEntityTypePermission()  : ClientResponse
    Creates a new permission for an entity type. You must specify the Id of the entity type you are creating the permission for.
    - createFamily() + createFamily()  : ClientResponse
    @@ -405,98 +406,98 @@

    family, if not provided one will be generated.
    - createForm() + createForm()  : ClientResponse
    Creates a form. You can optionally specify an Id for the form, if not provided one will be generated.
    - createFormField() + createFormField()  : ClientResponse
    Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated.
    - createGroup() + createGroup()  : ClientResponse
    Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
    - createGroupMembers() + createGroupMembers()  : ClientResponse
    Creates a member in a group.
    - createIdentityProvider() + createIdentityProvider()  : ClientResponse
    Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.
    - createIPAccessControlList() + createIPAccessControlList()  : ClientResponse
    Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.
    - createLambda() + createLambda()  : ClientResponse
    Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated.
    - createMessageTemplate() + createMessageTemplate()  : ClientResponse
    Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated.
    - createMessenger() + createMessenger()  : ClientResponse
    Creates a messenger. You can optionally specify an Id for the messenger, if not provided one will be generated.
    - createOAuthScope() + createOAuthScope()  : ClientResponse
    Creates a new custom OAuth scope for an application. You must specify the Id of the application you are creating the scope for.
    - createTenant() + createTenant()  : ClientResponse
    Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.
    - createTheme() + createTheme()  : ClientResponse
    Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated.
    - createUser() + createUser()  : ClientResponse
    Creates a user. You can optionally specify an Id for the user, if not provided one will be generated.
    - createUserAction() + createUserAction()  : ClientResponse
    @@ -504,7 +505,7 @@

    that the user action can be applied to any user.
    - createUserActionReason() + createUserActionReason()  : ClientResponse
    @@ -512,77 +513,77 @@

    successfully. Anytime after that the user action reason can be used.
    - createUserConsent() + createUserConsent()  : ClientResponse
    Creates a single User consent.
    - createUserLink() + createUserLink()  : ClientResponse
    Link an external user from a 3rd party identity provider to a FusionAuth user.
    - createWebhook() + createWebhook()  : ClientResponse
    Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
    - deactivateApplication() + deactivateApplication()  : ClientResponse
    Deactivates the application with the given Id.
    - deactivateReactor() + deactivateReactor()  : ClientResponse
    Deactivates the FusionAuth Reactor.
    - deactivateUser() + deactivateUser()  : ClientResponse
    Deactivates the user with the given Id.
    - deactivateUserAction() + deactivateUserAction()  : ClientResponse
    Deactivates the user action with the given Id.
    - deactivateUsers() + deactivateUsers()  : ClientResponse
    Deactivates the users with the given ids.
    - deactivateUsersByIds() + deactivateUsersByIds()  : ClientResponse
    Deactivates the users with the given ids.
    - deleteAPIKey() + deleteAPIKey()  : ClientResponse
    Deletes the API key for the given Id.
    - deleteApplication() + deleteApplication()  : ClientResponse
    @@ -592,7 +593,7 @@

    long time, depending on the amount of data in your database.
    - deleteApplicationRole() + deleteApplicationRole()  : ClientResponse
    @@ -600,49 +601,49 @@

    permanently removes the given role from all users that had it.
    - deleteConnector() + deleteConnector()  : ClientResponse
    Deletes the connector for the given Id.
    - deleteConsent() + deleteConsent()  : ClientResponse
    Deletes the consent for the given Id.
    - deleteEmailTemplate() + deleteEmailTemplate()  : ClientResponse
    Deletes the email template for the given Id.
    - deleteEntity() + deleteEntity()  : ClientResponse
    Deletes the Entity for the given Id.
    - deleteEntityGrant() + deleteEntityGrant()  : ClientResponse
    Deletes an Entity Grant for the given User or Entity.
    - deleteEntityType() + deleteEntityType()  : ClientResponse
    Deletes the Entity Type for the given Id.
    - deleteEntityTypePermission() + deleteEntityTypePermission()  : ClientResponse
    @@ -650,98 +651,98 @@

    permanently removes the given permission from all grants that had it.
    - deleteForm() + deleteForm()  : ClientResponse
    Deletes the form for the given Id.
    - deleteFormField() + deleteFormField()  : ClientResponse
    Deletes the form field for the given Id.
    - deleteGroup() + deleteGroup()  : ClientResponse
    Deletes the group for the given Id.
    - deleteGroupMembers() + deleteGroupMembers()  : ClientResponse
    Removes users as members of a group.
    - deleteIdentityProvider() + deleteIdentityProvider()  : ClientResponse
    Deletes the identity provider for the given Id.
    - deleteIPAccessControlList() + deleteIPAccessControlList()  : ClientResponse
    Deletes the IP Access Control List for the given Id.
    - deleteKey() + deleteKey()  : ClientResponse
    Deletes the key for the given Id.
    - deleteLambda() + deleteLambda()  : ClientResponse
    Deletes the lambda for the given Id.
    - deleteMessageTemplate() + deleteMessageTemplate()  : ClientResponse
    Deletes the message template for the given Id.
    - deleteMessenger() + deleteMessenger()  : ClientResponse
    Deletes the messenger for the given Id.
    - deleteOAuthScope() + deleteOAuthScope()  : ClientResponse
    Hard deletes a custom OAuth scope.
    - deleteRegistration() + deleteRegistration()  : ClientResponse
    Deletes the user registration for the given user and application.
    - deleteRegistrationWithRequest() + deleteRegistrationWithRequest()  : ClientResponse
    Deletes the user registration for the given user and application along with the given JSON body that contains the event information.
    - deleteTenant() + deleteTenant()  : ClientResponse
    @@ -749,14 +750,14 @@

    with the tenant and everything under the tenant (applications, users, etc).
    - deleteTenantAsync() + deleteTenantAsync()  : ClientResponse
    Deletes the tenant for the given Id asynchronously.
    - deleteTenantWithRequest() + deleteTenantWithRequest()  : ClientResponse
    @@ -764,14 +765,14 @@

    with the tenant and everything under the tenant (applications, users, etc).
    - deleteTheme() + deleteTheme()  : ClientResponse
    Deletes the theme for the given Id.
    - deleteUser() + deleteUser()  : ClientResponse
    @@ -779,7 +780,7 @@

    with the user.
    - deleteUserAction() + deleteUserAction()  : ClientResponse
    @@ -787,35 +788,35 @@

    the action being applied to any users.
    - deleteUserActionReason() + deleteUserActionReason()  : ClientResponse
    Deletes the user action reason for the given Id.
    - deleteUserLink() + deleteUserLink()  : ClientResponse
    Remove an existing link that has been made from a 3rd party identity provider to a FusionAuth user.
    - deleteUsers() + deleteUsers()  : ClientResponse
    Deletes the users with the given ids, or users matching the provided JSON query or queryString.
    - deleteUsersByQuery() + deleteUsersByQuery()  : ClientResponse
    Deletes the users with the given ids, or users matching the provided JSON query or queryString.
    - deleteUserWithRequest() + deleteUserWithRequest()  : ClientResponse
    @@ -823,84 +824,84 @@

    with the user.
    - deleteWebAuthnCredential() + deleteWebAuthnCredential()  : ClientResponse
    Deletes the WebAuthn credential for the given Id.
    - deleteWebhook() + deleteWebhook()  : ClientResponse
    Deletes the webhook for the given Id.
    - disableTwoFactor() + disableTwoFactor()  : ClientResponse
    Disable two-factor authentication for a user.
    - disableTwoFactorWithRequest() + disableTwoFactorWithRequest()  : ClientResponse
    Disable two-factor authentication for a user using a JSON body rather than URL parameters.
    - enableTwoFactor() + enableTwoFactor()  : ClientResponse
    Enable two-factor authentication for a user.
    - exchangeOAuthCodeForAccessToken() + exchangeOAuthCodeForAccessToken()  : ClientResponse
    Exchanges an OAuth authorization code for an access token.
    - exchangeOAuthCodeForAccessTokenUsingPKCE() + exchangeOAuthCodeForAccessTokenUsingPKCE()  : ClientResponse
    Exchanges an OAuth authorization code and code_verifier for an access token.
    - exchangeRefreshTokenForAccessToken() + exchangeRefreshTokenForAccessToken()  : ClientResponse
    Exchange a Refresh Token for an Access Token.
    - exchangeRefreshTokenForJWT() + exchangeRefreshTokenForJWT()  : ClientResponse
    Exchange a refresh token for a new JWT.
    - exchangeUserCredentialsForAccessToken() + exchangeUserCredentialsForAccessToken()  : ClientResponse
    Exchange User Credentials for a Token.
    - forgotPassword() + forgotPassword()  : ClientResponse
    Begins the forgot password sequence, which kicks off an email to the user so that they can reset their password.
    - generateEmailVerificationId() + generateEmailVerificationId()  : ClientResponse
    @@ -908,14 +909,14 @@

    email to the User. This API may be used to collect the verificationId for use with a third party system.
    - generateKey() + generateKey()  : ClientResponse
    Generate a new RSA or EC key pair or an HMAC secret.
    - generateRegistrationVerificationId() + generateRegistrationVerificationId()  : ClientResponse
    @@ -923,14 +924,14 @@

    email to the User. This API may be used to collect the verificationId for use with a third party system.
    - generateTwoFactorRecoveryCodes() + generateTwoFactorRecoveryCodes()  : ClientResponse
    Generate two-factor recovery codes for a user. Generating two-factor recovery codes will invalidate any existing recovery codes.
    - generateTwoFactorSecret() + generateTwoFactorSecret()  : ClientResponse
    @@ -939,7 +940,7 @@

    application such as Google Authenticator.
    - generateTwoFactorSecretUsingJWT() + generateTwoFactorSecretUsingJWT()  : ClientResponse
    @@ -948,7 +949,7 @@

    application such as Google Authenticator.
    - identityProviderLogin() + identityProviderLogin()  : ClientResponse
    @@ -956,14 +957,14 @@

    login systems.
    - importKey() + importKey()  : ClientResponse
    Import an existing RSA or EC key pair or an HMAC secret.
    - importRefreshTokens() + importRefreshTokens()  : ClientResponse
    @@ -972,7 +973,7 @@

    Application. This is done to increases the insert performance.
    - importUsers() + importUsers()  : ClientResponse
    @@ -981,28 +982,28 @@

    increases the insert performance.
    - importWebAuthnCredential() + importWebAuthnCredential()  : ClientResponse
    Import a WebAuthn credential
    - introspectAccessToken() + introspectAccessToken()  : ClientResponse
    Inspect an access token issued as the result of the User based grant such as the Authorization Code Grant, Implicit Grant, the User Credentials Grant or the Refresh Grant.
    - introspectClientCredentialsAccessToken() + introspectClientCredentialsAccessToken()  : ClientResponse
    Inspect an access token issued as the result of the Client Credentials Grant.
    - issueJWT() + issueJWT()  : ClientResponse
    @@ -1010,14 +1011,14 @@

    access token is properly signed and not expired.
    - login() + login()  : ClientResponse
    Authenticates a user to FusionAuth.
    - loginPing() + loginPing()  : ClientResponse
    @@ -1027,7 +1028,7 @@

    reporting.
    - loginPingWithRequest() + loginPingWithRequest()  : ClientResponse
    @@ -1037,7 +1038,7 @@

    reporting.
    - logout() + logout()  : ClientResponse
    @@ -1046,7 +1047,7 @@

    token or refresh token cookies.
    - logoutWithRequest() + logoutWithRequest()  : ClientResponse
    @@ -1054,7 +1055,7 @@

    client and revoke the refresh token stored. This API takes the refresh token in the JSON body.
    - lookupIdentityProvider() + lookupIdentityProvider()  : ClientResponse
    @@ -1062,7 +1063,7 @@

    by a registered identity provider. A 404 indicates the domain is not managed.
    - modifyAction() + modifyAction()  : ClientResponse
    @@ -1070,196 +1071,196 @@

    action.
    - passwordlessLogin() + passwordlessLogin()  : ClientResponse
    Complete a login request using a passwordless code
    - patchAPIKey() + patchAPIKey()  : ClientResponse
    Updates an authentication API key by given id
    - patchApplication() + patchApplication()  : ClientResponse
    Updates, via PATCH, the application with the given Id.
    - patchApplicationRole() + patchApplicationRole()  : ClientResponse
    Updates, via PATCH, the application role with the given Id for the application.
    - patchConnector() + patchConnector()  : ClientResponse
    Updates, via PATCH, the connector with the given Id.
    - patchConsent() + patchConsent()  : ClientResponse
    Updates, via PATCH, the consent with the given Id.
    - patchEmailTemplate() + patchEmailTemplate()  : ClientResponse
    Updates, via PATCH, the email template with the given Id.
    - patchEntityType() + patchEntityType()  : ClientResponse
    Updates, via PATCH, the Entity Type with the given Id.
    - patchGroup() + patchGroup()  : ClientResponse
    Updates, via PATCH, the group with the given Id.
    - patchIdentityProvider() + patchIdentityProvider()  : ClientResponse
    Updates, via PATCH, the identity provider with the given Id.
    - patchIntegrations() + patchIntegrations()  : ClientResponse
    Updates, via PATCH, the available integrations.
    - patchLambda() + patchLambda()  : ClientResponse
    Updates, via PATCH, the lambda with the given Id.
    - patchMessageTemplate() + patchMessageTemplate()  : ClientResponse
    Updates, via PATCH, the message template with the given Id.
    - patchMessenger() + patchMessenger()  : ClientResponse
    Updates, via PATCH, the messenger with the given Id.
    - patchOAuthScope() + patchOAuthScope()  : ClientResponse
    Updates, via PATCH, the custom OAuth scope with the given Id for the application.
    - patchRegistration() + patchRegistration()  : ClientResponse
    Updates, via PATCH, the registration for the user with the given Id and the application defined in the request.
    - patchSystemConfiguration() + patchSystemConfiguration()  : ClientResponse
    Updates, via PATCH, the system configuration.
    - patchTenant() + patchTenant()  : ClientResponse
    Updates, via PATCH, the tenant with the given Id.
    - patchTheme() + patchTheme()  : ClientResponse
    Updates, via PATCH, the theme with the given Id.
    - patchUser() + patchUser()  : ClientResponse
    Updates, via PATCH, the user with the given Id.
    - patchUserAction() + patchUserAction()  : ClientResponse
    Updates, via PATCH, the user action with the given Id.
    - patchUserActionReason() + patchUserActionReason()  : ClientResponse
    Updates, via PATCH, the user action reason with the given Id.
    - patchUserConsent() + patchUserConsent()  : ClientResponse
    Updates, via PATCH, a single User consent by Id.
    - reactivateApplication() + reactivateApplication()  : ClientResponse
    Reactivates the application with the given Id.
    - reactivateUser() + reactivateUser()  : ClientResponse
    Reactivates the user with the given Id.
    - reactivateUserAction() + reactivateUserAction()  : ClientResponse
    Reactivates the user action with the given Id.
    - reconcileJWT() + reconcileJWT()  : ClientResponse
    Reconcile a User to FusionAuth using JWT issued from another Identity Provider.
    - refreshEntitySearchIndex() + refreshEntitySearchIndex()  : ClientResponse
    @@ -1269,7 +1270,7 @@

    ensure the index immediately current before making a query request to the search index.
    - refreshUserSearchIndex() + refreshUserSearchIndex()  : ClientResponse
    @@ -1279,14 +1280,14 @@

    ensure the index immediately current before making a query request to the search index.
    - regenerateReactorKeys() + regenerateReactorKeys()  : ClientResponse
    Regenerates any keys that are used by the FusionAuth Reactor.
    - register() + register()  : ClientResponse
    @@ -1297,7 +1298,7 @@

    used for the newly created User.
    - reindex() + reindex()  : ClientResponse
    @@ -1306,21 +1307,21 @@

    instructed by FusionAuth support, or if you are migrating a database another system and you are not brining along the Elasticsearch index.
    - removeUserFromFamily() + removeUserFromFamily()  : ClientResponse
    Removes a user from the family with the given id.
    - resendEmailVerification() + resendEmailVerification()  : ClientResponse
    Re-sends the verification email to the user.
    - resendEmailVerificationWithApplicationTemplate() + resendEmailVerificationWithApplicationTemplate()  : ClientResponse
    @@ -1328,21 +1329,21 @@

    instead of the tenant configuration.
    - resendRegistrationVerification() + resendRegistrationVerification()  : ClientResponse
    Re-sends the application registration verification email to the user.
    - retrieveAction() + retrieveAction()  : ClientResponse
    Retrieves a single action log (the log of a user action that was taken on a user previously) for the given Id.
    - retrieveActions() + retrieveActions()  : ClientResponse
    @@ -1350,77 +1351,77 @@

    and inactive as well as non-time based actions.
    - retrieveActionsPreventingLogin() + retrieveActionsPreventingLogin()  : ClientResponse
    Retrieves all the actions for the user with the given Id that are currently preventing the User from logging in.
    - retrieveActiveActions() + retrieveActiveActions()  : ClientResponse
    Retrieves all the actions for the user with the given Id that are currently active.
    - retrieveAPIKey() + retrieveAPIKey()  : ClientResponse
    Retrieves an authentication API key for the given id
    - retrieveApplication() + retrieveApplication()  : ClientResponse
    Retrieves the application for the given Id or all the applications if the Id is null.
    - retrieveApplications() + retrieveApplications()  : ClientResponse
    Retrieves all the applications.
    - retrieveAuditLog() + retrieveAuditLog()  : ClientResponse
    Retrieves a single audit log for the given Id.
    - retrieveConnector() + retrieveConnector()  : ClientResponse
    Retrieves the connector with the given Id.
    - retrieveConnectors() + retrieveConnectors()  : ClientResponse
    Retrieves all the connectors.
    - retrieveConsent() + retrieveConsent()  : ClientResponse
    Retrieves the Consent for the given Id.
    - retrieveConsents() + retrieveConsents()  : ClientResponse
    Retrieves all the consent.
    - retrieveDailyActiveReport() + retrieveDailyActiveReport()  : ClientResponse
    @@ -1428,14 +1429,14 @@

    return the daily active counts for that application.
    - retrieveEmailTemplate() + retrieveEmailTemplate()  : ClientResponse
    Retrieves the email template for the given Id. If you don't specify the id, this will return all the email templates.
    - retrieveEmailTemplatePreview() + retrieveEmailTemplatePreview()  : ClientResponse
    @@ -1444,112 +1445,112 @@

    will create the preview based on whatever is given.
    - retrieveEmailTemplates() + retrieveEmailTemplates()  : ClientResponse
    Retrieves all the email templates.
    - retrieveEntity() + retrieveEntity()  : ClientResponse
    Retrieves the Entity for the given Id.
    - retrieveEntityGrant() + retrieveEntityGrant()  : ClientResponse
    Retrieves an Entity Grant for the given Entity and User/Entity.
    - retrieveEntityType() + retrieveEntityType()  : ClientResponse
    Retrieves the Entity Type for the given Id.
    - retrieveEntityTypes() + retrieveEntityTypes()  : ClientResponse
    Retrieves all the Entity Types.
    - retrieveEventLog() + retrieveEventLog()  : ClientResponse
    Retrieves a single event log for the given Id.
    - retrieveFamilies() + retrieveFamilies()  : ClientResponse
    Retrieves all the families that a user belongs to.
    - retrieveFamilyMembersByFamilyId() + retrieveFamilyMembersByFamilyId()  : ClientResponse
    Retrieves all the members of a family by the unique Family Id.
    - retrieveForm() + retrieveForm()  : ClientResponse
    Retrieves the form with the given Id.
    - retrieveFormField() + retrieveFormField()  : ClientResponse
    Retrieves the form field with the given Id.
    - retrieveFormFields() + retrieveFormFields()  : ClientResponse
    Retrieves all the forms fields
    - retrieveForms() + retrieveForms()  : ClientResponse
    Retrieves all the forms.
    - retrieveGroup() + retrieveGroup()  : ClientResponse
    Retrieves the group for the given Id.
    - retrieveGroups() + retrieveGroups()  : ClientResponse
    Retrieves all the groups.
    - retrieveIdentityProvider() + retrieveIdentityProvider()  : ClientResponse
    Retrieves the identity provider for the given Id or all the identity providers if the Id is null.
    - retrieveIdentityProviderByType() + retrieveIdentityProviderByType()  : ClientResponse
    @@ -1558,112 +1559,112 @@

    may return multiple identity providers.
    - retrieveIdentityProviders() + retrieveIdentityProviders()  : ClientResponse
    Retrieves all the identity providers.
    - retrieveInactiveActions() + retrieveInactiveActions()  : ClientResponse
    Retrieves all the actions for the user with the given Id that are currently inactive.
    - retrieveInactiveApplications() + retrieveInactiveApplications()  : ClientResponse
    Retrieves all the applications that are currently inactive.
    - retrieveInactiveUserActions() + retrieveInactiveUserActions()  : ClientResponse
    Retrieves all the user actions that are currently inactive.
    - retrieveIntegration() + retrieveIntegration()  : ClientResponse
    Retrieves the available integrations.
    - retrieveIPAccessControlList() + retrieveIPAccessControlList()  : ClientResponse
    Retrieves the IP Access Control List with the given Id.
    - retrieveJsonWebKeySet() + retrieveJsonWebKeySet()  : ClientResponse
    Returns public keys used by FusionAuth to cryptographically verify JWTs using the JSON Web Key format.
    - retrieveJWTPublicKey() + retrieveJWTPublicKey()  : ClientResponse
    Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id (kid).
    - retrieveJWTPublicKeyByApplicationId() + retrieveJWTPublicKeyByApplicationId()  : ClientResponse
    Retrieves the Public Key configured for verifying the JSON Web Tokens (JWT) issued by the Login API by the Application Id.
    - retrieveJWTPublicKeys() + retrieveJWTPublicKeys()  : ClientResponse
    Retrieves all Public Keys configured for verifying JSON Web Tokens (JWT).
    - retrieveKey() + retrieveKey()  : ClientResponse
    Retrieves the key for the given Id.
    - retrieveKeys() + retrieveKeys()  : ClientResponse
    Retrieves all the keys.
    - retrieveLambda() + retrieveLambda()  : ClientResponse
    Retrieves the lambda for the given Id.
    - retrieveLambdas() + retrieveLambdas()  : ClientResponse
    Retrieves all the lambdas.
    - retrieveLambdasByType() + retrieveLambdasByType()  : ClientResponse
    Retrieves all the lambdas for the provided type.
    - retrieveLoginReport() + retrieveLoginReport()  : ClientResponse
    @@ -1671,42 +1672,42 @@

    login counts for that application.
    - retrieveMessageTemplate() + retrieveMessageTemplate()  : ClientResponse
    Retrieves the message template for the given Id. If you don't specify the id, this will return all the message templates.
    - retrieveMessageTemplatePreview() + retrieveMessageTemplatePreview()  : ClientResponse
    Creates a preview of the message template provided in the request, normalized to a given locale.
    - retrieveMessageTemplates() + retrieveMessageTemplates()  : ClientResponse
    Retrieves all the message templates.
    - retrieveMessenger() + retrieveMessenger()  : ClientResponse
    Retrieves the messenger with the given Id.
    - retrieveMessengers() + retrieveMessengers()  : ClientResponse
    Retrieves all the messengers.
    - retrieveMonthlyActiveReport() + retrieveMonthlyActiveReport()  : ClientResponse
    @@ -1714,28 +1715,28 @@

    return the monthly active counts for that application.
    - retrieveOauthConfiguration() + retrieveOauthConfiguration()  : ClientResponse
    Retrieves the Oauth2 configuration for the application for the given Application Id.
    - retrieveOAuthScope() + retrieveOAuthScope()  : ClientResponse
    Retrieves a custom OAuth scope.
    - retrieveOpenIdConfiguration() + retrieveOpenIdConfiguration()  : ClientResponse
    Returns the well known OpenID Configuration JSON document
    - retrievePasswordValidationRules() + retrievePasswordValidationRules()  : ClientResponse
    @@ -1743,70 +1744,70 @@

    through the use of a Tenant scoped API key or an HTTP header X-FusionAuth-TenantId to specify the Tenant Id.
    - retrievePasswordValidationRulesWithTenantId() + retrievePasswordValidationRulesWithTenantId()  : ClientResponse
    Retrieves the password validation rules for a specific tenant.
    - retrievePendingChildren() + retrievePendingChildren()  : ClientResponse
    Retrieves all the children for the given parent email address.
    - retrievePendingLink() + retrievePendingLink()  : ClientResponse
    Retrieve a pending identity provider link. This is useful to validate a pending link and retrieve meta-data about the identity provider link.
    - retrieveReactorMetrics() + retrieveReactorMetrics()  : ClientResponse
    Retrieves the FusionAuth Reactor metrics.
    - retrieveReactorStatus() + retrieveReactorStatus()  : ClientResponse
    Retrieves the FusionAuth Reactor status.
    - retrieveRecentLogins() + retrieveRecentLogins()  : ClientResponse
    Retrieves the last number of login records.
    - retrieveRefreshTokenById() + retrieveRefreshTokenById()  : ClientResponse
    Retrieves 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 you need.
    - retrieveRefreshTokens() + retrieveRefreshTokens()  : ClientResponse
    Retrieves the refresh tokens that belong to the user with the given Id.
    - retrieveRegistration() + retrieveRegistration()  : ClientResponse
    Retrieves the user registration for the user with the given Id and the given application id.
    - retrieveRegistrationReport() + retrieveRegistrationReport()  : ClientResponse
    @@ -1814,7 +1815,7 @@

    the registration counts for that application.
    - retrieveReindexStatus() + retrieveReindexStatus()  : ClientResponse
    @@ -1822,42 +1823,63 @@

    404 indicates no re-index is in progress.
    - retrieveSystemConfiguration() + retrieveSystemConfiguration()  : ClientResponse
    Retrieves the system configuration.
    - retrieveTenant() + retrieveSystemHealth() + +  : ClientResponse +
    +
    Retrieves the FusionAuth system health. This API will return 200 if the system is healthy, and 500 if the system is un-healthy.
    + +
    + retrieveSystemStatus() + +  : ClientResponse +
    +
    Retrieves 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 single value in the JSON response indicating the current health check.
    + +
    + retrieveSystemStatusUsingAPIKey() + +  : ClientResponse +
    +
    Retrieves the FusionAuth system status using an API key. Using an API key will cause the response to include the product version, health checks and various runtime metrics.
    + +
    + retrieveTenant()  : ClientResponse
    Retrieves the tenant for the given Id.
    - retrieveTenants() + retrieveTenants()  : ClientResponse
    Retrieves all the tenants.
    - retrieveTheme() + retrieveTheme()  : ClientResponse
    Retrieves the theme for the given Id.
    - retrieveThemes() + retrieveThemes()  : ClientResponse
    Retrieves all the themes.
    - retrieveTotalReport() + retrieveTotalReport()  : ClientResponse
    @@ -1865,28 +1887,28 @@

    count.
    - retrieveTwoFactorRecoveryCodes() + retrieveTwoFactorRecoveryCodes()  : ClientResponse
    Retrieve two-factor recovery codes for a user.
    - retrieveTwoFactorStatus() + retrieveTwoFactorStatus()  : ClientResponse
    Retrieve a user's two-factor status.
    - retrieveUser() + retrieveUser()  : ClientResponse
    Retrieves the user for the given Id.
    - retrieveUserAction() + retrieveUserAction()  : ClientResponse
    @@ -1894,7 +1916,7 @@

    actions.
    - retrieveUserActionReason() + retrieveUserActionReason()  : ClientResponse
    @@ -1902,21 +1924,21 @@

    action reasons.
    - retrieveUserActionReasons() + retrieveUserActionReasons()  : ClientResponse
    Retrieves all the user action reasons.
    - retrieveUserActions() + retrieveUserActions()  : ClientResponse
    Retrieves all the user actions.
    - retrieveUserByChangePasswordId() + retrieveUserByChangePasswordId()  : ClientResponse
    @@ -1924,28 +1946,28 @@

    password workflow has been initiated and you may not know the user's email or username.
    - retrieveUserByEmail() + retrieveUserByEmail()  : ClientResponse
    Retrieves the user for the given email.
    - retrieveUserByLoginId() + retrieveUserByLoginId()  : ClientResponse
    Retrieves the user for the loginId. The loginId can be either the username or the email.
    - retrieveUserByUsername() + retrieveUserByUsername()  : ClientResponse
    Retrieves the user for the given username.
    - retrieveUserByVerificationId() + retrieveUserByVerificationId()  : ClientResponse
    @@ -1953,63 +1975,63 @@

    password workflow has been initiated and you may not know the user's email or username.
    - retrieveUserCode() + retrieveUserCode()  : ClientResponse
    Retrieve a user_code that is part of an in-progress Device Authorization Grant.
    - retrieveUserCodeUsingAPIKey() + retrieveUserCodeUsingAPIKey()  : ClientResponse
    Retrieve a user_code that is part of an in-progress Device Authorization Grant.
    - retrieveUserComments() + retrieveUserComments()  : ClientResponse
    Retrieves all the comments for the user with the given Id.
    - retrieveUserConsent() + retrieveUserConsent()  : ClientResponse
    Retrieve a single User consent by Id.
    - retrieveUserConsents() + retrieveUserConsents()  : ClientResponse
    Retrieves all the consents for a User.
    - retrieveUserInfoFromAccessToken() + retrieveUserInfoFromAccessToken()  : ClientResponse
    Call the UserInfo endpoint to retrieve User Claims from the access token issued by FusionAuth.
    - retrieveUserLink() + retrieveUserLink()  : ClientResponse
    Retrieve a single Identity Provider user (link).
    - retrieveUserLinksByUserId() + retrieveUserLinksByUserId()  : ClientResponse
    Retrieve all Identity Provider users (links) for the user. Specify the optional identityProviderId to retrieve links for a particular IdP.
    - retrieveUserLoginReport() + retrieveUserLoginReport()  : ClientResponse
    @@ -2017,7 +2039,7 @@

    login counts for that application.
    - retrieveUserLoginReportByLoginId() + retrieveUserLoginReportByLoginId()  : ClientResponse
    @@ -2025,98 +2047,98 @@

    login counts for that application.
    - retrieveUserRecentLogins() + retrieveUserRecentLogins()  : ClientResponse
    Retrieves the last number of login records for a user.
    - retrieveUserUsingJWT() + retrieveUserUsingJWT()  : ClientResponse
    Retrieves the user for the given Id. This method does not use an API key, instead it uses a JSON Web Token (JWT) for authentication.
    - retrieveVersion() + retrieveVersion()  : ClientResponse
    Retrieves the FusionAuth version string.
    - retrieveWebAuthnCredential() + retrieveWebAuthnCredential()  : ClientResponse
    Retrieves the WebAuthn credential for the given Id.
    - retrieveWebAuthnCredentialsForUser() + retrieveWebAuthnCredentialsForUser()  : ClientResponse
    Retrieves all WebAuthn credentials for the given user.
    - retrieveWebhook() + retrieveWebhook()  : ClientResponse
    Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks.
    - retrieveWebhooks() + retrieveWebhooks()  : ClientResponse
    Retrieves all the webhooks.
    - revokeRefreshToken() + revokeRefreshToken()  : ClientResponse
    Revokes refresh tokens.
    - revokeRefreshTokenById() + revokeRefreshTokenById()  : ClientResponse
    Revokes a single refresh token by the unique Id. The unique Id is not sensitive as it cannot be used to obtain another JWT.
    - revokeRefreshTokenByToken() + revokeRefreshTokenByToken()  : ClientResponse
    Revokes a single refresh token by using the actual refresh token value. This refresh token value is sensitive, so be careful with this API request.
    - revokeRefreshTokensByApplicationId() + revokeRefreshTokensByApplicationId()  : ClientResponse
    Revoke all refresh tokens that belong to an application by applicationId.
    - revokeRefreshTokensByUserId() + revokeRefreshTokensByUserId()  : ClientResponse
    Revoke all refresh tokens that belong to a user by user Id.
    - revokeRefreshTokensByUserIdForApplication() + revokeRefreshTokensByUserIdForApplication()  : ClientResponse
    Revoke all refresh tokens that belong to a user by user Id for a specific application by applicationId.
    - revokeRefreshTokensWithRequest() + revokeRefreshTokensWithRequest()  : ClientResponse
    @@ -2124,182 +2146,182 @@

    and is based on the information you provide in the RefreshDeleteRequest object. See that method for additional information.
    - revokeUserConsent() + revokeUserConsent()  : ClientResponse
    Revokes a single User consent by Id.
    - searchApplications() + searchApplications()  : ClientResponse
    Searches applications with the specified criteria and pagination.
    - searchAuditLogs() + searchAuditLogs()  : ClientResponse
    Searches the audit logs with the specified criteria and pagination.
    - searchConsents() + searchConsents()  : ClientResponse
    Searches consents with the specified criteria and pagination.
    - searchEmailTemplates() + searchEmailTemplates()  : ClientResponse
    Searches email templates with the specified criteria and pagination.
    - searchEntities() + searchEntities()  : ClientResponse
    Searches entities with the specified criteria and pagination.
    - searchEntitiesByIds() + searchEntitiesByIds()  : ClientResponse
    Retrieves the entities for the given ids. If any Id is invalid, it is ignored.
    - searchEntityGrants() + searchEntityGrants()  : ClientResponse
    Searches Entity Grants with the specified criteria and pagination.
    - searchEntityTypes() + searchEntityTypes()  : ClientResponse
    Searches the entity types with the specified criteria and pagination.
    - searchEventLogs() + searchEventLogs()  : ClientResponse
    Searches the event logs with the specified criteria and pagination.
    - searchGroupMembers() + searchGroupMembers()  : ClientResponse
    Searches group members with the specified criteria and pagination.
    - searchGroups() + searchGroups()  : ClientResponse
    Searches groups with the specified criteria and pagination.
    - searchIdentityProviders() + searchIdentityProviders()  : ClientResponse
    Searches identity providers with the specified criteria and pagination.
    - searchIPAccessControlLists() + searchIPAccessControlLists()  : ClientResponse
    Searches the IP Access Control Lists with the specified criteria and pagination.
    - searchKeys() + searchKeys()  : ClientResponse
    Searches keys with the specified criteria and pagination.
    - searchLambdas() + searchLambdas()  : ClientResponse
    Searches lambdas with the specified criteria and pagination.
    - searchLoginRecords() + searchLoginRecords()  : ClientResponse
    Searches the login records with the specified criteria and pagination.
    - searchTenants() + searchTenants()  : ClientResponse
    Searches tenants with the specified criteria and pagination.
    - searchThemes() + searchThemes()  : ClientResponse
    Searches themes with the specified criteria and pagination.
    - searchUserComments() + searchUserComments()  : ClientResponse
    Searches user comments with the specified criteria and pagination.
    - searchUsers() + searchUsers()  : ClientResponse
    Retrieves the users for the given ids. If any Id is invalid, it is ignored.
    - searchUsersByIds() + searchUsersByIds()  : ClientResponse
    Retrieves the users for the given ids. If any Id is invalid, it is ignored.
    - searchUsersByQuery() + searchUsersByQuery()  : ClientResponse
    Retrieves the users for the given search criteria and pagination.
    - searchUsersByQueryString() + searchUsersByQueryString()  : ClientResponse
    Retrieves the users for the given search criteria and pagination.
    - searchWebhooks() + searchWebhooks()  : ClientResponse
    Searches webhooks with the specified criteria and pagination.
    - sendEmail() + sendEmail()  : ClientResponse
    @@ -2307,56 +2329,56 @@

    pairs in the email template.
    - sendFamilyRequestEmail() + sendFamilyRequestEmail()  : ClientResponse
    Sends out an email to a parent that they need to register and create a family or need to log in and add a child to their existing family.
    - sendPasswordlessCode() + sendPasswordlessCode()  : ClientResponse
    Send a passwordless authentication code in an email to complete login.
    - sendTwoFactorCode() + sendTwoFactorCode()  : ClientResponse
    Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
    - sendTwoFactorCodeForEnableDisable() + sendTwoFactorCodeForEnableDisable()  : ClientResponse
    Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
    - sendTwoFactorCodeForLogin() + sendTwoFactorCodeForLogin()  : ClientResponse
    Send a Two Factor authentication code to allow the completion of Two Factor authentication.
    - sendTwoFactorCodeForLoginUsingMethod() + sendTwoFactorCodeForLoginUsingMethod()  : ClientResponse
    Send a Two Factor authentication code to allow the completion of Two Factor authentication.
    - startIdentityProviderLogin() + startIdentityProviderLogin()  : ClientResponse
    Begins a login request for a 3rd party login that requires user interaction such as HYPR.
    - startPasswordlessLogin() + startPasswordlessLogin()  : ClientResponse
    @@ -2364,7 +2386,7 @@

    Passwordless Code API or using a mechanism outside of FusionAuth. The passwordless login is completed by using the Passwordless Login API with this code.
    - startTwoFactorLogin() + startTwoFactorLogin()  : ClientResponse
    @@ -2374,252 +2396,252 @@

    API (/api/two-factor/login). with the two-factor identifier and the one-time use code.
    - startWebAuthnLogin() + startWebAuthnLogin()  : ClientResponse
    Start a WebAuthn authentication ceremony by generating a new challenge for the user
    - startWebAuthnRegistration() + startWebAuthnRegistration()  : ClientResponse
    Start a WebAuthn registration ceremony by generating a new challenge for the user
    - twoFactorLogin() + twoFactorLogin()  : ClientResponse
    Complete login using a 2FA challenge
    - updateAPIKey() + updateAPIKey()  : ClientResponse
    Updates an API key by given id
    - updateApplication() + updateApplication()  : ClientResponse
    Updates the application with the given Id.
    - updateApplicationRole() + updateApplicationRole()  : ClientResponse
    Updates the application role with the given Id for the application.
    - updateConnector() + updateConnector()  : ClientResponse
    Updates the connector with the given Id.
    - updateConsent() + updateConsent()  : ClientResponse
    Updates the consent with the given Id.
    - updateEmailTemplate() + updateEmailTemplate()  : ClientResponse
    Updates the email template with the given Id.
    - updateEntity() + updateEntity()  : ClientResponse
    Updates the Entity with the given Id.
    - updateEntityType() + updateEntityType()  : ClientResponse
    Updates the Entity Type with the given Id.
    - updateEntityTypePermission() + updateEntityTypePermission()  : ClientResponse
    Updates the permission with the given Id for the entity type.
    - updateForm() + updateForm()  : ClientResponse
    Updates the form with the given Id.
    - updateFormField() + updateFormField()  : ClientResponse
    Updates the form field with the given Id.
    - updateGroup() + updateGroup()  : ClientResponse
    Updates the group with the given Id.
    - updateGroupMembers() + updateGroupMembers()  : ClientResponse
    Creates a member in a group.
    - updateIdentityProvider() + updateIdentityProvider()  : ClientResponse
    Updates the identity provider with the given Id.
    - updateIntegrations() + updateIntegrations()  : ClientResponse
    Updates the available integrations.
    - updateIPAccessControlList() + updateIPAccessControlList()  : ClientResponse
    Updates the IP Access Control List with the given Id.
    - updateKey() + updateKey()  : ClientResponse
    Updates the key with the given Id.
    - updateLambda() + updateLambda()  : ClientResponse
    Updates the lambda with the given Id.
    - updateMessageTemplate() + updateMessageTemplate()  : ClientResponse
    Updates the message template with the given Id.
    - updateMessenger() + updateMessenger()  : ClientResponse
    Updates the messenger with the given Id.
    - updateOAuthScope() + updateOAuthScope()  : ClientResponse
    Updates the OAuth scope with the given Id for the application.
    - updateRegistration() + updateRegistration()  : ClientResponse
    Updates the registration for the user with the given Id and the application defined in the request.
    - updateSystemConfiguration() + updateSystemConfiguration()  : ClientResponse
    Updates the system configuration.
    - updateTenant() + updateTenant()  : ClientResponse
    Updates the tenant with the given Id.
    - updateTheme() + updateTheme()  : ClientResponse
    Updates the theme with the given Id.
    - updateUser() + updateUser()  : ClientResponse
    Updates the user with the given Id.
    - updateUserAction() + updateUserAction()  : ClientResponse
    Updates the user action with the given Id.
    - updateUserActionReason() + updateUserActionReason()  : ClientResponse
    Updates the user action reason with the given Id.
    - updateUserConsent() + updateUserConsent()  : ClientResponse
    Updates a single User consent by Id.
    - updateWebhook() + updateWebhook()  : ClientResponse
    Updates the webhook with the given Id.
    - upsertEntityGrant() + upsertEntityGrant()  : ClientResponse
    Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity.
    - validateDevice() + validateDevice()  : ClientResponse
    Validates the end-user provided user_code from the user-interaction of the Device Authorization Grant.
    - validateJWT() + validateJWT()  : ClientResponse
    @@ -2627,61 +2649,61 @@

    signed and not expired.
    - vendJWT() + vendJWT()  : ClientResponse
    It's a JWT vending machine!
    - verifyEmail() + verifyEmail()  : ClientResponse
    Confirms a email verification. The Id given is usually from an email sent to the user.
    - verifyEmailAddress() + verifyEmailAddress()  : ClientResponse
    Confirms a user's email address.
    - verifyEmailAddressByUserId() + verifyEmailAddressByUserId()  : ClientResponse
    Administratively verify a user's email address. Use this method to bypass email verification for the user.
    - verifyRegistration() + verifyRegistration()  : ClientResponse
    Confirms an application registration. The Id given is usually from an email sent to the user.
    - verifyUserRegistration() + verifyUserRegistration()  : ClientResponse
    Confirms a user's registration.
    - withTenantId() + withTenantId()  : mixed
    - start() + start()  : mixed
    - startAnonymous() + startAnonymous()  : mixed
    @@ -2721,6 +2743,7 @@

    + public int @@ -2756,6 +2779,7 @@

    + public int @@ -2791,6 +2815,7 @@

    + private string @@ -2826,6 +2851,7 @@

    + private string @@ -2861,6 +2887,7 @@

    + private string @@ -2908,6 +2935,7 @@

    +

    Parameters
    @@ -2960,6 +2988,7 @@

    +

    Parameters
    @@ -3030,6 +3059,7 @@

    +

    Parameters
    @@ -3099,6 +3129,7 @@

    +

    Parameters
    @@ -3177,6 +3208,7 @@

    +

    Parameters
    @@ -3273,6 +3305,7 @@

    +

    Parameters
    @@ -3351,6 +3384,7 @@

    +

    As of version 1.32.2, prefer sending the changePasswordId in the request body. To do this, omit the first parameter, and set the value in the request body.

    @@ -3435,6 +3469,7 @@

    +

    Parameters
    @@ -3503,6 +3538,7 @@

    +

    When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication.

    An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API.

    @@ -3576,6 +3612,7 @@

    +

    When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication.

    An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API.

    @@ -3649,6 +3686,7 @@

    +

    When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Trust Request Id by completing a Two-Factor Step-Up authentication.

    An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API.

    @@ -3723,6 +3761,7 @@

    +

    Parameters
    @@ -3812,6 +3851,7 @@

    +

    Parameters
    @@ -3881,6 +3921,7 @@

    +

    Parameters
    @@ -3950,6 +3991,7 @@

    +

    Parameters
    @@ -4019,6 +4061,7 @@

    +

    Parameters
    @@ -4087,6 +4130,7 @@

    +

    an API key can only be created with equal or lesser authority. An API key cannot create another API key unless it is granted to that API key.

    If an API key is locked to a tenant, it can only create API Keys for that same tenant.

    @@ -4170,6 +4214,7 @@

    +

    Parameters
    @@ -4247,6 +4292,7 @@

    +

    You can optionally specify an Id for the role inside the ApplicationRole object itself, if not provided one will be generated.

    @@ -4339,6 +4385,7 @@

    +

    Parameters
    @@ -4408,6 +4455,7 @@

    +

    Parameters
    @@ -4486,6 +4534,7 @@

    +

    Parameters
    @@ -4564,6 +4613,7 @@

    +

    Parameters
    @@ -4642,6 +4692,7 @@

    +

    Parameters
    @@ -4720,6 +4771,7 @@

    +

    Parameters
    @@ -4797,6 +4849,7 @@

    +

    You can optionally specify an Id for the permission inside the EntityTypePermission object itself, if not provided one will be generated.

    @@ -4888,6 +4941,7 @@

    +

    Parameters
    @@ -4966,6 +5020,7 @@

    +

    Parameters
    @@ -5044,6 +5099,7 @@

    +

    Parameters
    @@ -5122,6 +5178,7 @@

    +

    Parameters
    @@ -5200,6 +5257,7 @@

    +

    Parameters
    @@ -5269,6 +5327,7 @@

    +

    Parameters
    @@ -5347,6 +5406,7 @@

    +

    Parameters
    @@ -5425,6 +5485,7 @@

    +

    Parameters
    @@ -5503,6 +5564,7 @@

    +

    Parameters
    @@ -5581,6 +5643,7 @@

    +

    Parameters
    @@ -5658,6 +5721,7 @@

    +

    You can optionally specify an Id for the OAuth scope on the URL, if not provided one will be generated.

    @@ -5748,6 +5812,7 @@

    +

    Parameters
    @@ -5826,6 +5891,7 @@

    +

    Parameters
    @@ -5904,6 +5970,7 @@

    +

    Parameters
    @@ -5983,6 +6050,7 @@

    +

    Parameters
    @@ -6062,6 +6130,7 @@

    +

    Parameters
    @@ -6140,6 +6209,7 @@

    +

    Parameters
    @@ -6218,6 +6288,7 @@

    +

    Parameters
    @@ -6287,6 +6358,7 @@

    +

    Parameters
    @@ -6365,6 +6437,7 @@

    +

    Parameters
    @@ -6436,6 +6509,7 @@

    +

    Tags @@ -6491,6 +6565,7 @@

    +

    Parameters
    @@ -6560,6 +6635,7 @@

    +

    Parameters
    @@ -6628,6 +6704,14 @@

    +
    + +
    +

    This method has been renamed to deactivateUsersByIds, use that method instead.

    + +
    +
    +

    Parameters
    @@ -6656,15 +6740,6 @@
    Exception - -
    - deprecated -
    -
    - -

    This method has been renamed to deactivateUsersByIds, use that method instead.

    -
    -
    @@ -6707,6 +6782,7 @@

    +

    Parameters
    @@ -6776,6 +6852,7 @@

    +

    Parameters
    @@ -6848,6 +6925,7 @@

    +

    Parameters
    @@ -6918,6 +6996,7 @@

    +

    Parameters
    @@ -6996,6 +7075,7 @@

    +

    Parameters
    @@ -7065,6 +7145,7 @@

    +

    Parameters
    @@ -7134,6 +7215,7 @@

    +

    Parameters
    @@ -7203,6 +7285,7 @@

    +

    Parameters
    @@ -7272,6 +7355,7 @@

    +

    Parameters
    @@ -7359,6 +7443,7 @@

    +

    Parameters
    @@ -7429,6 +7514,7 @@

    +

    Parameters
    @@ -7507,6 +7593,7 @@

    +

    Parameters
    @@ -7576,6 +7663,7 @@

    +

    Parameters
    @@ -7645,6 +7733,7 @@

    +

    Parameters
    @@ -7714,6 +7803,7 @@

    +

    Parameters
    @@ -7783,6 +7873,7 @@

    +

    Parameters
    @@ -7852,6 +7943,7 @@

    +

    Parameters
    @@ -7921,6 +8013,7 @@

    +

    Parameters
    @@ -7990,6 +8083,7 @@

    +

    Parameters
    @@ -8059,6 +8153,7 @@

    +

    Parameters
    @@ -8128,6 +8223,7 @@

    +

    Parameters
    @@ -8196,6 +8292,7 @@

    +

    OAuth workflows that are still requesting the deleted OAuth scope may fail depending on the application's unknown scope policy.

    @@ -8277,6 +8374,7 @@

    +

    Parameters
    @@ -8355,6 +8453,7 @@

    +

    Parameters
    @@ -8443,6 +8542,7 @@

    +

    Parameters
    @@ -8511,6 +8611,7 @@

    +

    This method is helpful if you do not want to wait for the delete operation to complete.

    @@ -8584,6 +8685,7 @@

    +

    Parameters
    @@ -8662,6 +8764,7 @@

    +

    Parameters
    @@ -8732,6 +8835,7 @@

    +

    Parameters
    @@ -8802,6 +8906,7 @@

    +

    Parameters
    @@ -8871,6 +8976,7 @@

    +

    Parameters
    @@ -8940,6 +9046,7 @@

    +

    Parameters
    @@ -9026,6 +9133,14 @@

    +
    + +
    +

    This method has been renamed to deleteUsersByQuery, use that method instead.

    + +
    +
    +

    The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.

    This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body. Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.

    @@ -9058,15 +9173,6 @@
    Exception - -
    - deprecated -
    -
    - -

    This method has been renamed to deleteUsersByQuery, use that method instead.

    -
    -

    @@ -9108,6 +9214,7 @@

    +

    The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.

    This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body. Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.

    @@ -9183,6 +9290,7 @@

    +

    Parameters
    @@ -9261,6 +9369,7 @@

    +

    Parameters
    @@ -9330,6 +9439,7 @@

    +

    Parameters
    @@ -9399,6 +9509,7 @@

    +

    Parameters
    @@ -9486,6 +9597,7 @@

    +

    Parameters
    @@ -9564,6 +9676,7 @@

    +

    Parameters
    @@ -9641,6 +9754,7 @@

    +

    Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token.

    @@ -9740,6 +9854,7 @@

    +

    Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint and a code_verifier for an access token.

    @@ -9848,6 +9963,7 @@

    +

    If you will be using the Refresh Token Grant, you will make a request to the Token endpoint to exchange the user’s refresh token for an access token.

    @@ -9957,6 +10073,7 @@

    +

    Parameters
    @@ -10025,6 +10142,7 @@

    +

    If you will be using the Resource Owner Password Credential Grant, you will make a request to the Token endpoint to exchange the user’s email and password for an access token.

    @@ -10143,6 +10261,7 @@

    +

    Parameters
    @@ -10213,6 +10332,7 @@

    +

    Parameters
    @@ -10282,6 +10402,7 @@

    +

    Parameters
    @@ -10361,6 +10482,7 @@

    +

    Parameters
    @@ -10439,6 +10561,7 @@

    +

    Parameters
    @@ -10512,6 +10635,7 @@

    +

    Tags @@ -10569,6 +10693,7 @@

    +

    Parameters
    @@ -10639,6 +10764,7 @@

    +

    Parameters
    @@ -10709,6 +10835,7 @@

    +

    Parameters
    @@ -10788,6 +10915,7 @@

    +

    Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response body with specific validation errors. This will slow the request down but will allow you to identify the cause of @@ -10864,6 +10992,7 @@

    +

    Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See @@ -10939,6 +11068,7 @@

    +

    Parameters
    @@ -11008,6 +11138,7 @@

    +

    Parameters
    @@ -11086,6 +11217,7 @@

    +

    Parameters
    @@ -11155,6 +11287,7 @@

    +

    This API may be used in an SSO configuration to issue new tokens for another application after the user has obtained a valid token from authentication. @@ -11248,6 +11381,7 @@

    +

    This API optionally requires an API key. See Application.loginConfiguration.requireAuthentication.

    @@ -11323,6 +11457,7 @@

    +

    Parameters
    @@ -11414,6 +11549,7 @@

    +

    Parameters
    @@ -11485,6 +11621,7 @@

    +

    Parameters
    @@ -11566,6 +11703,7 @@

    +

    Parameters
    @@ -11636,6 +11774,7 @@

    +

    Parameters
    @@ -11706,6 +11845,7 @@

    +

    Parameters
    @@ -11784,6 +11924,7 @@

    +

    Parameters
    @@ -11853,6 +11994,7 @@

    +

    Parameters
    @@ -11931,6 +12073,7 @@

    +

    Parameters
    @@ -12009,6 +12152,7 @@

    +

    Parameters
    @@ -12096,6 +12240,7 @@

    +

    Parameters
    @@ -12174,6 +12319,7 @@

    +

    Parameters
    @@ -12252,6 +12398,7 @@

    +

    Parameters
    @@ -12330,6 +12477,7 @@

    +

    Parameters
    @@ -12408,6 +12556,7 @@

    +

    Parameters
    @@ -12486,6 +12635,7 @@

    +

    Parameters
    @@ -12564,6 +12714,7 @@

    +

    Parameters
    @@ -12633,6 +12784,7 @@

    +

    Parameters
    @@ -12711,6 +12863,7 @@

    +

    Parameters
    @@ -12789,6 +12942,7 @@

    +

    Parameters
    @@ -12867,6 +13021,7 @@

    +

    Parameters
    @@ -12954,6 +13109,7 @@

    +

    Parameters
    @@ -13032,6 +13188,7 @@

    +

    Parameters
    @@ -13101,6 +13258,7 @@

    +

    Parameters
    @@ -13179,6 +13337,7 @@

    +

    Parameters
    @@ -13257,6 +13416,7 @@

    +

    Parameters
    @@ -13335,6 +13495,7 @@

    +

    Parameters
    @@ -13413,6 +13574,7 @@

    +

    Parameters
    @@ -13491,6 +13653,7 @@

    +

    Parameters
    @@ -13569,6 +13732,7 @@

    +

    Parameters
    @@ -13638,6 +13802,7 @@

    +

    Parameters
    @@ -13707,6 +13872,7 @@

    +

    Parameters
    @@ -13776,6 +13942,7 @@

    +

    Parameters
    @@ -13850,6 +14017,7 @@

    +

    Tags @@ -13910,6 +14078,7 @@

    +

    Tags @@ -13967,6 +14136,7 @@

    +

    Tags @@ -14026,6 +14196,7 @@

    +

    Parameters
    @@ -14105,6 +14276,7 @@

    +

    You have been warned.

    @@ -14177,6 +14349,7 @@

    +

    Parameters
    @@ -14255,6 +14428,7 @@

    +

    Parameters
    @@ -14325,6 +14499,7 @@

    +

    Parameters
    @@ -14403,6 +14578,7 @@

    +

    Parameters
    @@ -14481,6 +14657,7 @@

    +

    Parameters
    @@ -14551,6 +14728,7 @@

    +

    Parameters
    @@ -14620,6 +14798,7 @@

    +

    Parameters
    @@ -14688,6 +14867,7 @@

    +

    An active action means one that is time based and has not been canceled, and has not ended.

    @@ -14760,6 +14940,7 @@

    +

    Parameters
    @@ -14829,6 +15010,7 @@

    +

    Parameters
    @@ -14900,6 +15082,7 @@

    +

    Tags @@ -14955,6 +15138,7 @@

    +

    Parameters
    @@ -15024,6 +15208,7 @@

    +

    Parameters
    @@ -15095,6 +15280,7 @@

    +

    Tags @@ -15150,6 +15336,7 @@

    +

    Parameters
    @@ -15221,6 +15408,7 @@

    +

    Tags @@ -15277,6 +15465,7 @@

    +

    Parameters
    @@ -15364,6 +15553,7 @@

    +

    Parameters
    @@ -15435,6 +15625,7 @@

    +

    Parameters
    @@ -15506,6 +15697,7 @@

    +

    Tags @@ -15561,6 +15753,7 @@

    +

    Parameters
    @@ -15630,6 +15823,7 @@

    +

    Parameters
    @@ -15717,6 +15911,7 @@

    +

    Parameters
    @@ -15788,6 +15983,7 @@

    +

    Tags @@ -15843,6 +16039,7 @@

    +

    Parameters
    @@ -15912,6 +16109,7 @@

    +

    Parameters
    @@ -15981,6 +16179,7 @@

    +

    Parameters
    @@ -16050,6 +16249,7 @@

    +

    Parameters
    @@ -16119,6 +16319,7 @@

    +

    Parameters
    @@ -16190,6 +16391,7 @@

    +

    Tags @@ -16247,6 +16449,7 @@

    +

    Tags @@ -16302,6 +16505,7 @@

    +

    Parameters
    @@ -16373,6 +16577,7 @@

    +

    Tags @@ -16428,6 +16633,7 @@

    +

    Parameters
    @@ -16499,6 +16705,7 @@

    +

    Parameters
    @@ -16570,6 +16777,7 @@

    +

    Tags @@ -16624,6 +16832,7 @@

    +

    An inactive action means one that is time based and has been canceled or has expired, or is not time based.

    @@ -16698,6 +16907,7 @@

    Tags @@ -16755,6 +16965,7 @@

    +

    Tags @@ -16812,6 +17023,7 @@

    +

    Tags @@ -16867,6 +17079,7 @@

    +

    Parameters
    @@ -16938,6 +17151,7 @@

    +

    Tags @@ -16993,6 +17207,7 @@

    +

    Parameters
    @@ -17062,6 +17277,7 @@

    +

    Parameters
    @@ -17133,6 +17349,7 @@

    +

    Tags @@ -17188,6 +17405,7 @@

    +

    Parameters
    @@ -17259,6 +17477,7 @@

    +

    Tags @@ -17314,6 +17533,7 @@

    +

    Parameters
    @@ -17385,6 +17605,7 @@

    +

    Tags @@ -17440,6 +17661,7 @@

    +

    Parameters
    @@ -17510,6 +17732,7 @@

    +

    Parameters
    @@ -17597,6 +17820,7 @@

    +

    Parameters
    @@ -17666,6 +17890,7 @@

    +

    Parameters
    @@ -17737,6 +17962,7 @@

    +

    Tags @@ -17792,6 +18018,7 @@

    +

    Parameters
    @@ -17863,6 +18090,7 @@

    +

    Tags @@ -17919,6 +18147,7 @@

    +

    Parameters
    @@ -18006,6 +18235,7 @@

    +

    Parameters
    @@ -18075,6 +18305,7 @@

    +

    Parameters
    @@ -18155,6 +18386,7 @@

    +

    Tags @@ -18210,6 +18442,7 @@

    +

    This API does not require an API key.

    @@ -18269,6 +18502,7 @@

    +

    This API does not require an API key.

    @@ -18341,6 +18575,7 @@

    +

    Parameters
    @@ -18410,6 +18645,7 @@

    +

    Parameters
    @@ -18490,6 +18726,7 @@

    +

    Tags @@ -18547,6 +18784,7 @@

    +

    Tags @@ -18602,6 +18840,7 @@

    +

    Parameters
    @@ -18680,6 +18919,7 @@

    +

    Parameters
    @@ -18749,6 +18989,7 @@

    +

    Parameters
    @@ -18818,6 +19059,7 @@

    +

    Parameters
    @@ -18897,6 +19139,7 @@

    +

    Parameters
    @@ -18987,6 +19230,7 @@

    +

    Tags @@ -19044,6 +19288,7 @@

    +

    Tags @@ -19062,6 +19307,180 @@
    +
    +
    Return values
    + ClientResponse + — +

    The ClientResponse.

    +
    + +
    + + +
    +

    + retrieveSystemHealth() + + +

    + + +

    Retrieves the FusionAuth system health. This API will return 200 if the system is healthy, and 500 if the system is un-healthy.

    + + + public + retrieveSystemHealth() : ClientResponse + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + Exception + + +
    +
    + + + +
    +
    Return values
    + ClientResponse + — +

    The ClientResponse.

    +
    + +
    + +
    +
    +

    + retrieveSystemStatus() + + +

    + + +

    Retrieves 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 single value in the JSON response indicating the current health check.

    + + + public + retrieveSystemStatus() : ClientResponse + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + Exception + + +
    +
    + + + +
    +
    Return values
    + ClientResponse + — +

    The ClientResponse.

    +
    + +
    + +
    +
    +

    + retrieveSystemStatusUsingAPIKey() + + +

    + + +

    Retrieves the FusionAuth system status using an API key. Using an API key will cause the response to include the product version, health checks and various runtime metrics.

    + + + public + retrieveSystemStatusUsingAPIKey() : ClientResponse + +
    +
    + + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + Exception + + +
    +
    + + +
    Return values
    ClientResponse @@ -19086,7 +19505,7 @@

    @@ -19099,6 +19518,7 @@

    +

    Parameters
    @@ -19155,7 +19575,7 @@

    @@ -19170,6 +19590,7 @@

    +

    Tags @@ -19212,7 +19633,7 @@

    @@ -19225,6 +19646,7 @@

    +

    Parameters
    @@ -19281,7 +19703,7 @@

    @@ -19296,6 +19718,7 @@

    +

    Tags @@ -19338,7 +19761,7 @@

    @@ -19354,6 +19777,7 @@

    +

    Tags @@ -19396,7 +19820,7 @@

    FusionAuthClient.php : - 4068 + 4110 @@ -19409,6 +19833,7 @@

    +

    Parameters
    @@ -19465,7 +19890,7 @@

    @@ -19477,6 +19902,7 @@

    +

    This can be used to see if a user will need to complete a two-factor challenge to complete a login, and optionally identify the state of the two-factor trust across various applications.

    @@ -19555,7 +19981,7 @@

    @@ -19568,6 +19994,7 @@

    +

    Parameters
    @@ -19624,7 +20051,7 @@

    @@ -19638,6 +20065,7 @@

    +

    Parameters
    @@ -19694,7 +20122,7 @@

    @@ -19708,6 +20136,7 @@

    +

    Parameters
    @@ -19764,7 +20193,7 @@

    @@ -19779,6 +20208,7 @@

    +

    Tags @@ -19821,7 +20251,7 @@

    @@ -19836,6 +20266,7 @@

    +

    Tags @@ -19878,7 +20309,7 @@

    FusionAuthClient.php : - 4186 + 4228 @@ -19892,6 +20323,7 @@

    +

    Parameters
    @@ -19948,7 +20380,7 @@

    @@ -19961,6 +20393,7 @@

    +

    Parameters
    @@ -20017,7 +20450,7 @@

    @@ -20030,6 +20463,7 @@

    +

    Parameters
    @@ -20086,7 +20520,7 @@

    @@ -20099,6 +20533,7 @@

    +

    Parameters
    @@ -20155,7 +20590,7 @@

    FusionAuthClient.php : - 4251 + 4293 @@ -20169,6 +20604,7 @@

    +

    Parameters
    @@ -20225,7 +20661,7 @@

    @@ -20237,6 +20673,7 @@

    +

    This API is useful if you want to build your own login workflow to complete a device grant.

    @@ -20314,7 +20751,7 @@

    @@ -20326,6 +20763,7 @@

    +

    This API is useful if you want to build your own login workflow to complete a device grant.

    This request will require an API key.

    @@ -20386,7 +20824,7 @@

    @@ -20399,6 +20837,7 @@

    +

    Parameters
    @@ -20455,7 +20894,7 @@

    @@ -20468,6 +20907,7 @@

    +

    Parameters
    @@ -20524,7 +20964,7 @@

    @@ -20537,6 +20977,7 @@

    +

    Parameters
    @@ -20593,7 +21034,7 @@

    FusionAuthClient.php : - 4363 + 4405 @@ -20606,6 +21047,7 @@

    +

    Parameters
    @@ -20662,7 +21104,7 @@

    @@ -20675,6 +21117,7 @@

    +

    Parameters
    @@ -20749,7 +21192,7 @@

    @@ -20762,6 +21205,7 @@

    +

    Parameters
    @@ -20827,7 +21271,7 @@

    @@ -20841,6 +21285,7 @@

    +

    Parameters
    @@ -20924,7 +21369,7 @@

    FusionAuthClient.php : - 4444 + 4486 @@ -20938,6 +21383,7 @@

    +

    Parameters
    @@ -21021,7 +21467,7 @@

    @@ -21034,6 +21480,7 @@

    +

    Parameters
    @@ -21108,7 +21555,7 @@

    @@ -21121,6 +21568,7 @@

    +

    Parameters
    @@ -21177,7 +21625,7 @@

    @@ -21192,6 +21640,7 @@

    +

    Tags @@ -21234,7 +21683,7 @@

    @@ -21247,6 +21696,7 @@

    +

    Parameters
    @@ -21303,7 +21753,7 @@

    FusionAuthClient.php : - 4529 + 4571 @@ -21316,6 +21766,7 @@

    +

    Parameters
    @@ -21372,7 +21823,7 @@

    @@ -21385,6 +21836,7 @@

    +

    Parameters
    @@ -21441,7 +21893,7 @@

    @@ -21456,6 +21908,7 @@

    +

    Tags @@ -21498,7 +21951,7 @@

    @@ -21510,6 +21963,7 @@

    +

    Usage examples:

    diff --git a/docs/classes/FusionAuth-JSONBodyHandler.html b/docs/classes/FusionAuth-JSONBodyHandler.html index 9993a99..a6b6aed 100644 --- a/docs/classes/FusionAuth-JSONBodyHandler.html +++ b/docs/classes/FusionAuth-JSONBodyHandler.html @@ -130,6 +130,7 @@

    +

    Table of Contents @@ -158,13 +159,13 @@

    - $body + $body  : mixed
    - $bodyObject + $bodyObject  : mixed
    @@ -178,25 +179,25 @@

    - __construct() + __construct()  : mixed
    - body() + body()  : string
    - bodyObject() + bodyObject()  : mixed
    - setHeaders() + setHeaders()  : mixed
    @@ -237,6 +238,7 @@

    + private mixed @@ -272,6 +274,7 @@

    + private mixed @@ -319,6 +322,7 @@

    +

    Parameters
    @@ -364,6 +368,7 @@

    + @@ -405,6 +410,7 @@

    + @@ -445,6 +451,7 @@

    +

    Parameters
    @@ -577,18 +584,18 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/FusionAuth-JSONResponseHandler.html b/docs/classes/FusionAuth-JSONResponseHandler.html index 88f0253..cdc4e0c 100644 --- a/docs/classes/FusionAuth-JSONResponseHandler.html +++ b/docs/classes/FusionAuth-JSONResponseHandler.html @@ -130,6 +130,7 @@

    +

    Table of Contents @@ -159,7 +160,7 @@

    - call() + call()  : mixed
    @@ -206,6 +207,7 @@

    +

    Parameters
    @@ -346,7 +348,7 @@
    Return values
  • Methods
    • diff --git a/docs/classes/FusionAuth-RESTClient.html b/docs/classes/FusionAuth-RESTClient.html index 7672608..4356267 100644 --- a/docs/classes/FusionAuth-RESTClient.html +++ b/docs/classes/FusionAuth-RESTClient.html @@ -127,6 +127,7 @@

    +

    Table of Contents @@ -148,73 +149,73 @@

    - $bodyHandler + $bodyHandler  : BodyHandler
    - $certificate + $certificate  : string
    - $connectTimeout + $connectTimeout  : int
    - $errorResponseHandler + $errorResponseHandler  : ResponseHandler
    - $headers + $headers  : array<string|int, mixed>
    - $key + $key  : string
    - $method + $method  : string
    - $parameters + $parameters  : array<string|int, mixed>
    - $proxy + $proxy  : array<string|int, mixed>
    - $readTimeout + $readTimeout  : int
    - $successResponseHandler + $successResponseHandler  : ResponseHandler
    - $url + $url  : string
    @@ -228,133 +229,133 @@

    - __construct() + __construct()  : mixed
    - authorization() + authorization()  : mixed
    - basicAuthorization() + basicAuthorization()  : mixed
    - bodyHandler() + bodyHandler()  : mixed
    - certificate() + certificate()  : mixed
    - connectTimeout() + connectTimeout()  : mixed
    - delete() + delete()  : mixed
    - errorResponseHandler() + errorResponseHandler()  : mixed
    - get() + get()  : mixed
    - go() + go()  : mixed
    - header() + header()  : mixed
    - headers() + headers()  : mixed
    - patch() + patch()  : mixed
    - post() + post()  : mixed
    - put() + put()  : mixed
    - readTimeout() + readTimeout()  : mixed
    - successResponseHandler() + successResponseHandler()  : mixed
    - uri() + uri()  : mixed
    - url() + url()  : mixed
    - urlParameter() + urlParameter()  : mixed
    - urlSegment() + urlSegment()  : mixed
    - resetAuthorizationHeaders() + resetAuthorizationHeaders()  : mixed
    @@ -394,6 +395,7 @@

    + public BodyHandler @@ -429,6 +431,7 @@

    + public string @@ -464,6 +467,7 @@

    + public int @@ -499,6 +503,7 @@

    + public ResponseHandler @@ -534,6 +539,7 @@

    + public array<string|int, mixed> @@ -569,6 +575,7 @@

    + public string @@ -604,6 +611,7 @@

    + public string @@ -639,6 +647,7 @@

    + public array<string|int, mixed> @@ -674,6 +683,7 @@

    + public array<string|int, mixed> @@ -709,6 +719,7 @@

    + public int @@ -744,6 +755,7 @@

    + public ResponseHandler @@ -779,6 +791,7 @@

    + public string @@ -828,6 +841,7 @@

    + @@ -859,6 +873,7 @@

    +

    Parameters
    @@ -902,6 +917,7 @@

    +

    Parameters
    @@ -952,6 +968,7 @@

    +

    Parameters
    @@ -995,6 +1012,7 @@

    +

    Parameters
    @@ -1038,6 +1056,7 @@

    +

    Parameters
    @@ -1083,6 +1102,7 @@

    + @@ -1114,6 +1134,7 @@

    +

    Parameters
    @@ -1159,6 +1180,7 @@

    + @@ -1192,6 +1214,7 @@

    + @@ -1223,6 +1246,7 @@

    +

    Parameters
    @@ -1273,6 +1297,7 @@

    +

    Parameters
    @@ -1318,6 +1343,7 @@

    + @@ -1351,6 +1377,7 @@

    + @@ -1384,6 +1411,7 @@

    + @@ -1415,6 +1443,7 @@

    +

    Parameters
    @@ -1458,6 +1487,7 @@

    +

    Parameters
    @@ -1501,6 +1531,7 @@

    +

    Parameters
    @@ -1544,6 +1575,7 @@

    +

    Parameters
    @@ -1587,6 +1619,7 @@

    +

    Parameters
    @@ -1637,6 +1670,7 @@

    +

    Parameters
    @@ -1682,6 +1716,7 @@

    + @@ -1800,46 +1835,46 @@

  • Properties
  • Methods
    • diff --git a/docs/classes/FusionAuth-ResponseHandler.html b/docs/classes/FusionAuth-ResponseHandler.html index 7b1b348..008b11f 100644 --- a/docs/classes/FusionAuth-ResponseHandler.html +++ b/docs/classes/FusionAuth-ResponseHandler.html @@ -118,6 +118,7 @@

    +

    Table of Contents @@ -140,7 +141,7 @@

    - call() + call()  : mixed
    @@ -186,6 +187,7 @@

    +

    Parameters
    @@ -325,7 +327,7 @@
    Return values
  • Methods
    • diff --git a/docs/classes/Tests-FusionAuthClientTest.html b/docs/classes/Tests-FusionAuthClientTest.html index 4f7d760..01404a5 100644 --- a/docs/classes/Tests-FusionAuthClientTest.html +++ b/docs/classes/Tests-FusionAuthClientTest.html @@ -127,6 +127,7 @@

    +

    Tags @@ -167,19 +168,19 @@

    - $applicationId + $applicationId  : string
    - $client + $client  : FusionAuthClient
    - $userId + $userId  : string
    @@ -193,49 +194,49 @@

    - testCanHandleApplications() + testCanHandleApplications()  : void
    - testCanHandleUsers() + testCanHandleUsers()  : void
    - testCanLogoutWithBogusToken() + testCanLogoutWithBogusToken()  : void
    - testCanLogoutWithoutRefreshToken() + testCanLogoutWithoutRefreshToken()  : void
    - testCanLogoutWithRefreshToken() + testCanLogoutWithRefreshToken()  : void
    - setUp() + setUp()  : void
    - tearDown() + tearDown()  : void
    - handleResponse() + handleResponse()  : void
    @@ -275,6 +276,7 @@

    + private string @@ -310,6 +312,7 @@

    + private FusionAuthClient @@ -345,6 +348,7 @@

    + private string @@ -394,6 +398,7 @@

    +

    Tags @@ -442,6 +447,7 @@

    +

    Tags @@ -490,6 +496,7 @@

    +

    Tags @@ -538,6 +545,7 @@

    Tags @@ -586,6 +594,7 @@

    Tags @@ -634,6 +643,7 @@

    + @@ -667,6 +677,7 @@

    + @@ -698,6 +709,7 @@

    +

    Parameters
    @@ -830,23 +842,23 @@
    Parameters
  • Properties
  • Methods
    • diff --git a/docs/css/base.css b/docs/css/base.css index 5c96483..0d1ef2a 100644 --- a/docs/css/base.css +++ b/docs/css/base.css @@ -1216,6 +1216,10 @@ is too big a fix and needs to be done in a new design iteration. word-break: break-all; line-height: normal; } + + .phpdocumentor-on-this-page__content li.-deprecated { + text-decoration: line-through; + } } /* Used for screen readers and such */ diff --git a/docs/css/template.css b/docs/css/template.css index 3351114..ff7a586 100644 --- a/docs/css/template.css +++ b/docs/css/template.css @@ -126,6 +126,10 @@ flex: 0 1 auto; } +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a.-deprecated { + text-decoration: line-through; +} + .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span { flex: 1; white-space: nowrap; diff --git a/docs/files/src-fusionauth-clientresponse.html b/docs/files/src-fusionauth-clientresponse.html index 50d6946..0c15beb 100644 --- a/docs/files/src-fusionauth-clientresponse.html +++ b/docs/files/src-fusionauth-clientresponse.html @@ -102,6 +102,7 @@

    ClientResponse.php

    +

    Table of Contents diff --git a/docs/files/src-fusionauth-fusionauthclient.html b/docs/files/src-fusionauth-fusionauthclient.html index 863dec4..8baff3e 100644 --- a/docs/files/src-fusionauth-fusionauthclient.html +++ b/docs/files/src-fusionauth-fusionauthclient.html @@ -102,6 +102,7 @@

    FusionAuthClient.php

    +

    Table of Contents diff --git a/docs/files/src-fusionauth-restclient.html b/docs/files/src-fusionauth-restclient.html index a703ad4..8c6bf24 100644 --- a/docs/files/src-fusionauth-restclient.html +++ b/docs/files/src-fusionauth-restclient.html @@ -102,6 +102,7 @@

    RESTClient.php

    +

    Table of Contents diff --git a/docs/files/tests-fusionauth-fusionauthclienttest.html b/docs/files/tests-fusionauth-fusionauthclienttest.html index dd1e421..96fb25b 100644 --- a/docs/files/tests-fusionauth-fusionauthclienttest.html +++ b/docs/files/tests-fusionauth-fusionauthclienttest.html @@ -102,6 +102,7 @@

    FusionAuthClientTest.php

    +

    Table of Contents diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js index ae71603..0f16521 100644 --- a/docs/js/searchIndex.js +++ b/docs/js/searchIndex.js @@ -1165,6 +1165,21 @@ Search.appendIndex( "name": "retrieveSystemConfiguration", "summary": "Retrieves\u0020the\u0020system\u0020configuration.", "url": "classes/FusionAuth-FusionAuthClient.html#method_retrieveSystemConfiguration" + }, { + "fqsen": "\\FusionAuth\\FusionAuthClient\u003A\u003AretrieveSystemHealth\u0028\u0029", + "name": "retrieveSystemHealth", + "summary": "Retrieves\u0020the\u0020FusionAuth\u0020system\u0020health.\u0020This\u0020API\u0020will\u0020return\u0020200\u0020if\u0020the\u0020system\u0020is\u0020healthy,\u0020and\u0020500\u0020if\u0020the\u0020system\u0020is\u0020un\u002Dhealthy.", + "url": "classes/FusionAuth-FusionAuthClient.html#method_retrieveSystemHealth" + }, { + "fqsen": "\\FusionAuth\\FusionAuthClient\u003A\u003AretrieveSystemStatus\u0028\u0029", + "name": "retrieveSystemStatus", + "summary": "Retrieves\u0020the\u0020FusionAuth\u0020system\u0020status.\u0020This\u0020request\u0020is\u0020anonymous\u0020and\u0020does\u0020not\u0020require\u0020an\u0020API\u0020key.\u0020When\u0020an\u0020API\u0020key\u0020is\u0020not\u0020provided\u0020the\u0020response\u0020will\u0020contain\u0020a\u0020single\u0020value\u0020in\u0020the\u0020JSON\u0020response\u0020indicating\u0020the\u0020current\u0020health\u0020check.", + "url": "classes/FusionAuth-FusionAuthClient.html#method_retrieveSystemStatus" + }, { + "fqsen": "\\FusionAuth\\FusionAuthClient\u003A\u003AretrieveSystemStatusUsingAPIKey\u0028\u0029", + "name": "retrieveSystemStatusUsingAPIKey", + "summary": "Retrieves\u0020the\u0020FusionAuth\u0020system\u0020status\u0020using\u0020an\u0020API\u0020key.\u0020Using\u0020an\u0020API\u0020key\u0020will\u0020cause\u0020the\u0020response\u0020to\u0020include\u0020the\u0020product\u0020version,\u0020health\u0020checks\u0020and\u0020various\u0020runtime\u0020metrics.", + "url": "classes/FusionAuth-FusionAuthClient.html#method_retrieveSystemStatusUsingAPIKey" }, { "fqsen": "\\FusionAuth\\FusionAuthClient\u003A\u003AretrieveTenant\u0028\u0029", "name": "retrieveTenant", diff --git a/docs/reports/deprecated.html b/docs/reports/deprecated.html index 226e6ea..aea2878 100644 --- a/docs/reports/deprecated.html +++ b/docs/reports/deprecated.html @@ -124,37 +124,37 @@

    FusionAuthClient.php - 5038 + 5080 FusionAuthClient::searchUsers()

    This method has been renamed to searchUsersByIds, use that method instead.

    - 5089 + 5131 FusionAuthClient::searchUsersByQueryString()

    This method has been renamed to searchUsersByQuery, use that method instead.

    - 5173 + 5215 FusionAuthClient::sendTwoFactorCode()

    This method has been renamed to sendTwoFactorCodeForEnableDisable, use that method instead.

    - 5206 + 5248 FusionAuthClient::sendTwoFactorCodeForLogin()

    This method has been renamed to sendTwoFactorCodeForLoginUsingMethod, use that method instead.

    - 5968 + 6010 FusionAuthClient::verifyEmail()

    This method has been renamed to verifyEmailAddress and changed to take a JSON request body, use that method instead.

    - 6024 + 6066 FusionAuthClient::verifyRegistration()

    This method has been renamed to verifyUserRegistration and changed to take a JSON request body, use that method instead.