Migrate to Management API v2

Auth0’s Management API v1 was deprecated in 2016 and replaced with the Auth0 Management API v2. Management API v1 will reach its end-of-life in the Public Cloud on 13 July 2020. Requests will begin failing with a 410 HTTP status code on or after that date. Management API v1 will be included in the Private Cloud until the November 2020 monthly release, which is the first release that will not include Management API v1.

Tenants created after 02 January 2020 will not have access to API v1. If you need API v1 enabled on a tenant for testing your migration, please open a ticket in our Support Center.

Your tenants are affected if they meet all of the following criteria:

Created before 02 January 2020
Actively making requests to Auth0 endpoints directly under the /api/ path from your application.

The following tenants are not affected:

Created on or after 02 January 2020
Exclusively using the Auth0 Management API v2 endpoints
Exclusively using the Authentication API

Deprecation Notices will be recorded in your tenant logs for requests that will fail at API v1’s End of Life. You can search for relevant deprecation notices in your tenant logs with the following query:

type:depnote AND description:*APIv1*

To help identify the application making requests, logs will include the client_id used to make the request. You can also find the endpoint being used in the logs details.path field.

Auth0 SDKs all use Management API v2. If you see API v1 activity from an application that is leveraging an older SDK, you should upgrade to the latest version.

Management API v1 Log Query Example screen

Auth0 generates only one log for each client_id and details.path combination every 60 minutes. No matter how many calls you make to the deprecated endpoints, you will still see a single log per hour for each deprecated endpoint an application calls. If you implement changes to your requests, you'll need to allow 60 minutes to elapse before you can determine that the lack of new depnote logs means the deprecated endpoints have been removed from your code.

The Auth0 AD/LDAP Connector Health Monitor extension v1 uses two API v1 endpoints:

GET /api/connections/{connection-name}
GET /api/connections/{connection-name}/socket

Upgrade to the latest version of the extension before disabling API v1 support.

The Custom Claims Provider of the Auth0 SharePoint Integration leverages three API v1 endpoints :

/api/enterpriseconnections/users
/api/socialconnections/users
/api/connections

If you are calling these endpoints from the SharePoint integration, they will continue to work after the API v1 end-of-life date. You may continue see depnote tenant logs for this activity. If the client_id in the tenant log is a SharePoint application, you can disregard this warning.

If you are calling these endpoints directly from your code, you will need to migrate those calls off of API v1.

After replacing all calls to the Management API v1 with their Management API v2 replacements, confirm that you are no longer seeing deprecation notices in your Tenant Logs and disable the Management API v1 for your tenant.
Go to Tenant Settings > Advanced > Migration in the Auth0 Dashboard. This will simulate the expected behavior after the end-of-life date, causing calls to API v1 to fail with a 410 HTTP status code. You will be able to re-enable API v1 any time before the end-of-life date.

Docs

Migrate to Management API v2

Migrate to Management API v2

Tenants affected

Actions

Verify logs

Migrate Auth0 AD/LDAP Connector Health Monitor extension

Migrate SharePoint Integration Custom Claims Provider

Disable Management API v1

Was this article helpful?