Skip to content
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

docs: update bulk-revoke endpoint docs #2297

Merged
merged 1 commit into from
Oct 14, 2024
Merged

docs: update bulk-revoke endpoint docs #2297

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 23 additions & 2 deletions en_us/enterprise_api/source/api_reference/reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1100,12 +1100,33 @@ Response

The ``POST enterprise/v1/subscriptions/{subscription_plan_uuid}/licenses/bulk-revoke`` request can return the following responses:

204 No Content - All revocations were successful.
200 OK - All revocations were successful. Returns a list of successful revocations.

400 Bad Request - Some error occurred when processing one of the revocations, no revocations were committed. An error message is provided.
207 Multi-Status - Some revocations were successful, but others failed. Returns both successful and failed revocations.

400 Bad Request - An error occurred when processing the request (e.g., invalid data format).

404 Not Found - No license exists in the plan for one of the given email addresses, or the license is not in an assigned or activated state. An error message is provided.

.. code-block:: json

{
"successful_revocations": [
{
"license_uuid": "string",
"original_status": "string",
"user_email": "string"
}
],
"unsuccessful_revocations": [
{
"error": "string",
"error_response_status": "integer",
"user_email": "string"
}
]
}

.. _Bulk-license-enrollment Endpoint:

*************************************************************************************
Expand Down
Loading