Skip to content

Commit 8083db3

Browse files
authored
Merge pull request #95 from adobe-apiplatform/tag-removal-announcement
Announcement for deprecation and removal of tags
2 parents 26ec08b + 3faf50a commit 8083db3

File tree

4 files changed

+23
-0
lines changed

4 files changed

+23
-0
lines changed

docs/en/api/getUser.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@ The response body contains the requested user data in JSON format including any
7272
}
7373
}
7474
```
75+
76+
:warning: As of October 16, 2025, the `tags` array will no longer be returned.
77+
7578
<a name="getUserGroupsExample" class="api-ref-subtitle">[Enterprise](glossary.md#enterpriseId) User with membership</a> in two user-groups but no administrative roles. If the fields are not populated (`firstname` and`lastname` in this example), they are excluded from the response.
7679
```json
7780
{
@@ -148,6 +151,8 @@ __user:__ A _user_ object containing relevant properties. Properties that are n
148151
}
149152
```
150153

154+
:warning: As of October 16, 2025, the `tags` array will no longer be returned.
155+
151156
{% include_relative partials/badRequest.md anchor="400getUser" %}
152157

153158
{% include_relative partials/unauthorized.md anchor="401getUser" %}

docs/en/api/getUsersByGroup.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,8 @@ A successful request returns a response body with the requested user data in JSO
119119
}
120120
```
121121

122+
:warning: As of October 16, 2025, the `tags` array will no longer be returned.
123+
122124
<a name="getUsersWithNoGroupsExample" class="api-ref-subtitle">Response returning three members of the Document Cloud 1 group. The `groups` array for each user has been excluded in the response as the query parameter `excludeGroups=true` was included:</a>
123125

124126
```json
@@ -159,6 +161,8 @@ A successful request returns a response body with the requested user data in JSO
159161
}
160162
```
161163

164+
:warning: As of October 16, 2025, the `tags` array will no longer be returned.
165+
162166
<a name="getUsersExampleLastPage" class="api-ref-subtitle">Response to request for the last page:
163167

164168
```json
@@ -228,6 +232,8 @@ __users:__ Contains a list of _User_ objects. Properties that are not populated
228232
}
229233
```
230234

235+
:warning: As of October 16, 2025, the `tags` array will no longer be returned.
236+
231237
{% include_relative partials/badRequest.md anchor="400getUsersByGroup" %}
232238

233239
{% include_relative partials/unauthorized.md anchor="401getUsersByGroup" %}

docs/en/api/getUsersWithPage.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,8 @@ A successful request returns a response body with the requested user data in JSO
120120
]
121121
}
122122
```
123+
:warning: As of October 16, 2025, the `tags` array will no longer be returned.
124+
123125
<a name="getUsersExampleLastPage" class="api-ref-subtitle">Response that is the last page:
124126
```json
125127
{
@@ -183,6 +185,8 @@ __users:__ Contains a list of _User_ objects. Properties that are not populated
183185
}
184186
```
185187

188+
:warning: As of October 16, 2025, the `tags` array will no longer be returned.
189+
186190
{% include_relative partials/badRequest.md anchor="400getUsersWithPage" %}
187191

188192
{% include_relative partials/unauthorized.md anchor="401getUsersWithPage" %}

docs/en/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,14 @@ Welcome to the documentation center for User Management APIs from Adobe.
1111

1212
<h2>News</h2>
1313
<div class="isa_info">
14+
<p>April 15, 2025: As of 16 October, 2025, UMAPI will no longer return "tags" information as documented for the following APIs:</p>
15+
<ul>
16+
<li><a href="api/getUser.html">Get User Information</a></li>
17+
<li><a href="api/getUsersWithPage.html">Get Users in Organization</a></li>
18+
<li><a href="api/getUsersByGroup.html">Get Users by Group</a></li>
19+
</ul>
20+
<p>Note that this data is likely to become stale over the coming months as the attribute is deprecated internally. If you are currently using this information, please get in touch with the developer support team to let us know your use case. Note that as this change is due to the data being retired from the Adobe platform, UMAPI will not be able to offer extensions to this time frame.</p>
21+
<hr class="api-ref-rule">
1422
<p>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.</p>
1523
<p>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.</p>
1624
<p>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.</p>

0 commit comments

Comments
 (0)