User

Assign a healthcare party ID to current user

PUT https://demo.icure.cloud/rest/v2/user/current/hcparty/{healthcarePartyId}

UserDto gets returned.

Path Parameters

Name	Type	Description
healthcarePartyId*	String

200

GET https://demo.icure.cloud/rest/v2/user/checkPassword

Headers

Name	Type	Description
password*	String

200

Check token validity

GET https://demo.icure.cloud/rest/v2/user/token/{userId}

Path Parameters

Name	Type	Description
userId*	String

Headers

Name	Type	Description
token*	String

200

Create a user

POST https://demo.icure.cloud/rest/v2/user

Create a user. HealthcareParty ID should be set. Email or Login have to be set. If login hasn't been set, Email will be used for Login instead.

Request Body

Name	Type	Description
body*	User

200

Create a user

POST https://demo.icure.cloud/rest/v2/user/inGroup/{groupId}

Create a user. HealthcareParty ID should be set. Email has to be set and the Login has to be null. On server-side, Email will be used for Login.

Path Parameters

Name	Type	Description
groupId*	String

Request Body

Name	Type	Description
body*	User

200

Delete a User based on his/her ID.

DELETE https://demo.icure.cloud/rest/v2/user/{userId}

Delete a User based on his/her ID. The return value is an array containing the ID of deleted user.

Path Parameters

Name	Type	Description
userId*	String

200

Delete a User based on his/her ID.

DELETE https://demo.icure.cloud/rest/v2/user/inGroup/{groupId}/{userId}

Delete a User based on his/her ID. The return value is an array containing the ID of deleted user.

Path Parameters

Name	Type	Description
groupId*	String
userId*	String

200

GET https://demo.icure.cloud/rest/v2/user/encodePassword

Headers

Name	Type	Description
password*	String

200

Get the list of users by healthcare party id

GET https://demo.icure.cloud/rest/v2/user/byHealthcarePartyId/{id}

Path Parameters

Name	Type	Description
id*	String

200

Send a forgotten email message to an user

POST https://demo.icure.cloud/rest/v2/user/forgottenPassword/{email}

Path Parameters

Name	Type	Description
email*	String	the email of the user

Request Body

Name	Type	Description
body*	EmailTemplate

200

Get Currently logged-in user session.

GET https://demo.icure.cloud/rest/v2/user/session

Get current user.

200

Get presently logged-in user.

GET https://demo.icure.cloud/rest/v2/user/current

Get current user.

200

Get presently logged-in user.

GET https://demo.icure.cloud/rest/v2/user/matches

Get current user.

200

Require a new temporary token for authentication

POST https://demo.icure.cloud/rest/v2/user/token/{userId}/{key}

Path Parameters

Name	Type	Description
userId*	String
key*	String	The token key. Only one instance of a token with a defined key can exist at the same time

Query Parameters

Name	Type	Description
tokenValidity	Long	The token validity in seconds

200

Get a user by his ID

GET https://demo.icure.cloud/rest/v2/user/{userId}

General information about the user

Path Parameters

Name	Type	Description
userId*	String

200

Get a user by his Email/Login

GET https://demo.icure.cloud/rest/v2/user/byEmail/{email}

General information about the user

Path Parameters

Name	Type	Description
email*	String

200

List users with(out) pagination

GET https://demo.icure.cloud/rest/v2/user

Returns a list of users.

Query Parameters

Name	Type	Description
startKey	String	An user email
startDocumentId	String	An user document ID
limit	Integer	Number of rows

200

List users with(out) pagination

GET https://demo.icure.cloud/rest/v2/user/inGroup/{groupId}

Returns a list of users.

Path Parameters

Name	Type	Description
groupId*	String

Query Parameters

Name	Type	Description
startKey	String	An user login
startDocumentId	String	An user document ID
limit	Integer	Number of rows

200

Modify a User property

PUT https://demo.icure.cloud/rest/v2/user/{userId}/properties

Modify a User properties based on his/her ID. The return value is the modified user.

Path Parameters

Name	Type	Description
userId*	String

Request Body

Name	Type	Description
body	List

200

Modify a user.

PUT https://demo.icure.cloud/rest/v2/user

No particular return value. It's just a message.

Request Body

Name	Type	Description
body*	User

200

Modify a user.

PUT https://demo.icure.cloud/rest/v2/user/inGroup/{groupId}

No particular return value. It's just a message.

Path Parameters

Name	Type	Description
groupId*	String

Request Body

Name	Type	Description
body*	User

200