Skip to content

Commit

Permalink
fixup! fixup! fixup! fixup! feat(api): add token domain policy
Browse files Browse the repository at this point in the history
  • Loading branch information
@peterthomassen
peterthomassen committed Jan 6, 2022
1 parent dc0011e commit 662c1dd
Showing 1 changed file with 48 additions and 48 deletions.
96 changes: 48 additions & 48 deletions docs/endpoint-reference.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,54 +6,54 @@ Endpoint Reference
The following table summarizes basic information about the deSEC API endpoints used
for :ref:`managing users <manage-account>` and :ref:`tokens <manage-tokens>`.

+-----------------------------------------------------+------------+---------------------------------------------+
| Endpoint ``/api/v1``... | Methods | Use case |
+=====================================================+============+=============================================+
| ...\ ``/auth/`` | ``POST`` | Register user account |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/account/`` | ``GET`` | Retrieve user account information |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/account/change-email/`` | ``POST`` | Request account email address change |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/account/reset-password/`` | ``POST`` | Request password reset |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/account/delete/`` | ``POST`` | Request account deletion |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/login/`` | ``POST`` | Log in and request authentication token |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/logout/`` | ``POST`` | Log out (= delete current token) |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/tokens/`` | ``GET`` | Retrieve all current tokens |
| +------------+---------------------------------------------+
| | ``POST`` | Create new token |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/tokens/{id}/`` | ``GET`` | Retrieve token |
| +------------+---------------------------------------------+
| | ``DELETE`` | Delete token |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/tokens/{id}/policies/domain/`` | ``GET`` | Retrieve all domain policies for the given |
| | | token |
| +------------+---------------------------------------------+
| | ``POST`` | Create a domain policy for the given token |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/tokens/{id}/policies/domain/{domain}/` | ``GET`` | Retrieve a specific token domain policy |
| +------------+---------------------------------------------+
| | ``PATCH`` | Modify a token domain policy |
| +------------+---------------------------------------------+
| | ``PUT`` | Replace a token domain policy |
| +------------+---------------------------------------------+
| | ``DELETE`` | Delete a token domain policy |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/captcha/`` | ``POST`` | Obtain captcha |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/v/activate-account/{code}/`` | ``POST`` | Confirm email address for new account |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/v/reset-password/{code}/`` | ``POST`` | Confirm password reset |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/v/change-email/{code}/`` | ``POST`` | Confirm email address change |
+-----------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/v/delete-account/{code}/`` | ``POST`` | Confirm account deletion |
+-----------------------------------------------------+------------+---------------------------------------------+
+------------------------------------------------------+------------+---------------------------------------------+
| Endpoint ``/api/v1``... | Methods | Use case |
+======================================================+============+=============================================+
| ...\ ``/auth/`` | ``POST`` | Register user account |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/account/`` | ``GET`` | Retrieve user account information |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/account/change-email/`` | ``POST`` | Request account email address change |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/account/reset-password/`` | ``POST`` | Request password reset |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/account/delete/`` | ``POST`` | Request account deletion |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/login/`` | ``POST`` | Log in and request authentication token |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/logout/`` | ``POST`` | Log out (= delete current token) |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/tokens/`` | ``GET`` | Retrieve all current tokens |
| +------------+---------------------------------------------+
| | ``POST`` | Create new token |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/tokens/{id}/`` | ``GET`` | Retrieve token |
| +------------+---------------------------------------------+
| | ``DELETE`` | Delete token |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/tokens/{id}/policies/domain/`` | ``GET`` | Retrieve all domain policies for the given |
| | | token |
| +------------+---------------------------------------------+
| | ``POST`` | Create a domain policy for the given token |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/tokens/{id}/policies/domain/{domain}/`` | ``GET`` | Retrieve a specific token domain policy |
| +------------+---------------------------------------------+
| | ``PATCH`` | Modify a token domain policy |
| +------------+---------------------------------------------+
| | ``PUT`` | Replace a token domain policy |
| +------------+---------------------------------------------+
| | ``DELETE`` | Delete a token domain policy |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/captcha/`` | ``POST`` | Obtain captcha |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/v/activate-account/{code}/`` | ``POST`` | Confirm email address for new account |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/v/reset-password/{code}/`` | ``POST`` | Confirm password reset |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/v/change-email/{code}/`` | ``POST`` | Confirm email address change |
+------------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/v/delete-account/{code}/`` | ``POST`` | Confirm account deletion |
+------------------------------------------------------+------------+---------------------------------------------+

The following table summarizes basic information about the deSEC API endpoints used
for :ref:`domain-management` and :ref:`Retrieving and Manipulating DNS
Expand Down

0 comments on commit 662c1dd

Please sign in to comment.