diff --git a/tech-docs/projects/hmpps-auth-and-delius/api-docs.json b/tech-docs/projects/hmpps-auth-and-delius/api-docs.json index 24bb7e2e43..96a8b0e475 100644 --- a/tech-docs/projects/hmpps-auth-and-delius/api-docs.json +++ b/tech-docs/projects/hmpps-auth-and-delius/api-docs.json @@ -1 +1 @@ -{"openapi":"3.0.1","info":{"title":"API Reference","contact":{"name":"Probation Integration Team","url":"https://mojdt.slack.com/archives/C02HQ4M2YQN","email":"probation-integration-team@digital.justice.gov.uk"},"license":{"name":"MIT","url":"https://github.com/ministryofjustice/hmpps-probation-integration-services/blob/main/LICENSE"},"version":"1.0"},"servers":[{"url":"/"}],"security":[{"hmpps-auth-token":[]}],"paths":{"/user/{username}/password":{"post":{"tags":["User details"],"description":"Change a Delius user's password. Requires `PROBATION_API__HMPPS_AUTH__PASSWORD__RW`.","operationId":"changePassword","parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordChangeRequest"}}},"required":true},"responses":{"200":{"description":"Password changed successfully"},"404":{"description":"User not found"}}}},"/authenticate":{"post":{"tags":["Authentication"],"description":"Authenticate a Delius username and password. Requires `PROBATION_API__HMPPS_AUTH__AUTHENTICATE`.","operationId":"authenticate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationRequest"}}},"required":true},"responses":{"401":{"description":"Authentication failure","content":{"text/plain":{}}},"200":{"description":"User authenticated","content":{"text/plain":{}}},"403":{"description":"Client role required: `DELIUS_USER_AUTH`","content":{"text/plain":{}}}}}},"/user":{"get":{"tags":["User details"],"description":"Get users by email. Requires `PROBATION_API__HMPPS_AUTH__USER_DETAILS`.","operationId":"getUsersByEmail","parameters":[{"name":"email","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserDetails"}}}}}}}},"/user/{username}":{"get":{"tags":["User details"],"description":"Get user details. Requires `PROBATION_API__HMPPS_AUTH__USER_DETAILS`.","operationId":"getUserDetails","parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetails"}}}}}}},"/user/details/{userId}":{"get":{"tags":["User details"],"description":"Get user details by Id. Requires `PROBATION_API__HMPPS_AUTH__USER_DETAILS`.","operationId":"getUserDetailsById","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetails"}}}}}}}},"components":{"schemas":{"PasswordChangeRequest":{"required":["password"],"type":"object","properties":{"password":{"type":"string"}}},"AuthenticationRequest":{"required":["password","username"],"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}},"UserDetails":{"required":["enabled","firstName","roles","surname","userId","username"],"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"surname":{"type":"string"},"email":{"type":"string"},"enabled":{"type":"boolean"},"roles":{"type":"array","items":{"type":"string"}}}}},"securitySchemes":{"hmpps-auth-token":{"type":"http","name":"Authorization","in":"header","scheme":"bearer","bearerFormat":"JWT"}}}} \ No newline at end of file +{"openapi":"3.0.1","info":{"title":"API Reference","contact":{"name":"Probation Integration Team","url":"https://mojdt.slack.com/archives/C02HQ4M2YQN","email":"probation-integration-team@digital.justice.gov.uk"},"license":{"name":"MIT","url":"https://github.com/ministryofjustice/hmpps-probation-integration-services/blob/main/LICENSE"},"version":"1.0"},"servers":[{"url":"/"}],"security":[{"hmpps-auth-token":[]}],"paths":{"/user/{username}/password":{"post":{"tags":["User details"],"description":"Change a Delius user's password. Requires `PROBATION_API__HMPPS_AUTH__PASSWORD__RW`.","operationId":"changePassword","parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordChangeRequest"}}},"required":true},"responses":{"200":{"description":"Password changed successfully"},"404":{"description":"User not found"}}}},"/authenticate":{"post":{"tags":["Authentication"],"description":"Authenticate a Delius username and password. Requires `PROBATION_API__HMPPS_AUTH__AUTHENTICATE`.","operationId":"authenticate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationRequest"}}},"required":true},"responses":{"200":{"description":"User authenticated","content":{"text/plain":{}}},"403":{"description":"Client role required: `DELIUS_USER_AUTH`","content":{"text/plain":{}}},"401":{"description":"Authentication failure","content":{"text/plain":{}}}}}},"/user":{"get":{"tags":["User details"],"description":"Get users by email. Requires `PROBATION_API__HMPPS_AUTH__USER_DETAILS`.","operationId":"getUsersByEmail","parameters":[{"name":"email","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserDetails"}}}}}}}},"/user/{username}":{"get":{"tags":["User details"],"description":"Get user details. Requires `PROBATION_API__HMPPS_AUTH__USER_DETAILS`.","operationId":"getUserDetails","parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetails"}}}}}}},"/user/details/{userId}":{"get":{"tags":["User details"],"description":"Get user details by Id. Requires `PROBATION_API__HMPPS_AUTH__USER_DETAILS`.","operationId":"getUserDetailsById","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetails"}}}}}}}},"components":{"schemas":{"PasswordChangeRequest":{"required":["password"],"type":"object","properties":{"password":{"type":"string"}}},"AuthenticationRequest":{"required":["password","username"],"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}},"UserDetails":{"required":["enabled","firstName","roles","surname","userId","username"],"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"surname":{"type":"string"},"email":{"type":"string"},"enabled":{"type":"boolean"},"roles":{"type":"array","items":{"type":"string"}}}}},"securitySchemes":{"hmpps-auth-token":{"type":"http","name":"Authorization","in":"header","scheme":"bearer","bearerFormat":"JWT"}}}} \ No newline at end of file diff --git a/tech-docs/projects/hmpps-auth-and-delius/api-docs.yaml b/tech-docs/projects/hmpps-auth-and-delius/api-docs.yaml index 42cdf00a45..f6f0b5892f 100644 --- a/tech-docs/projects/hmpps-auth-and-delius/api-docs.yaml +++ b/tech-docs/projects/hmpps-auth-and-delius/api-docs.yaml @@ -50,10 +50,6 @@ paths: $ref: "#/components/schemas/AuthenticationRequest" required: true responses: - "401": - description: Authentication failure - content: - text/plain: {} "200": description: User authenticated content: @@ -62,6 +58,10 @@ paths: description: "Client role required: `DELIUS_USER_AUTH`" content: text/plain: {} + "401": + description: Authentication failure + content: + text/plain: {} /user: get: tags: diff --git a/tech-docs/projects/hmpps-auth-and-delius/api-reference.html b/tech-docs/projects/hmpps-auth-and-delius/api-reference.html index 22bbcea238..6ae8791483 100644 --- a/tech-docs/projects/hmpps-auth-and-delius/api-reference.html +++ b/tech-docs/projects/hmpps-auth-and-delius/api-reference.html @@ -239,9 +239,9 @@

Responses

-401 +200 -

Authentication failure

+

User authenticated

@@ -252,9 +252,9 @@

Responses

-200 +403 -

User authenticated

+

Client role required: DELIUS_USER_AUTH

@@ -265,9 +265,9 @@

Responses

-403 +401 -

Client role required: DELIUS_USER_AUTH

+

Authentication failure

diff --git a/tech-docs/projects/hmpps-auth-and-delius/search.json b/tech-docs/projects/hmpps-auth-and-delius/search.json index e1f12b7874..f83f27342e 100644 --- a/tech-docs/projects/hmpps-auth-and-delius/search.json +++ b/tech-docs/projects/hmpps-auth-and-delius/search.json @@ -1 +1 @@ -{"index": {"version":"0.7.0","fields":[{"name":"title","boost":100},{"name":"content","boost":50}],"ref":"id","tokenizer":"default","documentStore":{"store":{"11":["about","and","auth","delius","describe","hmpps","service","the","todo"],"12":["200","401","403","404","a","also","and","api","array","authenticate","authenticated","authentication","authenticationrequest","available","boolean","by","change","changed","client","delius","delius_user_auth","details","display","documentation","email","enabled","failure","false","firstname","following","formats","found","get","h1","id","important","in","integer","is","json","nametyperequireddescriptionschema","none","not","ok","openapi","parameterintyperequireddescription","parameters","password","passwordchangerequest","path","post","probation_api__hmpps_auth__authenticate","probation_api__hmpps_auth__password__rw","probation_api__hmpps_auth__user_details","query","reference","required","requires","responses","role","roles","schemas","statusdescriptionschema","string","successfully","surname","swagger","technical","the","these","true","ui","user","userdetails","userid","username","users","user’s","v1.0","yaml"]},"length":2},"tokenStore":{"root":{"2":{"0":{"0":{"docs":{"12":{"ref":12,"tf":1.2626262626262625}}},"docs":{}},"docs":{}},"4":{"0":{"1":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"3":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"4":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"docs":{}},"docs":{}},"docs":{},"a":{"docs":{"12":{"ref":12,"tf":0.5050505050505051}},"b":{"docs":{},"o":{"docs":{},"u":{"docs":{},"t":{"docs":{"11":{"ref":11,"tf":100}}}}}},"n":{"docs":{},"d":{"docs":{"11":{"ref":11,"tf":6.25},"12":{"ref":12,"tf":0.25252525252525254}}}},"u":{"docs":{},"t":{"docs":{},"h":{"docs":{"11":{"ref":11,"tf":6.25}},"e":{"docs":{},"n":{"docs":{},"t":{"docs":{},"i":{"docs":{},"c":{"docs":{},"a":{"docs":{},"t":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.5050505050505051}},"d":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}},"i":{"docs":{},"o":{"docs":{},"n":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}},"r":{"docs":{},"e":{"docs":{},"q":{"docs":{},"u":{"docs":{},"e":{"docs":{},"s":{"docs":{},"t":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}}}}}}}}}}}}}},"l":{"docs":{},"s":{"docs":{},"o":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}},"p":{"docs":{},"i":{"docs":{"12":{"ref":12,"tf":50.505050505050505}}}},"r":{"docs":{},"r":{"docs":{},"a":{"docs":{},"y":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}},"v":{"docs":{},"a":{"docs":{},"i":{"docs":{},"l":{"docs":{},"a":{"docs":{},"b":{"docs":{},"l":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}}},"d":{"docs":{},"e":{"docs":{},"l":{"docs":{},"i":{"docs":{},"u":{"docs":{},"s":{"docs":{"11":{"ref":11,"tf":6.25},"12":{"ref":12,"tf":0.5050505050505051}},"_":{"docs":{},"u":{"docs":{},"s":{"docs":{},"e":{"docs":{},"r":{"docs":{},"_":{"docs":{},"a":{"docs":{},"u":{"docs":{},"t":{"docs":{},"h":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}}}}}}}},"s":{"docs":{},"c":{"docs":{},"r":{"docs":{},"i":{"docs":{},"b":{"docs":{},"e":{"docs":{"11":{"ref":11,"tf":6.25}}}}}}}},"t":{"docs":{},"a":{"docs":{},"i":{"docs":{},"l":{"docs":{},"s":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}},"i":{"docs":{},"s":{"docs":{},"p":{"docs":{},"l":{"docs":{},"a":{"docs":{},"y":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}},"o":{"docs":{},"c":{"docs":{},"u":{"docs":{},"m":{"docs":{},"e":{"docs":{},"n":{"docs":{},"t":{"docs":{},"a":{"docs":{},"t":{"docs":{},"i":{"docs":{},"o":{"docs":{},"n":{"docs":{"12":{"ref":12,"tf":0.5050505050505051}}}}}}}}}}}}}}},"h":{"1":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"docs":{},"m":{"docs":{},"p":{"docs":{},"p":{"docs":{},"s":{"docs":{"11":{"ref":11,"tf":6.25}}}}}}},"s":{"docs":{},"e":{"docs":{},"r":{"docs":{},"v":{"docs":{},"i":{"docs":{},"c":{"docs":{},"e":{"docs":{"11":{"ref":11,"tf":6.25}}}}}}}},"c":{"docs":{},"h":{"docs":{},"e":{"docs":{},"m":{"docs":{},"a":{"docs":{},"s":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}},"t":{"docs":{},"a":{"docs":{},"t":{"docs":{},"u":{"docs":{},"s":{"docs":{},"d":{"docs":{},"e":{"docs":{},"s":{"docs":{},"c":{"docs":{},"r":{"docs":{},"i":{"docs":{},"p":{"docs":{},"t":{"docs":{},"i":{"docs":{},"o":{"docs":{},"n":{"docs":{},"s":{"docs":{},"c":{"docs":{},"h":{"docs":{},"e":{"docs":{},"m":{"docs":{},"a":{"docs":{"12":{"ref":12,"tf":1.2626262626262625}}}}}}}}}}}}}}}}}}}}}}},"r":{"docs":{},"i":{"docs":{},"n":{"docs":{},"g":{"docs":{"12":{"ref":12,"tf":4.545454545454546}}}}}}},"u":{"docs":{},"c":{"docs":{},"c":{"docs":{},"e":{"docs":{},"s":{"docs":{},"s":{"docs":{},"f":{"docs":{},"u":{"docs":{},"l":{"docs":{},"l":{"docs":{},"y":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}}}},"r":{"docs":{},"n":{"docs":{},"a":{"docs":{},"m":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}},"w":{"docs":{},"a":{"docs":{},"g":{"docs":{},"g":{"docs":{},"e":{"docs":{},"r":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}},"t":{"docs":{},"h":{"docs":{},"e":{"docs":{"11":{"ref":11,"tf":6.25},"12":{"ref":12,"tf":0.25252525252525254}},"s":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}},"o":{"docs":{},"d":{"docs":{},"o":{"docs":{"11":{"ref":11,"tf":6.25}}}}},"e":{"docs":{},"c":{"docs":{},"h":{"docs":{},"n":{"docs":{},"i":{"docs":{},"c":{"docs":{},"a":{"docs":{},"l":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}},"r":{"docs":{},"u":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":3.2828282828282833}}}}}},"b":{"docs":{},"o":{"docs":{},"o":{"docs":{},"l":{"docs":{},"e":{"docs":{},"a":{"docs":{},"n":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}},"y":{"docs":{"12":{"ref":12,"tf":0.5050505050505051}}}},"c":{"docs":{},"h":{"docs":{},"a":{"docs":{},"n":{"docs":{},"g":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}},"d":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}},"l":{"docs":{},"i":{"docs":{},"e":{"docs":{},"n":{"docs":{},"t":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}},"e":{"docs":{},"m":{"docs":{},"a":{"docs":{},"i":{"docs":{},"l":{"docs":{"12":{"ref":12,"tf":1.2626262626262625}}}}}},"n":{"docs":{},"a":{"docs":{},"b":{"docs":{},"l":{"docs":{},"e":{"docs":{},"d":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}}},"f":{"docs":{},"a":{"docs":{},"i":{"docs":{},"l":{"docs":{},"u":{"docs":{},"r":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}},"l":{"docs":{},"s":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}},"i":{"docs":{},"r":{"docs":{},"s":{"docs":{},"t":{"docs":{},"n":{"docs":{},"a":{"docs":{},"m":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}}}},"o":{"docs":{},"l":{"docs":{},"l":{"docs":{},"o":{"docs":{},"w":{"docs":{},"i":{"docs":{},"n":{"docs":{},"g":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}},"r":{"docs":{},"m":{"docs":{},"a":{"docs":{},"t":{"docs":{},"s":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}},"u":{"docs":{},"n":{"docs":{},"d":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}},"g":{"docs":{},"e":{"docs":{},"t":{"docs":{"12":{"ref":12,"tf":1.5151515151515151}}}}},"i":{"docs":{},"d":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"m":{"docs":{},"p":{"docs":{},"o":{"docs":{},"r":{"docs":{},"t":{"docs":{},"a":{"docs":{},"n":{"docs":{},"t":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}},"n":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}},"t":{"docs":{},"e":{"docs":{},"g":{"docs":{},"e":{"docs":{},"r":{"docs":{"12":{"ref":12,"tf":1.0101010101010102}}}}}}}},"s":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}},"j":{"docs":{},"s":{"docs":{},"o":{"docs":{},"n":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}},"n":{"docs":{},"a":{"docs":{},"m":{"docs":{},"e":{"docs":{},"t":{"docs":{},"y":{"docs":{},"p":{"docs":{},"e":{"docs":{},"r":{"docs":{},"e":{"docs":{},"q":{"docs":{},"u":{"docs":{},"i":{"docs":{},"r":{"docs":{},"e":{"docs":{},"d":{"docs":{},"d":{"docs":{},"e":{"docs":{},"s":{"docs":{},"c":{"docs":{},"r":{"docs":{},"i":{"docs":{},"p":{"docs":{},"t":{"docs":{},"i":{"docs":{},"o":{"docs":{},"n":{"docs":{},"s":{"docs":{},"c":{"docs":{},"h":{"docs":{},"e":{"docs":{},"m":{"docs":{},"a":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}},"o":{"docs":{},"n":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}},"t":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}},"o":{"docs":{},"k":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}},"p":{"docs":{},"e":{"docs":{},"n":{"docs":{},"a":{"docs":{},"p":{"docs":{},"i":{"docs":{"12":{"ref":12,"tf":0.5050505050505051}}}}}}}}},"p":{"docs":{},"a":{"docs":{},"r":{"docs":{},"a":{"docs":{},"m":{"docs":{},"e":{"docs":{},"t":{"docs":{},"e":{"docs":{},"r":{"docs":{},"i":{"docs":{},"n":{"docs":{},"t":{"docs":{},"y":{"docs":{},"p":{"docs":{},"e":{"docs":{},"r":{"docs":{},"e":{"docs":{},"q":{"docs":{},"u":{"docs":{},"i":{"docs":{},"r":{"docs":{},"e":{"docs":{},"d":{"docs":{},"d":{"docs":{},"e":{"docs":{},"s":{"docs":{},"c":{"docs":{},"r":{"docs":{},"i":{"docs":{},"p":{"docs":{},"t":{"docs":{},"i":{"docs":{},"o":{"docs":{},"n":{"docs":{"12":{"ref":12,"tf":1.0101010101010102}}}}}}}}}}}}}}}}}}}}}}}}}}},"s":{"docs":{"12":{"ref":12,"tf":1.0101010101010102}}}}}}}}}},"s":{"docs":{},"s":{"docs":{},"w":{"docs":{},"o":{"docs":{},"r":{"docs":{},"d":{"docs":{"12":{"ref":12,"tf":1.5151515151515151}},"c":{"docs":{},"h":{"docs":{},"a":{"docs":{},"n":{"docs":{},"g":{"docs":{},"e":{"docs":{},"r":{"docs":{},"e":{"docs":{},"q":{"docs":{},"u":{"docs":{},"e":{"docs":{},"s":{"docs":{},"t":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}}}}}}}}}}}}},"t":{"docs":{},"h":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}},"o":{"docs":{},"s":{"docs":{},"t":{"docs":{"12":{"ref":12,"tf":0.5050505050505051}}}}},"r":{"docs":{},"o":{"docs":{},"b":{"docs":{},"a":{"docs":{},"t":{"docs":{},"i":{"docs":{},"o":{"docs":{},"n":{"docs":{},"_":{"docs":{},"a":{"docs":{},"p":{"docs":{},"i":{"docs":{},"_":{"docs":{},"_":{"docs":{},"h":{"docs":{},"m":{"docs":{},"p":{"docs":{},"p":{"docs":{},"s":{"docs":{},"_":{"docs":{},"a":{"docs":{},"u":{"docs":{},"t":{"docs":{},"h":{"docs":{},"_":{"docs":{},"_":{"docs":{},"a":{"docs":{},"u":{"docs":{},"t":{"docs":{},"h":{"docs":{},"e":{"docs":{},"n":{"docs":{},"t":{"docs":{},"i":{"docs":{},"c":{"docs":{},"a":{"docs":{},"t":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}}}}}},"p":{"docs":{},"a":{"docs":{},"s":{"docs":{},"s":{"docs":{},"w":{"docs":{},"o":{"docs":{},"r":{"docs":{},"d":{"docs":{},"_":{"docs":{},"_":{"docs":{},"r":{"docs":{},"w":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}}}}}},"u":{"docs":{},"s":{"docs":{},"e":{"docs":{},"r":{"docs":{},"_":{"docs":{},"d":{"docs":{},"e":{"docs":{},"t":{"docs":{},"a":{"docs":{},"i":{"docs":{},"l":{"docs":{},"s":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}},"q":{"docs":{},"u":{"docs":{},"e":{"docs":{},"r":{"docs":{},"y":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}},"r":{"docs":{},"e":{"docs":{},"f":{"docs":{},"e":{"docs":{},"r":{"docs":{},"e":{"docs":{},"n":{"docs":{},"c":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":50.505050505050505}}}}}}}}},"q":{"docs":{},"u":{"docs":{},"i":{"docs":{},"r":{"docs":{},"e":{"docs":{},"d":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"s":{"docs":{"12":{"ref":12,"tf":1.2626262626262625}}}}}}}},"s":{"docs":{},"p":{"docs":{},"o":{"docs":{},"n":{"docs":{},"s":{"docs":{},"e":{"docs":{},"s":{"docs":{"12":{"ref":12,"tf":1.2626262626262625}}}}}}}}}},"o":{"docs":{},"l":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}},"s":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}},"u":{"docs":{},"i":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"s":{"docs":{},"e":{"docs":{},"r":{"docs":{"12":{"ref":12,"tf":2.0202020202020203}},"d":{"docs":{},"e":{"docs":{},"t":{"docs":{},"a":{"docs":{},"i":{"docs":{},"l":{"docs":{},"s":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}}},"i":{"docs":{},"d":{"docs":{"12":{"ref":12,"tf":1.2626262626262625}}}},"n":{"docs":{},"a":{"docs":{},"m":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":2.272727272727273}}}}}},"s":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"’":{"docs":{},"s":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}},"v":{"1":{"docs":{},".":{"0":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"docs":{}}},"docs":{}},"y":{"docs":{},"a":{"docs":{},"m":{"docs":{},"l":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}},"length":89},"corpusTokens":["200","401","403","404","a","about","also","and","api","array","auth","authenticate","authenticated","authentication","authenticationrequest","available","boolean","by","change","changed","client","delius","delius_user_auth","describe","details","display","documentation","email","enabled","failure","false","firstname","following","formats","found","get","h1","hmpps","id","important","in","integer","is","json","nametyperequireddescriptionschema","none","not","ok","openapi","parameterintyperequireddescription","parameters","password","passwordchangerequest","path","post","probation_api__hmpps_auth__authenticate","probation_api__hmpps_auth__password__rw","probation_api__hmpps_auth__user_details","query","reference","required","requires","responses","role","roles","schemas","service","statusdescriptionschema","string","successfully","surname","swagger","technical","the","these","todo","true","ui","user","userdetails","userid","username","users","user’s","v1.0","yaml"],"pipeline":["trimmer"]}, "docs": {"11":{"title":"About","content":"hmpps-auth-and-delius\n// TODO Describe the service\n","url":"/"},"12":{"title":"API Reference","content":"\n \n API Reference\n\n\n.technical-documentation \u003e h1 { display: none !important }\nThe following documentation is also available in these formats:\n\n\nOpenAPI JSON\nOpenAPI YAML\nSwagger UI\n\nAPI Reference v1.0\n\n\n\n\n\n\n/user/{username}/password\n\npost\n\n\n Change a Delius user’s password. Requires PROBATION_API__HMPPS_AUTH__PASSWORD__RW.\n\n\n\n\nParameters\n\n\nParameterInTypeRequiredDescription\n\n\n\n\nusername\npath\nstring\ntrue\n\n\n\n\n\n\n\n\n\n\n\nResponses\n\n\nStatusDescriptionSchema\n\n\n\n\n200\n\nPassword changed successfully\n\n\n\n\n\n\n\n\n\n\n404\n\nUser not found\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n/authenticate\n\npost\n\n\n Authenticate a Delius username and password. Requires PROBATION_API__HMPPS_AUTH__AUTHENTICATE.\n\n\n\n\n\n\n\nResponses\n\n\nStatusDescriptionSchema\n\n\n\n\n401\n\nAuthentication failure\n\n\n\n\n\n\n\n\n\n\n200\n\nUser authenticated\n\n\n\n\n\n\n\n\n\n\n403\n\nClient role required: DELIUS_USER_AUTH\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n/user\n\nget\n\n\n Get users by email. Requires PROBATION_API__HMPPS_AUTH__USER_DETAILS.\n\n\n\n\nParameters\n\n\nParameterInTypeRequiredDescription\n\n\n\n\nemail\nquery\nstring\ntrue\n\n\n\n\n\n\n\n\n\n\n\nResponses\n\n\nStatusDescriptionSchema\n\n\n\n\n200\n\nOK\n\n\n\n{\n}\n\n\n\n\n\n\n\n\n\n\n\n\n\n/user/{username}\n\nget\n\n\n Get user details. Requires PROBATION_API__HMPPS_AUTH__USER_DETAILS.\n\n\n\n\nParameters\n\n\nParameterInTypeRequiredDescription\n\n\n\n\nusername\npath\nstring\ntrue\n\n\n\n\n\n\n\n\n\n\n\nResponses\n\n\nStatusDescriptionSchema\n\n\n\n\n200\n\nOK\n\n\n\n{\n \"userId\": \"integer\",\n \"username\": \"string\",\n \"firstName\": \"string\",\n \"surname\": \"string\",\n \"email\": \"string\",\n \"enabled\": \"boolean\",\n \"roles\": [\n {\n }\n ]\n}\n\n\n\nUserDetails\n\n\n\n\n\n\n\n\n\n/user/details/{userId}\n\nget\n\n\n Get user details by Id. Requires PROBATION_API__HMPPS_AUTH__USER_DETAILS.\n\n\n\n\nParameters\n\n\nParameterInTypeRequiredDescription\n\n\n\n\nuserId\npath\ninteger\ntrue\n\n\n\n\n\n\n\n\n\n\n\nResponses\n\n\nStatusDescriptionSchema\n\n\n\n\n200\n\nOK\n\n\n\n{\n \"userId\": \"integer\",\n \"username\": \"string\",\n \"firstName\": \"string\",\n \"surname\": \"string\",\n \"email\": \"string\",\n \"enabled\": \"boolean\",\n \"roles\": [\n {\n }\n ]\n}\n\n\n\nUserDetails\n\n\n\n\n\n\n\n\n\n\nSchemas\nPasswordChangeRequest\n\n\n\n\nNameTypeRequiredDescriptionSchema\n\n\n\n\npassword\nstring\ntrue\n\n\n \n\n\n\n\n\n\nAuthenticationRequest\n\n\n\n\nNameTypeRequiredDescriptionSchema\n\n\n\n\nusername\nstring\ntrue\n\n\n \n\n\n\n\npassword\nstring\ntrue\n\n\n \n\n\n\n\n\n\nUserDetails\n\n\n\n\nNameTypeRequiredDescriptionSchema\n\n\n\n\nuserId\ninteger\ntrue\n\n\n \n\n\n\n\nusername\nstring\ntrue\n\n\n \n\n\n\n\nfirstName\nstring\ntrue\n\n\n \n\n\n\n\nsurname\nstring\ntrue\n\n\n \n\n\n\n\nemail\nstring\nfalse\n\n\n \n\n\n\n\nenabled\nboolean\ntrue\n\n\n \n\n\n\n\nroles\narray\ntrue\n\n\n \n\n\n\n\n\n\n\n","url":"/api-reference.html"}}} \ No newline at end of file +{"index": {"version":"0.7.0","fields":[{"name":"title","boost":100},{"name":"content","boost":50}],"ref":"id","tokenizer":"default","documentStore":{"store":{"11":["about","and","auth","delius","describe","hmpps","service","the","todo"],"12":["200","401","403","404","a","also","and","api","array","authenticate","authenticated","authentication","authenticationrequest","available","boolean","by","change","changed","client","delius","delius_user_auth","details","display","documentation","email","enabled","failure","false","firstname","following","formats","found","get","h1","id","important","in","integer","is","json","nametyperequireddescriptionschema","none","not","ok","openapi","parameterintyperequireddescription","parameters","password","passwordchangerequest","path","post","probation_api__hmpps_auth__authenticate","probation_api__hmpps_auth__password__rw","probation_api__hmpps_auth__user_details","query","reference","required","requires","responses","role","roles","schemas","statusdescriptionschema","string","successfully","surname","swagger","technical","the","these","true","ui","user","userdetails","userid","username","users","user’s","v1.0","yaml"]},"length":2},"tokenStore":{"root":{"2":{"0":{"0":{"docs":{"12":{"ref":12,"tf":1.2626262626262625}}},"docs":{}},"docs":{}},"4":{"0":{"1":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"3":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"4":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"docs":{}},"docs":{}},"docs":{},"a":{"docs":{"12":{"ref":12,"tf":0.5050505050505051}},"b":{"docs":{},"o":{"docs":{},"u":{"docs":{},"t":{"docs":{"11":{"ref":11,"tf":100}}}}}},"n":{"docs":{},"d":{"docs":{"11":{"ref":11,"tf":6.25},"12":{"ref":12,"tf":0.25252525252525254}}}},"u":{"docs":{},"t":{"docs":{},"h":{"docs":{"11":{"ref":11,"tf":6.25}},"e":{"docs":{},"n":{"docs":{},"t":{"docs":{},"i":{"docs":{},"c":{"docs":{},"a":{"docs":{},"t":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.5050505050505051}},"d":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}},"i":{"docs":{},"o":{"docs":{},"n":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}},"r":{"docs":{},"e":{"docs":{},"q":{"docs":{},"u":{"docs":{},"e":{"docs":{},"s":{"docs":{},"t":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}}}}}}}}}}}}}},"l":{"docs":{},"s":{"docs":{},"o":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}},"p":{"docs":{},"i":{"docs":{"12":{"ref":12,"tf":50.505050505050505}}}},"r":{"docs":{},"r":{"docs":{},"a":{"docs":{},"y":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}},"v":{"docs":{},"a":{"docs":{},"i":{"docs":{},"l":{"docs":{},"a":{"docs":{},"b":{"docs":{},"l":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}}},"d":{"docs":{},"e":{"docs":{},"l":{"docs":{},"i":{"docs":{},"u":{"docs":{},"s":{"docs":{"11":{"ref":11,"tf":6.25},"12":{"ref":12,"tf":0.5050505050505051}},"_":{"docs":{},"u":{"docs":{},"s":{"docs":{},"e":{"docs":{},"r":{"docs":{},"_":{"docs":{},"a":{"docs":{},"u":{"docs":{},"t":{"docs":{},"h":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}}}}}}}},"s":{"docs":{},"c":{"docs":{},"r":{"docs":{},"i":{"docs":{},"b":{"docs":{},"e":{"docs":{"11":{"ref":11,"tf":6.25}}}}}}}},"t":{"docs":{},"a":{"docs":{},"i":{"docs":{},"l":{"docs":{},"s":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}},"i":{"docs":{},"s":{"docs":{},"p":{"docs":{},"l":{"docs":{},"a":{"docs":{},"y":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}},"o":{"docs":{},"c":{"docs":{},"u":{"docs":{},"m":{"docs":{},"e":{"docs":{},"n":{"docs":{},"t":{"docs":{},"a":{"docs":{},"t":{"docs":{},"i":{"docs":{},"o":{"docs":{},"n":{"docs":{"12":{"ref":12,"tf":0.5050505050505051}}}}}}}}}}}}}}},"h":{"1":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"docs":{},"m":{"docs":{},"p":{"docs":{},"p":{"docs":{},"s":{"docs":{"11":{"ref":11,"tf":6.25}}}}}}},"s":{"docs":{},"e":{"docs":{},"r":{"docs":{},"v":{"docs":{},"i":{"docs":{},"c":{"docs":{},"e":{"docs":{"11":{"ref":11,"tf":6.25}}}}}}}},"c":{"docs":{},"h":{"docs":{},"e":{"docs":{},"m":{"docs":{},"a":{"docs":{},"s":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}},"t":{"docs":{},"a":{"docs":{},"t":{"docs":{},"u":{"docs":{},"s":{"docs":{},"d":{"docs":{},"e":{"docs":{},"s":{"docs":{},"c":{"docs":{},"r":{"docs":{},"i":{"docs":{},"p":{"docs":{},"t":{"docs":{},"i":{"docs":{},"o":{"docs":{},"n":{"docs":{},"s":{"docs":{},"c":{"docs":{},"h":{"docs":{},"e":{"docs":{},"m":{"docs":{},"a":{"docs":{"12":{"ref":12,"tf":1.2626262626262625}}}}}}}}}}}}}}}}}}}}}}},"r":{"docs":{},"i":{"docs":{},"n":{"docs":{},"g":{"docs":{"12":{"ref":12,"tf":4.545454545454546}}}}}}},"u":{"docs":{},"c":{"docs":{},"c":{"docs":{},"e":{"docs":{},"s":{"docs":{},"s":{"docs":{},"f":{"docs":{},"u":{"docs":{},"l":{"docs":{},"l":{"docs":{},"y":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}}}},"r":{"docs":{},"n":{"docs":{},"a":{"docs":{},"m":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}},"w":{"docs":{},"a":{"docs":{},"g":{"docs":{},"g":{"docs":{},"e":{"docs":{},"r":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}},"t":{"docs":{},"h":{"docs":{},"e":{"docs":{"11":{"ref":11,"tf":6.25},"12":{"ref":12,"tf":0.25252525252525254}},"s":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}},"o":{"docs":{},"d":{"docs":{},"o":{"docs":{"11":{"ref":11,"tf":6.25}}}}},"e":{"docs":{},"c":{"docs":{},"h":{"docs":{},"n":{"docs":{},"i":{"docs":{},"c":{"docs":{},"a":{"docs":{},"l":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}},"r":{"docs":{},"u":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":3.2828282828282833}}}}}},"b":{"docs":{},"o":{"docs":{},"o":{"docs":{},"l":{"docs":{},"e":{"docs":{},"a":{"docs":{},"n":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}},"y":{"docs":{"12":{"ref":12,"tf":0.5050505050505051}}}},"c":{"docs":{},"h":{"docs":{},"a":{"docs":{},"n":{"docs":{},"g":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}},"d":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}},"l":{"docs":{},"i":{"docs":{},"e":{"docs":{},"n":{"docs":{},"t":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}},"e":{"docs":{},"m":{"docs":{},"a":{"docs":{},"i":{"docs":{},"l":{"docs":{"12":{"ref":12,"tf":1.2626262626262625}}}}}},"n":{"docs":{},"a":{"docs":{},"b":{"docs":{},"l":{"docs":{},"e":{"docs":{},"d":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}}},"f":{"docs":{},"a":{"docs":{},"i":{"docs":{},"l":{"docs":{},"u":{"docs":{},"r":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}},"l":{"docs":{},"s":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}},"i":{"docs":{},"r":{"docs":{},"s":{"docs":{},"t":{"docs":{},"n":{"docs":{},"a":{"docs":{},"m":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}}}},"o":{"docs":{},"l":{"docs":{},"l":{"docs":{},"o":{"docs":{},"w":{"docs":{},"i":{"docs":{},"n":{"docs":{},"g":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}},"r":{"docs":{},"m":{"docs":{},"a":{"docs":{},"t":{"docs":{},"s":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}},"u":{"docs":{},"n":{"docs":{},"d":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}},"g":{"docs":{},"e":{"docs":{},"t":{"docs":{"12":{"ref":12,"tf":1.5151515151515151}}}}},"i":{"docs":{},"d":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"m":{"docs":{},"p":{"docs":{},"o":{"docs":{},"r":{"docs":{},"t":{"docs":{},"a":{"docs":{},"n":{"docs":{},"t":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}},"n":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}},"t":{"docs":{},"e":{"docs":{},"g":{"docs":{},"e":{"docs":{},"r":{"docs":{"12":{"ref":12,"tf":1.0101010101010102}}}}}}}},"s":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}},"j":{"docs":{},"s":{"docs":{},"o":{"docs":{},"n":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}},"n":{"docs":{},"a":{"docs":{},"m":{"docs":{},"e":{"docs":{},"t":{"docs":{},"y":{"docs":{},"p":{"docs":{},"e":{"docs":{},"r":{"docs":{},"e":{"docs":{},"q":{"docs":{},"u":{"docs":{},"i":{"docs":{},"r":{"docs":{},"e":{"docs":{},"d":{"docs":{},"d":{"docs":{},"e":{"docs":{},"s":{"docs":{},"c":{"docs":{},"r":{"docs":{},"i":{"docs":{},"p":{"docs":{},"t":{"docs":{},"i":{"docs":{},"o":{"docs":{},"n":{"docs":{},"s":{"docs":{},"c":{"docs":{},"h":{"docs":{},"e":{"docs":{},"m":{"docs":{},"a":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}},"o":{"docs":{},"n":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}},"t":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}},"o":{"docs":{},"k":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}},"p":{"docs":{},"e":{"docs":{},"n":{"docs":{},"a":{"docs":{},"p":{"docs":{},"i":{"docs":{"12":{"ref":12,"tf":0.5050505050505051}}}}}}}}},"p":{"docs":{},"a":{"docs":{},"r":{"docs":{},"a":{"docs":{},"m":{"docs":{},"e":{"docs":{},"t":{"docs":{},"e":{"docs":{},"r":{"docs":{},"i":{"docs":{},"n":{"docs":{},"t":{"docs":{},"y":{"docs":{},"p":{"docs":{},"e":{"docs":{},"r":{"docs":{},"e":{"docs":{},"q":{"docs":{},"u":{"docs":{},"i":{"docs":{},"r":{"docs":{},"e":{"docs":{},"d":{"docs":{},"d":{"docs":{},"e":{"docs":{},"s":{"docs":{},"c":{"docs":{},"r":{"docs":{},"i":{"docs":{},"p":{"docs":{},"t":{"docs":{},"i":{"docs":{},"o":{"docs":{},"n":{"docs":{"12":{"ref":12,"tf":1.0101010101010102}}}}}}}}}}}}}}}}}}}}}}}}}}},"s":{"docs":{"12":{"ref":12,"tf":1.0101010101010102}}}}}}}}}},"s":{"docs":{},"s":{"docs":{},"w":{"docs":{},"o":{"docs":{},"r":{"docs":{},"d":{"docs":{"12":{"ref":12,"tf":1.5151515151515151}},"c":{"docs":{},"h":{"docs":{},"a":{"docs":{},"n":{"docs":{},"g":{"docs":{},"e":{"docs":{},"r":{"docs":{},"e":{"docs":{},"q":{"docs":{},"u":{"docs":{},"e":{"docs":{},"s":{"docs":{},"t":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}}}}}}}}}}}}},"t":{"docs":{},"h":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}},"o":{"docs":{},"s":{"docs":{},"t":{"docs":{"12":{"ref":12,"tf":0.5050505050505051}}}}},"r":{"docs":{},"o":{"docs":{},"b":{"docs":{},"a":{"docs":{},"t":{"docs":{},"i":{"docs":{},"o":{"docs":{},"n":{"docs":{},"_":{"docs":{},"a":{"docs":{},"p":{"docs":{},"i":{"docs":{},"_":{"docs":{},"_":{"docs":{},"h":{"docs":{},"m":{"docs":{},"p":{"docs":{},"p":{"docs":{},"s":{"docs":{},"_":{"docs":{},"a":{"docs":{},"u":{"docs":{},"t":{"docs":{},"h":{"docs":{},"_":{"docs":{},"_":{"docs":{},"a":{"docs":{},"u":{"docs":{},"t":{"docs":{},"h":{"docs":{},"e":{"docs":{},"n":{"docs":{},"t":{"docs":{},"i":{"docs":{},"c":{"docs":{},"a":{"docs":{},"t":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}}}}}},"p":{"docs":{},"a":{"docs":{},"s":{"docs":{},"s":{"docs":{},"w":{"docs":{},"o":{"docs":{},"r":{"docs":{},"d":{"docs":{},"_":{"docs":{},"_":{"docs":{},"r":{"docs":{},"w":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}}}}}}}},"u":{"docs":{},"s":{"docs":{},"e":{"docs":{},"r":{"docs":{},"_":{"docs":{},"d":{"docs":{},"e":{"docs":{},"t":{"docs":{},"a":{"docs":{},"i":{"docs":{},"l":{"docs":{},"s":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}},"q":{"docs":{},"u":{"docs":{},"e":{"docs":{},"r":{"docs":{},"y":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}},"r":{"docs":{},"e":{"docs":{},"f":{"docs":{},"e":{"docs":{},"r":{"docs":{},"e":{"docs":{},"n":{"docs":{},"c":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":50.505050505050505}}}}}}}}},"q":{"docs":{},"u":{"docs":{},"i":{"docs":{},"r":{"docs":{},"e":{"docs":{},"d":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"s":{"docs":{"12":{"ref":12,"tf":1.2626262626262625}}}}}}}},"s":{"docs":{},"p":{"docs":{},"o":{"docs":{},"n":{"docs":{},"s":{"docs":{},"e":{"docs":{},"s":{"docs":{"12":{"ref":12,"tf":1.2626262626262625}}}}}}}}}},"o":{"docs":{},"l":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}},"s":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}},"u":{"docs":{},"i":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"s":{"docs":{},"e":{"docs":{},"r":{"docs":{"12":{"ref":12,"tf":2.0202020202020203}},"d":{"docs":{},"e":{"docs":{},"t":{"docs":{},"a":{"docs":{},"i":{"docs":{},"l":{"docs":{},"s":{"docs":{"12":{"ref":12,"tf":0.7575757575757576}}}}}}}}},"i":{"docs":{},"d":{"docs":{"12":{"ref":12,"tf":1.2626262626262625}}}},"n":{"docs":{},"a":{"docs":{},"m":{"docs":{},"e":{"docs":{"12":{"ref":12,"tf":2.272727272727273}}}}}},"s":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"’":{"docs":{},"s":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}}},"v":{"1":{"docs":{},".":{"0":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}},"docs":{}}},"docs":{}},"y":{"docs":{},"a":{"docs":{},"m":{"docs":{},"l":{"docs":{"12":{"ref":12,"tf":0.25252525252525254}}}}}}},"length":89},"corpusTokens":["200","401","403","404","a","about","also","and","api","array","auth","authenticate","authenticated","authentication","authenticationrequest","available","boolean","by","change","changed","client","delius","delius_user_auth","describe","details","display","documentation","email","enabled","failure","false","firstname","following","formats","found","get","h1","hmpps","id","important","in","integer","is","json","nametyperequireddescriptionschema","none","not","ok","openapi","parameterintyperequireddescription","parameters","password","passwordchangerequest","path","post","probation_api__hmpps_auth__authenticate","probation_api__hmpps_auth__password__rw","probation_api__hmpps_auth__user_details","query","reference","required","requires","responses","role","roles","schemas","service","statusdescriptionschema","string","successfully","surname","swagger","technical","the","these","todo","true","ui","user","userdetails","userid","username","users","user’s","v1.0","yaml"],"pipeline":["trimmer"]}, "docs": {"11":{"title":"About","content":"hmpps-auth-and-delius\n// TODO Describe the service\n","url":"/"},"12":{"title":"API Reference","content":"\n \n API Reference\n\n\n.technical-documentation \u003e h1 { display: none !important }\nThe following documentation is also available in these formats:\n\n\nOpenAPI JSON\nOpenAPI YAML\nSwagger UI\n\nAPI Reference v1.0\n\n\n\n\n\n\n/user/{username}/password\n\npost\n\n\n Change a Delius user’s password. Requires PROBATION_API__HMPPS_AUTH__PASSWORD__RW.\n\n\n\n\nParameters\n\n\nParameterInTypeRequiredDescription\n\n\n\n\nusername\npath\nstring\ntrue\n\n\n\n\n\n\n\n\n\n\n\nResponses\n\n\nStatusDescriptionSchema\n\n\n\n\n200\n\nPassword changed successfully\n\n\n\n\n\n\n\n\n\n\n404\n\nUser not found\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n/authenticate\n\npost\n\n\n Authenticate a Delius username and password. Requires PROBATION_API__HMPPS_AUTH__AUTHENTICATE.\n\n\n\n\n\n\n\nResponses\n\n\nStatusDescriptionSchema\n\n\n\n\n200\n\nUser authenticated\n\n\n\n\n\n\n\n\n\n\n403\n\nClient role required: DELIUS_USER_AUTH\n\n\n\n\n\n\n\n\n\n\n401\n\nAuthentication failure\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n/user\n\nget\n\n\n Get users by email. Requires PROBATION_API__HMPPS_AUTH__USER_DETAILS.\n\n\n\n\nParameters\n\n\nParameterInTypeRequiredDescription\n\n\n\n\nemail\nquery\nstring\ntrue\n\n\n\n\n\n\n\n\n\n\n\nResponses\n\n\nStatusDescriptionSchema\n\n\n\n\n200\n\nOK\n\n\n\n{\n}\n\n\n\n\n\n\n\n\n\n\n\n\n\n/user/{username}\n\nget\n\n\n Get user details. Requires PROBATION_API__HMPPS_AUTH__USER_DETAILS.\n\n\n\n\nParameters\n\n\nParameterInTypeRequiredDescription\n\n\n\n\nusername\npath\nstring\ntrue\n\n\n\n\n\n\n\n\n\n\n\nResponses\n\n\nStatusDescriptionSchema\n\n\n\n\n200\n\nOK\n\n\n\n{\n \"userId\": \"integer\",\n \"username\": \"string\",\n \"firstName\": \"string\",\n \"surname\": \"string\",\n \"email\": \"string\",\n \"enabled\": \"boolean\",\n \"roles\": [\n {\n }\n ]\n}\n\n\n\nUserDetails\n\n\n\n\n\n\n\n\n\n/user/details/{userId}\n\nget\n\n\n Get user details by Id. Requires PROBATION_API__HMPPS_AUTH__USER_DETAILS.\n\n\n\n\nParameters\n\n\nParameterInTypeRequiredDescription\n\n\n\n\nuserId\npath\ninteger\ntrue\n\n\n\n\n\n\n\n\n\n\n\nResponses\n\n\nStatusDescriptionSchema\n\n\n\n\n200\n\nOK\n\n\n\n{\n \"userId\": \"integer\",\n \"username\": \"string\",\n \"firstName\": \"string\",\n \"surname\": \"string\",\n \"email\": \"string\",\n \"enabled\": \"boolean\",\n \"roles\": [\n {\n }\n ]\n}\n\n\n\nUserDetails\n\n\n\n\n\n\n\n\n\n\nSchemas\nPasswordChangeRequest\n\n\n\n\nNameTypeRequiredDescriptionSchema\n\n\n\n\npassword\nstring\ntrue\n\n\n \n\n\n\n\n\n\nAuthenticationRequest\n\n\n\n\nNameTypeRequiredDescriptionSchema\n\n\n\n\nusername\nstring\ntrue\n\n\n \n\n\n\n\npassword\nstring\ntrue\n\n\n \n\n\n\n\n\n\nUserDetails\n\n\n\n\nNameTypeRequiredDescriptionSchema\n\n\n\n\nuserId\ninteger\ntrue\n\n\n \n\n\n\n\nusername\nstring\ntrue\n\n\n \n\n\n\n\nfirstName\nstring\ntrue\n\n\n \n\n\n\n\nsurname\nstring\ntrue\n\n\n \n\n\n\n\nemail\nstring\nfalse\n\n\n \n\n\n\n\nenabled\nboolean\ntrue\n\n\n \n\n\n\n\nroles\narray\ntrue\n\n\n \n\n\n\n\n\n\n\n","url":"/api-reference.html"}}} \ No newline at end of file