Skip to content

Commit 88b5661

Browse files
authored
Merge pull request #79 from adobe-apiplatform/update-error-page
Update Errors page
2 parents fd7fb27 + 384935e commit 88b5661

File tree

3 files changed

+61
-44
lines changed

3 files changed

+61
-44
lines changed

docs/en/api/ErrorRef.md

Lines changed: 42 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,12 @@ The possible error codes and messages are listed with their context and descript
4545
* **error.user.type_unknown**
4646
* (internal) Type of user could not be determined.
4747

48+
* **error.user.type_not_available**
49+
* create
50+
* The requested user type to create is not available for this organization.
51+
4852
* **error.user.not_found_or_ambiguous**
53+
* update
4954
* (internal) More than one user matches ID.
5055

5156
* **error.user.name.invalid**
@@ -77,8 +82,13 @@ The possible error codes and messages are listed with their context and descript
7782
* **error.user.id_missing**
7883
* User ID is missing where required.
7984

80-
* **error.user.firstname_missing<br>error.user.lastname_missing**
81-
* User first or last name is missing where required.
85+
* **error.user.firstname_missing**
86+
* create
87+
* User first name is missing where required.
88+
89+
* **error.user.lastname_missing**
90+
* create
91+
* User last name is missing where required.
8292

8393
* **error.user.name_in_use**
8494
* update
@@ -296,6 +306,10 @@ The possible error codes and messages are listed with their context and descript
296306
* add, remove
297307
* A list of groups or product profiles is empty or contains a null entry.
298308

309+
* **error.group.invalid_name**
310+
* Get all member users in a group](getUsersByGroup.md)
311+
* The group name passed into [Get all member users in a group](getUsersByGroup.md) is invalid.
312+
299313
* **error.option.illegal**
300314
* The "option" flag value in a user add or create call (addAdobeID, createEnterpriseID, createFederatedID) is not one of the defined values.
301315

@@ -306,9 +320,9 @@ The possible error codes and messages are listed with their context and descript
306320
* add/create, remove, removeFromOrg, removeFromDomain, update
307321
* Attempt to perform operations on a user by domain trustee organization.
308322

309-
* **error.resetpw.user_must_be_enterprise_type**
310-
* resetPassword
311-
* A user referenced in resetPassword is not an Enterprise ID. You cannot reset passwords for Adobe IDs or Federated IDs.
323+
* **error.update.no**
324+
* update
325+
* The new email address cannot be used.
312326

313327
* **error.update.domain.mismatch**
314328
* update
@@ -326,18 +340,6 @@ The possible error codes and messages are listed with their context and descript
326340
* any request
327341
* Organization's API key in headers not valid
328342

329-
* **invites.pending.not_found**
330-
* any pending-invites request
331-
* No pending invites exist for the given email address or for the organization
332-
333-
* **invites.pending.resend.error**
334-
* request resend of pending invite
335-
* A server-side error occurred when resending pending invites
336-
337-
* **invites.pending.revoke.error**
338-
* request revocation of pending invite
339-
* A server-side error occurred when revoking pending invites
340-
341343
* **error.internal.create_failed**
342344
* create
343345
* Operation failed for unknown reason.
@@ -361,34 +363,10 @@ The possible error codes and messages are listed with their context and descript
361363
* any
362364
* Unknown error occurred.
363365

364-
* **error.internal.notification.failed**
365-
* add, remove, removeFromOrg
366-
* Unknown error occurred trying to authorize a Digital Marketing Cloud product.
367-
368-
* **error.internal.notification.failed.jem**
369-
* add, remove, removeFromOrg
370-
* Unknown error occurred trying to update product use for Creative Cloud or Document Cloud products.
371-
372-
* **error.internal.notification.failed.dma**
373-
* add, remove, removeFromOrg
374-
* Unknown error occurred trying to update product use for Digital Marketing Cloud products.
375-
376366
* **error.internal.everybody_group.not_found**
377367
* add, create
378368
* A user could not be added to this root group, which should always exist.
379369

380-
* **error.internal.invite.email_template_misconfigured**
381-
* add, createEnterpriseID
382-
* The organization is misconfigured or an email template for an invitation could not be found.
383-
384-
* **error.internal.reset_password_email**
385-
* resetPassword
386-
* The reset password email send failed.
387-
388-
* **error.internal.no_email_for_user**
389-
* resetPassword
390-
* Unable to get email address for user to send reset password message. Try updating the email address for the user.
391-
392370
* **plc.not_found**
393371
* access or update to a profile endpoint
394372
* The product profile was not found.
@@ -398,13 +376,33 @@ The possible error codes and messages are listed with their context and descript
398376
* The admin user list for the product profile was not found.
399377

400378
* **plc.admin.already_added<br>plc.add.admin.error<br>plc.remove.admin.error**
401-
* add or remove admin user to profile
402-
* The admin user already exists or doesn't exist in list
379+
* add or remove admin user to profile.
380+
* The admin user already exists or doesn't exist in list.
403381

404382
* **error.productadmin.add.user.failed<br>error.productadmin.remove.admin.failed**
405-
* update to admin user list for product
383+
* update to admin user list for product.
406384
* The admin user list was not updated.
407385

408386
* **<a name="adobeidno" class="api-ref-subtitle">error.update.adobeid.no</a>**
409387
* update action workflows
410388
* The operation in the command cannot be applied to an Adobe ID.
389+
390+
* **error.throttled_by_external_service**
391+
* any
392+
* User Management API is being throttled by an external service.
393+
394+
* **error.developer.add_user.failed**
395+
* add
396+
* Failed to add the user as a developer.
397+
398+
* **error.developer.remove_user.failed**
399+
* remove
400+
* Failed to remove the developer role from the user.
401+
402+
* **error.user.domain_enforcement**
403+
* create
404+
* The user cannot be added to the organization due to domain enforcement restrictions. See https://helpx.adobe.com/enterprise/using/restricting-domains.html for more information.
405+
406+
* **error.usergroup.exceeds_maximum_member_count**
407+
* add, remove
408+
* The current user count for the group exceeds the recommended size. Please refer to our [requesting help page](../getsupport.html) if you would like to discuss this issue further.

docs/en/api/getSupport.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Requesting Help
3+
layout: page
4+
nav_link: Requesting Help
5+
nav_order: 510
6+
nav_level: 1
7+
lang: en
8+
---
9+
10+
# Requesting Help
11+
12+
If you require further assistance for using the User Management API then please follow the instructions for Creative Cloud for Enterprise support outlined [here](https://helpx.adobe.com/uk/contact/enterprise-support.html). This will result in a support ticket being opened and assigned to our Developer Support Team.
13+
14+
15+

docs/en/getstarted.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,7 @@ Before you can use the User Management API (directly or indirectly through User
5454
* Get complete reference details for all API calls: [User Management API Reference](RefOverview.md)
5555
* See a sample Python script and examples of representative requests: [Examples and Samples](samples/index.md)
5656

57+
## Need Help?
58+
59+
If you require further assistance for using the User Management API then please follow the instructions for Creative Cloud for Enterprise support outlined [here](https://helpx.adobe.com/uk/contact/enterprise-support.html). This will result in a support ticket being opened and assigned to our Developer Support Team.
60+

0 commit comments

Comments
 (0)