/user

Previous/signup

Last updated 10 days ago

Search Users

Searches all users in the system and returning the metadata for all matches against the given search filter.

get

/user

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/user' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a User

Supplying the user object, this will update the user with the new information supplied in the body of the request. Optionally, the user's password may be provided in the User object.

post

/user

Authorizations

Body

nameany

Pattern: ^\S+$

emailany

Pattern: ^(.+)@(.+)$

primaryPhoneNbany

Pattern: ([\.\+\-\s\/()]*[0-9][\.\+\-\s\/()]*){8,15}

firstNameany

Pattern: ^[A-Za-z0-9 ]{2,20}

lastNameany

Pattern: ^[A-Za-z0-9 ]{3,30}

passwordany

The user's plaintext password, only to be provided in POST/PUT requests in the User Resource REST API interface. In the future, a dedicated REST API model may be constructed instead of using a direct User model.

Pattern: ^\S+$

levelundefined · enum

The user's level to assign. Depending on the usage, the server may ignore this field and assign its own description.

Options: UNPRIVILEGED, USER, SUPERUSER

profilesany

Used in conjunction with the user creation request to specify.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/user' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "name": null,
    "email": null,
    "primaryPhoneNb": null,
    "firstName": null,
    "lastName": null,
    "password": null,
    "level": "UNPRIVILEGED",
    "profiles": [
      {
        "applicationId": null,
        "displayName": null,
        "imageUrl": null
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a Specific User

Gets a specific user by email or unique user ID.

get

/user/{name}

Authorizations

Path parameters

nameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/user/{name}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a User

Deletes and permanently removes the user from the server. The server may keep some metadata as necessary to avoid data inconsistency. However, the user has been deleted from the client standpoint and will not be accessible through any of the existing APIs.

delete

/user/{name}

Authorizations

Path parameters

nameanyrequired

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/user/{name}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a User's Password

Supplying the UserUpdatePasswordRequest, this will attempt to update the user's password only if they supply the correct existing password.

put

/user/{userId}/password

Authorizations

Path parameters

userIdanyrequired

Body

oldPasswordanyrequired

The user's current password.

newPasswordanyrequired

The user's updated password.

profileIdany

The user's profile id to assign the new session. Leave blank for no profile id.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/user/{userId}/password' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "oldPassword": null,
    "newPassword": null,
    "profileId": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a User

Supplying the user object, this will update the user with the new information supplied in the body of the request. Optionally, the user's password may be provided in the User object.

put

/user/{userId}

Authorizations

Path parameters

userIdanyrequired

Body

nameanyrequired

Pattern: ^\S+$

emailanyrequired

Pattern: ^(.+)@(.+)$

primaryPhoneNbany

Pattern: ([\.\+\-\s\/()]*[0-9][\.\+\-\s\/()]*){8,15}

firstNameany

Pattern: ^[A-Za-z0-9 ]{2,20}

lastNameany

Pattern: ^[A-Za-z0-9 ]{3,30}

passwordany

Pattern: ^\S+$

levelundefined · enumrequired

Options: UNPRIVILEGED, USER, SUPERUSER

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/user/{userId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "name": null,
    "email": null,
    "primaryPhoneNb": null,
    "firstName": null,
    "lastName": null,
    "password": null,
    "level": "UNPRIVILEGED"
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets the current User

A special endpoint used to get the current user for the request. The current user is typically associated with the session but may be derived any other way. This is essentially an alias for using GET /user/myUserId

get

/user/me

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/user/me' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}