> For AI agents: [llms.txt](https://docs.trustedauth.com/llms.txt) provides a Markdown index of this documentation. # Deprecation Policy As IDaaS evolves, APIs occasionally require changes that modify or remove existing functionality. API stability and backward compatibility remain priorities, but some changes result in breaking behavior. When a breaking change is introduced, a new major version of the API is released and the previous version is deprecated. The deprecated version remains supported until it reaches End of Life and is removed. In some cases, an API is deprecated without a replacement version. ## Definitions - **Breaking Change.** A change to an API that causes failures in the API consumer's application. - **Deprecated.** Tenants using a deprecated API at the time of deprecation can continue to use it. While it remains supported and minimally maintained, no additional functionality is added. - **Migration.** The process by which a customer transitions from using a deprecated API. - **End Of Life Date.** The date an API is removed from IDaaS. - **End Of Life.** The API is removed from IDaaS. Continued use of the API results in errors. ## API migration When an API is deprecated, a migration guide is published to help customers prepare for the End Of Life Date. Migration typically involves replacing the deprecated API call with a new API call and modifying your application's code so that it continues to work with the updated behavior. In rare cases, support for a function may be discontinued without a direct replacement. The migration guide details any required action. Whenever possible, at least a six-month migration window is provided between the End Of Life announcement and the End Of Life Date. This time frame may be shortened in emergencies, such as critical vulnerability remediation or changes required to comply with applicable law or third-party certification standards. In these cases, Entrust provides as much prior notice as is reasonable under the circumstances. See the [Terms of Service](https://www.entrust.com/sites/default/files/documentation/licensingandagreements/identity-as-a-service-schedule.pdf) for more information. See the [Current Deprecations](#current-deprecations) section for a list of all ongoing and past API deprecations. ## Current deprecations The following Administration API operations have been deprecated and have been removed or are currently in the process of being removed: | Deprecated Operation | Replacement Operation | Deprecated | End of Life Date | | ----------------------------- | -------------------------------- | ----------------- | ---------------- | | listAssignedGridsUsingGET | assignedGridsPageUsingPOST | 4.2 (Sep 2018) | 5.10 (Aug 2020) | | auditEventReportUsingPOST | auditEventPageUsingPOST | 4.3 (Oct 2018) | 5.10 (Aug 2020) | | listUnassignedGridsUsingGET | unassignedGridsPageUsingPOST | 4.7 (Mar 2019) | 5.10 (Aug 2020) | | usersUsingGET | usersPagedUsingPOST | 4.3 (Oct 2018) | 5.10 (Aug 2020) | | getTenantsUsingGET | getTenantsPageUsingPOST | 5.8 (Jun 2020) | 5.10 (Aug 2020) | | listAssignedTokensUsingGET | assignedTokensPageUsingPOST | 5.11 (Sep 2020) | 5.14 (Jan 2021) | | listUnassignedTokensUsingGET | unassignedTokensPageUsingPOST | 5.11 (Sep 2020) | 5.14 (Jan 2021) | | groupsUsingGET | groupsPagedUsingPOST | 5.27 (Dec 2022) | 5.31 (Aug 2023) | | getServiceIPAddressesUsingGET | N/A | 5.33 (Feb 2024) | 5.37 (Sept 2024) | | listApplicationInfoUsingGET | N/A | 5.39 (Feb 2025) | 5.43 (Nov 2025) | | createFaceUsingPOST | createFaceAuthenticatorUsingPOST | 5.40 (April 2025) | 5.44 (Jan 2026) | The following Authentication API operations have been deprecated and have been removed or are currently in the process of being removed: | Deprecated Operation | Replacement Operation | Deprecated | End of Life Date | | -------------------------------- | ---------------------- | --------------- | ---------------- | | requestPasskeyChallengeUsingPOST | userChallengeUsingPOST | 5.33 (Feb 2024) | 5.37 (Sept 2024) | Old versions of versioned API operations have been deprecated and are removed with or after the specified release. ### Administration API | Operation | Current Version | Old Versions | End of Life Date | | -------------------------------------- | --------------- | ------------ | ---------------- | | createUserUsingPOST | v3 | v1, v2 | 5.31 (Aug 2023) | | deleteUserUsingDELETE | v3 | v1, v2 | 5.31 (Aug 2023) | | createUsersUsingPOST | v3 | v2 | 5.31 (Aug 2023) | | deleteUsersUsingDELETE | v3 | v2 | 5.31 (Aug 2023) | | userUsingGET | v3 | v1, v2 | 5.31 (Aug 2023) | | userByExternalIdUsingGET | v3 | v1, v2 | 5.31 (Aug 2023) | | usersPagedUsingPOST | v4 | v1, v2, v3 | 5.31 (Aug 2023) | | updateUserUsingPUT | v3 | v1, v2 | 5.31 (Aug 2023) | | updateUsersUsingPUT | v3 | v1, v2 | 5.31 (Aug 2023) | | assignedGridsPage | v3 | v1, v2 | 5.31 (Aug 2023) | | createGridUsingPOST | v2 | v1 | 5.31 (Aug 2023) | | getGridUsingGET | v2 | v1 | 5.31 (Aug 2023) | | getGridBySerialNumberUsingGET | v2 | v1 | 5.31 (Aug 2023) | | deleteGridByDELETE | v2 | v1 | 5.31 (Aug 2023) | | changeGridStateUsingPUT | v2 | v1 | 5.31 (Aug 2023) | | siemAuditEventPageUsingPOST | v2 | v1 | 5.31 (Aug 2023) | | auditEventPageUsingPOST | v2 | v1 | 5.31 (Aug 2023) | | getOTPAuthenticatorSettingsUsingGET | v3 | v1, v2 | 5.31 (Aug 2023) | | updateOTPAuthenticatorSettingsUsingPUT | v3 | v1, v2 | 5.31 (Aug 2023) | | getTenantEntitlementsUsingGET | v4 | v1, v2, v3 | 5.31 (Aug 2023) | | getTenantEntitlementUsingGET | v4 | v1, v2, v3 | 5.31 (Aug 2023) | | setTenantEntitlementUsingPUT | v4 | v1, v2, v3 | 5.31 (Aug 2023) | | createTenantUsingPOST | v4 | v1, v2, v3 | 5.31 (Aug 2023) | | getResourceRulesUsingGET | v2 | v1 | 5.37 (Sept 2024) | | createResourceRuleUsingPOST | v2 | v1 | 5.37 (Sept 2024) | | getResourceRulesForResourceUsingGET | v2 | v1 | 5.37 (Sept 2024) | | removeResourceRuleUsingDELETE | v2 | v1 | 5.37 (Sept 2024) | | getResourceRuleUsingGET | v2 | v1 | 5.37 (Sept 2024) | | updateResourceRuleUsingPUT | v2 | v1 | 5.37 (Sept 2024) | | createTenantAsyncUsingPOST | v5 | v4 | 5.39 (Jan 2025) | | createAuthenticationFlowUsingPOST | v2 | v1 | 5.40 (Mar 2025) | | getAuthenticationFlowsUsingGET | v2 | v1 | 5.40 (Mar 2025) | | getAuthenticationFlowUsingGET | v2 | v1 | 5.40 (Mar 2025) | | updateAuthenticationFlowUsingPUT | v2 | v1 | 5.40 (Mar 2025) | | removeAuthenticationFlowUsingDELETE | v2 | v1 | 5.40 (Mar 2025) | #### Deprecated fields | Operation | Model | Deprecated Field | Replacement Field | End of Life Date | Remarks | | ----------------------------- | --------------------- | ---------------- | ----------------- | ---------------- | ---------------------------------------------------------------- | | startFIDORegisterUsingGET | FIDORegisterChallenge | timeout | timoutMillis | 5.47 (July 2026) | Use timeoutMillis directly in milliseconds: no conversion needed | | completeFIDORegisterUsingPOST | FIDORegisterResponse | userIdStored | -- | 5.47 (July 2026) | Parameter is to be permanently removed, no replacement required. | ### Authentication API | Operation | Current Version | Old Versions | End of Life Date | | ------------------------------- | --------------- | ------------ | ---------------- | | userAuthenticatorQueryUsingPOST | v2 | v1 | 5.31 (Aug 2023) | | userChallengeUsingPOST | v2 | v1 | 5.31 (Aug 2023) | #### Deprecated Fields | Operation | Model | Deprecated Field | Replacement Field | End of Life Date | Remarks | | ------------------------------- | ------------------------------- | ---------------- | ----------------- | ----------------- | ---------------------------------------------------------------------- | | userChallengeUsingPOST | UserChallengeParameters | origin | rpId | 5.46 (March 2026) | rpId parameter expects only domain, no https scheme (e.g. example.com) | | userChallengeUsingPOST | FidoChallenge | timeout | timoutMillis | 5.46 (March 2026) | Use timeoutMillis directly in milliseconds: no conversion needed | | userAuthenticateUsingPOST | UserAuthenticateParameters | origin | rpId | 5.46 (March 2026) | rpId parameter expects only domain, no https scheme (e.g. example.com) | | userAuthenticatorQueryUsingPOST | UserAuthenticateQueryParameters | origin | rpId | 5.46 (March 2026) | rpId parameter expects only domain, no https scheme (e.g. example.com) | ## Details --- ### List assigned grids (listAssignedGridsUsingGET) This operation has been deprecated in favor of the paginated endpoint for assigned grid cards. The replacement returns one page of results at a time and supports search and sort options. ### List unassigned grids (listUnassignedGridsUsingGET) This operation has been deprecated in favor of the paginated endpoint for unassigned grid cards. The replacement returns one page of results at a time and supports search and sort options. ### List audit event (auditEventReportUsingPOST) This operation has been deprecated in favor of the paginated audit events endpoint. The replacement returns one page of results at a time and supports search and sort options. ### List all users (usersUsingGET) This operation has been deprecated in favor of the paginated users endpoint. The replacement returns one page of results at a time and supports search and sort options. ### Get all tenants (getTenantsUsingGET) This operation has been deprecated in favor of the paginated tenants endpoint. The replacement returns one page of results at a time and supports search and sort options. ### List assigned tokens (listAssignedTokensUsingGET) This operation has been deprecated in favor of the paginated endpoint for assigned hardware tokens. The replacement returns one page of results at a time and supports search and sort options. ### List unassigned tokens (listUnassignedTokensUsingGET) This operation has been deprecated in favor of the paginated endpoint for unassigned hardware tokens. The replacement returns one page of results at a time and supports search and sort options. ### List groups (groupsUsingGET) This operation has been deprecated in favor of the paginated groups endpoint. The replacement returns one page of results at a time and supports search and sort options. ### Create face authenticator (createFaceUsingPOST) This operation has been deprecated in favor of a newer endpoint that supports both web and mobile Face Authenticator creation.