Welcome to the documentation center for User Management APIs from Adobe.

News

July 22, 2024: To provide peace of mind for API integrations, all APIs provided by UMAPI, even those marked as deprecated will continue to be supported for the foreseeable future.

If it becomes apparent that any API, deprecated or otherwise, needs to be retired from service or needs updated with a breaking change, Adobe will provide at least 6 (six) months notice of the change, via UMAPI documentation (this site) and via Developer Console banners.

We will also endeavour to provide 4 weeks notice of any new fields that are being added to responses in order to give time to prepare. As ever, guidance is to ignore any unrecognised or unknown fields in the UMAPI response. Unless it is documented, it should not be relied upon.

Developer support will also work to make customers aware of the upcoming removal of APIs during their regular engagement process.

From Jan 16th 2024, a new query parameter excludeGroups will be available in Get Users by Group to exclude the return of other group membership information for each user.

Further information and examples can be found within the API documentation.

This does not impact existing clients.

From July 25th 2023, a new tags property will be returned as part of a user's response in the following APIs:

Further information can be found within the API documentation. If you ignore unknown fields then you should expect no impact from this change.

On May 9th, 2023, the productName will be updated to include a new structure to help distinguish multiple products with the same name. An example of the structure is <Product Name> (<a list of keywords>). For ETLA customers with a Single App plan (the plan which enables you to choose any one app from a set of available Creative Cloud applications) you may be returned a structure like Photoshop (<keyword1,Single App,keyword2>) where keyword1 and keyword2 could be optional.

As a result, any application directly accessing the User Management API which includes logic dependent on fixed product names will need to be updated. If you have not included fixed product names in the code, then this will not impact your connection to the User Management API. If you use the User Sync Tool, you should see no impact.

If you rely on the name of the “product admin group” (e.g., _product_admin_<product name>) you will also be impacted and have to update your scripts.

You should avoid any logic that expects fixed group names as these are liable to change without notice. We recommend using the Get Groups and Profiles API to fetch the latest group information.

Since May 6th, 2023, User Management API supports OAuth Server-to-Server (S2S) workflows; The JWT one is deprecated and will stop working from the 27th of January 2025. Existing integrations based on this authorization scheme will continue to work as usual until this date. Please migrate your project to use OAuth S2S before 2025.

For User Sync Tool users, please wait for the v2.9.0 release before migrating to OAuth Server-to-Server.

On August 8th, 2022, Document Cloud product names will remove the "DC" suffix. For example, "Acrobat Pro DC" will be renamed “Acrobat Pro".

As a result, any application directly accessing the User Management API which include logic dependent on the product name will need to be updated. If you have not included the product name in the code, then this will not impact your connection to the User Management API. If you use the User Sync Tool, you should see no impact.

Note: the term "DC" included in the name of a Product Profile will not change. If you rely on the name of the “product admin group” (e.g., _admin_<product name>) you may be impacted and have to update your scripts.

As a best practice, it is recommended to avoid any logic that expects fixed product names.

Since October 2021, Adobe has added controls to check the running frequency of each UMAPI client instance to prevent running syncs more frequently than the recommended timing of no more than once every 2 hours. Running the calls more frequently can start a new session prior to the completion of the previous session, resulting in syncing delays. When the access limit is reached, further calls fail with the error message ‘429 Too Many Requests’ and a Retry-After header containing the delay required before the next call can be made. Please refer to the _Throttling_ section of each API to determine its limitations.

Starting from 20th July 2021, there is an update when retrieving groups for ETLA customers with a Single App plan. When applicable, instead of returning _Single App_ in the productName field it will now be populated with the corresponding product name e.g. _Photoshop_.

As a result, any application directly accessing the User Management API which includes logic dependent on the _Single App_ product name will need to be updated. If you have not included the product name in the code, then this will not impact your connection to the User Management API. If you use the User Sync Tool, you should see no impact.

As a best practice, it is recommended to avoid any logic that expects fixed product names.

Since 27th April 2021, the page size for APIs relating to the retrieval of users has been increased from 1000 to 2000. No changes are required by existing clients.

Starting in February 2021, Adobe will add controls to check the running frequency of each User Sync Tool instance to prevent running the tool more frequently than the recommended timing of no more than once every 2 hours. Running the calls more frequently can start a new session prior to the completion of the previous session, resulting in syncing delays. When the access limit is reached, further calls fail with the error message ‘429 Too Many Requests’ and a Retry-After header containing the delay required before the next call can be made. Please refer to the _Throttling_ section of each API to determine its limitations and, if you are leveraging the User Sync Tool, please check their Deployment Best Practices section for scheduling recommendations.

Since June 8th 2020, the page size for APIs relating to the retrieval of users has been increased from 400 to 1000. No changes are required by existing clients.

Starting March 10th 2020, new property groupId will be returned as part of the response for retrieving groups and products. Clients are not impacted by this change.

Since February 11th 2020, the page size for APIs relating to the retrieval of groups has been increased from 200 to 400. No changes are required by existing clients.

Starting August 8th 2019, a change is applied to align with the multiple domains per directory model and tightening the security of the create and update APIs.

As a result, any application using the create or update API statements using domains for which there's no claim in Admin Console, will start failing.

On April 2nd, 2019, Creative Cloud product names will remove the “CC”. For example, “Photoshop CC” will be renamed “Photoshop”.

As a result, any application directly accessing the User Management API which include logic dependent on the product name will need to be updated. If you have not included the product name in the code, then this will not impact your connection to the User Management API. If you use the User Sync Tool, you should see no impact.

Note: the term “CC” included in the name of a Product Profile will not change. If you rely on the name of the “product admin group” (e.g., _admin_<product name>) you may be impacted and have to update your scripts.

As a best practice, it is recommended to avoid any logic that expects fixed product names.

</div> [Getting Started with User Management](/umapi-documentation/en/getstarted.html) [User Management API Overview](/umapi-documentation/en/API_introduction.html) [User Management API Reference](/umapi-documentation/en/RefOverview.html) [User Management Walkthrough](/umapi-documentation/en/samples/)