NPA-5116 Add API Authentication Documentation#224
Conversation
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-5116 |
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-5116 |
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-5116 |
39e7d91 to
c40c598
Compare
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-5116 |
| The end user must be: | ||
| * a patient who receives health and social care or makes use of NHS services | ||
| * strongly authenticated, using [NHS login](https://digital.nhs.uk/services/nhs-login) | ||
| - [User-restricted access](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis) |
There was a problem hiding this comment.
Given that the links to the types are already in the sentence above, I think it would be better here to list the access modes against each of the types.
That way when they're listed against each endpoint, it makes a little more sense what they relate to without having to read this whole section:
For example:
## Security and authorisation
This API supports both [user-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis) and [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis) access types with the following access modes:
| Access mode | Access type |
|-------------------------------|------------------------|
| Patient access | User-restricted |
| Healthcare worker access | User-restricted |
| Application-restricted access | Application-restricted |
...
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-5116 |
Pull Request
Ticket Link
https://nhsd-jira.digital.nhs.uk/browse/NPA-5116
Description/Change Summary
Updated specification
e.g.

How to test?
Review Checklist
ℹ️ This section is to be filled in by the reviewer.
Post-merge
After merging and deploying changes to the sandbox, Postman collection or spec examples please run the
Run Postman collectionworkflow.This will run the tests within the collection to check that the sandbox is working as expected once deployed.