Skip to content

Commit

Permalink
Added detail to the readme for x-username
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexYoungmanMoJ committed Feb 3, 2025
1 parent a64098e commit 41bcc17
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,22 @@ OpenAPI documentation is available here - http://localhost:8080/swagger-ui/index

---

## Authentication
## Headers

### Username

The hmpps-learner-records-api requires consumer services to identify their users when connecting to our service.

Where possible when making a request you should identify the user (not the service) in the custom header `X-Username`.

The value should be a unique identifier for the user, either a name or an email address.

Example header
```
"X-Username": "john.doe@justice.gov.uk"
```

### Authentication

The hmpps-learner-records-api requires bearer authorization.

Expand Down

0 comments on commit 41bcc17

Please sign in to comment.