Skip to content

Update Errors page #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adobeDavidT merged 2 commits into from
Aug 21, 2023
Merged

Update Errors page #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03aa1f7
Update error page. Introduce new support page
Aug 21, 2023
384935e
Add help section to getting started page
Aug 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 42 additions & 44 deletions docs/en/api/ErrorRef.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,12 @@ The possible error codes and messages are listed with their context and descript
* **error.user.type_unknown**
* (internal) Type of user could not be determined.

* **error.user.type_not_available**
* create
* The requested user type to create is not available for this organization.

* **error.user.not_found_or_ambiguous**
* update
* (internal) More than one user matches ID.

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

* **error.user.firstname_missing<br>error.user.lastname_missing**
* User first or last name is missing where required.
* **error.user.firstname_missing**
* create
* User first name is missing where required.

* **error.user.lastname_missing**
* create
* User last name is missing where required.

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

* **error.group.invalid_name**
* Get all member users in a group](getUsersByGroup.md)
* The group name passed into [Get all member users in a group](getUsersByGroup.md) is invalid.

* **error.option.illegal**
* The "option" flag value in a user add or create call (addAdobeID, createEnterpriseID, createFederatedID) is not one of the defined values.

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

* **error.resetpw.user_must_be_enterprise_type**
* resetPassword
* A user referenced in resetPassword is not an Enterprise ID. You cannot reset passwords for Adobe IDs or Federated IDs.
* **error.update.no**
* update
* The new email address cannot be used.

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

* **invites.pending.not_found**
* any pending-invites request
* No pending invites exist for the given email address or for the organization

* **invites.pending.resend.error**
* request resend of pending invite
* A server-side error occurred when resending pending invites

* **invites.pending.revoke.error**
* request revocation of pending invite
* A server-side error occurred when revoking pending invites

* **error.internal.create_failed**
* create
* Operation failed for unknown reason.
Expand All @@ -361,34 +363,10 @@ The possible error codes and messages are listed with their context and descript
* any
* Unknown error occurred.

* **error.internal.notification.failed**
* add, remove, removeFromOrg
* Unknown error occurred trying to authorize a Digital Marketing Cloud product.

* **error.internal.notification.failed.jem**
* add, remove, removeFromOrg
* Unknown error occurred trying to update product use for Creative Cloud or Document Cloud products.

* **error.internal.notification.failed.dma**
* add, remove, removeFromOrg
* Unknown error occurred trying to update product use for Digital Marketing Cloud products.

* **error.internal.everybody_group.not_found**
* add, create
* A user could not be added to this root group, which should always exist.

* **error.internal.invite.email_template_misconfigured**
* add, createEnterpriseID
* The organization is misconfigured or an email template for an invitation could not be found.

* **error.internal.reset_password_email**
* resetPassword
* The reset password email send failed.

* **error.internal.no_email_for_user**
* resetPassword
* Unable to get email address for user to send reset password message. Try updating the email address for the user.

* **plc.not_found**
* access or update to a profile endpoint
* The product profile was not found.
Expand All @@ -398,13 +376,33 @@ The possible error codes and messages are listed with their context and descript
* The admin user list for the product profile was not found.

* **plc.admin.already_added<br>plc.add.admin.error<br>plc.remove.admin.error**
* add or remove admin user to profile
* The admin user already exists or doesn't exist in list
* add or remove admin user to profile.
* The admin user already exists or doesn't exist in list.

* **error.productadmin.add.user.failed<br>error.productadmin.remove.admin.failed**
* update to admin user list for product
* update to admin user list for product.
* The admin user list was not updated.

* **<a name="adobeidno" class="api-ref-subtitle">error.update.adobeid.no</a>**
* update action workflows
* The operation in the command cannot be applied to an Adobe ID.

* **error.throttled_by_external_service**
* any
* User Management API is being throttled by an external service.

* **error.developer.add_user.failed**
* add
* Failed to add the user as a developer.

* **error.developer.remove_user.failed**
* remove
* Failed to remove the developer role from the user.

* **error.user.domain_enforcement**
* create
* 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.

* **error.usergroup.exceeds_maximum_member_count**
* add, remove
* 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.
15 changes: 15 additions & 0 deletions docs/en/api/getSupport.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Requesting Help
layout: page
nav_link: Requesting Help
nav_order: 510
nav_level: 1
lang: en
---

# Requesting Help

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.



4 changes: 4 additions & 0 deletions docs/en/getstarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,7 @@ Before you can use the User Management API (directly or indirectly through User
* Get complete reference details for all API calls: [User Management API Reference](RefOverview.md)
* See a sample Python script and examples of representative requests: [Examples and Samples](samples/index.md)

## Need Help?

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.