API Reference

The following documentation is also available in these formats:

• OpenAPI JSON
• OpenAPI YAML
• Swagger UI

API Reference v1.0

/user/{username}/password

post

Change a Delius user’s password. Requires PROBATION_API__HMPPS_AUTH__PASSWORD__RW.

Parameters

Parameter	In	Type	Required	Description
username	path	string	true

Responses

Status	Description	Schema
200	Password changed successfully
404	User not found

/authenticate

post

Authenticate a Delius username and password. Requires PROBATION_API__HMPPS_AUTH__AUTHENTICATE.

Responses

Status	Description	Schema
200	User authenticated
401	Authentication failure
403	Client role required: DELIUS_USER_AUTH

/user

get

Get users by email. Requires PROBATION_API__HMPPS_AUTH__USER_DETAILS.

Parameters

Parameter	In	Type	Required	Description
email	query	string	true

Responses

Status	Description	Schema
200	OK { }

/user/{username}

get

Get user details. Requires PROBATION_API__HMPPS_AUTH__USER_DETAILS.

Parameters

Parameter	In	Type	Required	Description
username	path	string	true

Responses

Status	Description	Schema
200	OK { "userId": "integer", "username": "string", "firstName": "string", "surname": "string", "email": "string", "enabled": "boolean", "roles": [ { } ] }	UserDetails

/user/details/{userId}

get

Get user details by Id. Requires PROBATION_API__HMPPS_AUTH__USER_DETAILS.

Parameters

Parameter	In	Type	Required	Description
userId	path	integer	true

Responses

Status	Description	Schema
200	OK { "userId": "integer", "username": "string", "firstName": "string", "surname": "string", "email": "string", "enabled": "boolean", "roles": [ { } ] }	UserDetails

Schemas

PasswordChangeRequest

Name	Type	Required	Description	Schema
password	string	true

AuthenticationRequest

Name	Type	Required	Description	Schema
username	string	true
password	string	true

UserDetails

Name	Type	Required	Description	Schema
userId	integer	true
username	string	true
firstName	string	true
surname	string	true
email	string	false
enabled	boolean	true
roles	array	true