Users API

Golden 3.0.0 public API reference. Parameters, responses, and schemas for supported customer operations.

16 operations.

GET /api/security/roles

Get available roles

Operation ID: getAvailableRoles

Returns the list of available roles defined by the application. Requires ADMIN role.

Security: bearerAuth

Parameters

Responses

GET /api/security/users

List all users

Operation ID: findAllUsers

Retrieves all users. Requires ADMIN role.

Security: bearerAuth

Parameters

Responses

POST /api/security/users

Create user

Operation ID: createUser

Creates a new user. Requires ADMIN role.

Security: bearerAuth

Parameters

Request body

Responses

GET /api/security/users/id/{id}

Get user by ID

Operation ID: findByUserId

Retrieves a user by identifier. Requires ADMIN role.

Security: bearerAuth

Parameters

Responses

GET /api/security/users/my

Get my user

Operation ID: findMyUser

Retrieves the authenticated user’s profile. Restricted to authenticated users.

Security: bearerAuth

Responses

PUT /api/security/users/my

Update my profile

Operation ID: updateMyUser

Updates the authenticated user’s profile. Restricted to authenticated users.

Security: bearerAuth

Parameters

Request body

Responses

PUT /api/security/users/password/my

Update my password

Operation ID: updateMyPassword

Updates the authenticated user’s password. Restricted to authenticated users.

Security: bearerAuth

Parameters

Request body

Responses

PUT /api/security/users/password/{id}

Set user password

Operation ID: setUserPassword

Sets a user’s password directly. Requires ADMIN role. This is the way out on a deployment with no notification provider, where the reset link cannot be delivered.

Security: bearerAuth

Parameters

Request body

Responses

DELETE /api/security/users/password/{id}

Reset user password

Operation ID: resetPassword

Resets password for a user. Requires ADMIN role. Answers 502 if the notification provider could not accept the message: the reset link exists only inside that message, so a failed delivery leaves nothing usable behind.

Security: bearerAuth

Parameters

Responses

PUT /api/security/users/{id}

Update user

Operation ID: updateUser

Updates an existing user. Requires ADMIN role.

Security: bearerAuth

Parameters

Request body

Responses

DELETE /api/security/users/{id}

Delete user

Operation ID: deleteUser

Deletes a user. Requires ADMIN role.

Security: bearerAuth

Parameters

Responses

PUT /api/security/users/{id}/disable

Disable user

Operation ID: disableUser

Disables a user without replacing the rest of the aggregate. This is the reversible form of removing an account; DELETE is not reversible. Requires ADMIN.

Security: bearerAuth

Parameters

Responses

PUT /api/security/users/{id}/enable

Enable user

Operation ID: enableUser

Enables a user without replacing the rest of the aggregate. Requires ADMIN.

Security: bearerAuth

Parameters

Responses

POST /api/security/users/{id}/roles/{role}

Add role to user

Operation ID: addRole

Adds a role to a user. Requires ADMIN role.

Security: bearerAuth

Parameters

Responses

DELETE /api/security/users/{id}/roles/{role}

Remove role from user

Operation ID: removeRole

Removes a role from a user. Requires ADMIN role.

Security: bearerAuth

Parameters

Responses

PUT /api/security/users/{id}/unlock

Unlock user

Operation ID: unlockUser

Lifts a lockout and resets the failure counter without touching the password. Requires ADMIN.

Security: bearerAuth

Parameters

Responses