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

Add deprecation notice to v1 README #55

Merged
merged 1 commit into from
Aug 12, 2022
Merged

Add deprecation notice to v1 README #55

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
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# dp-authorisation

Note: This version of the library is deprecated. [Documentation for the newest version](https://github.com/ONSdigital/dp-authorisation/blob/main/README.md) can be found on the `main` branch.

Library providing functionality for applying an authorisation check to `http.HandlerFunc`.

This will check the incoming request is authenticated (has a valid authorisation token) and then once identified will check if the user or service is authorised to access the endpoint/resources by verifying the user or service has the same permissions as those set against the handler.
Expand All @@ -24,4 +26,4 @@ curl -X GET localhost:22000/datasets -H "Authorization: <invalid token>"

# With a valid auth token, responds with 200 OK request
curl -X GET localhost:22000/datasets -H "Authorization: <valid token>"
```
```