Skip to content
/
Check if user exists

Elevate Authentication & Users API (1.5)

Authentication

Elevate API uses Bearer authentication (also called token authentication) - this is an HTTP authentication scheme that uses security tokens called bearer tokens The bearer tokens used by Elevate are the industry standard JSON Web Tokens (JWT)

The client can obtain the token from this endpoint and must send this token in the Authorization header when making requests to other endpoints Tokens will be valid for 15 minutes before a new token must be obtained

Download OpenAPI description
billing-rest-authentication.json
billing-rest-authentication.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

authentication

The Elevate REST API uses JWT Bearer tokens for authentication

Operations

users

An identification used by a person with access to Elevate

Operations

Get a list of available users

Request

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fieldsstring(FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
usernamestring(StringFilterParam)

Filter by username

Example: username=xyz | in:x,y | like:xyz
emailstring(StringFilterParam)

Filter by email

Example: email=xyz | in:x,y | like:xyz
firstNamestring(StringFilterParam)

Filter by first name

Example: firstName=xyz | in:x,y | like:xyz
lastNamestring(StringFilterParam)

Filter by last name

Example: lastName=xyz | in:x,y | like:xyz
contractOwnerstring(StringFilterParam)

Filter by contract owner name

Example: contractOwner=xyz | in:x,y | like:xyz
enabledstring(BooleanFilterParam)

A boolean flag to specify if the user is enabled or disabled

Example: enabled=true | false
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/users?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&username=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&email=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&firstName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&lastName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&contractOwner=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&enabled=true+%2C+false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

User identifier

Example: 1
usernamestring[ 1 .. 100 ] characters[a-zA-Z0-9\p{L}@.\-_]+required

Username

firstNamestring[ 1 .. 50 ] charactersrequired

First name

lastNamestring[ 1 .. 50 ] charactersrequired

Last name

emailstring[ 5 .. 255 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required

Email address

Example: "annon@annon.com"
telephoneNumberstring[ 1 .. 100 ] characters

Telephone number

mobileNumberstring[ 1 .. 30 ] characters

Mobile telephone number

contractOwnerIdinteger

Contract Owner identifier (Optional Contract Owner to associate the user to. If they are associated to a Contract Owner then they will only be able to see and manage that Contract Owner's data)

Example: 1
enabledboolean

User is enabled

Default true
userRolesArray of integersrequired
Example: [1]
]
Response
application/json
[
  {
    "id": 1,
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "annon@annon.com",
    "telephoneNumber": "string",
    "mobileNumber": "string",
    "contractOwnerId": 1,
    "enabled": true,
    "userRoles": [ … ]
  }
]

Check if user exists

Request

Security
bearerAuth
Query
usernamestring(StringFilterParam)

Filter by username

Example: username=xyz | in:x,y | like:xyz
emailstring(StringFilterParam)

Filter by email

Example: email=xyz | in:x,y | like:xyz
firstNamestring(StringFilterParam)

Filter by first name

Example: firstName=xyz | in:x,y | like:xyz
lastNamestring(StringFilterParam)

Filter by last name

Example: lastName=xyz | in:x,y | like:xyz
contractOwnerstring(StringFilterParam)

Filter by contract owner name

Example: contractOwner=xyz | in:x,y | like:xyz
enabledstring(BooleanFilterParam)

A boolean flag to specify if the user is enabled or disabled

Example: enabled=true | false
curl -i -X HEAD \
  'https://rest.elevatebilling.com/v1/users?username=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&email=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&firstName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&lastName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&contractOwner=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&enabled=true+%2C+false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Exists

Headers
X-Total-Countinteger

Total number of users matching the criteria

Create a user

Request

Bodyapplication/jsonrequired

request

usernamestring[ 1 .. 100 ] characters[a-zA-Z0-9\p{L}@.\-_]+required

Username

firstNamestring[ 1 .. 50 ] charactersrequired

First name

lastNamestring[ 1 .. 50 ] charactersrequired

Last name

emailstring[ 5 .. 255 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required

Email address

Example: "annon@annon.com"
telephoneNumberstring[ 1 .. 100 ] characters

Telephone number

mobileNumberstring[ 1 .. 30 ] characters

Mobile telephone number

contractOwnerIdinteger

Contract Owner identifier (Optional Contract Owner to associate the user to. If they are associated to a Contract Owner then they will only be able to see and manage that Contract Owner's data)

Example: 1
enabledboolean

User is enabled

Default true
userRolesArray of integersrequired
Example: [1]
curl -i -X POST \
  https://rest.elevatebilling.com/v1/users \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "annon@annon.com",
    "telephoneNumber": "string",
    "mobileNumber": "string",
    "contractOwnerId": 1,
    "enabled": true,
    "userRoles": [
      1
    ]
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

User identifier

Example: 1
usernamestring[ 1 .. 100 ] characters[a-zA-Z0-9\p{L}@.\-_]+required

Username

firstNamestring[ 1 .. 50 ] charactersrequired

First name

lastNamestring[ 1 .. 50 ] charactersrequired

Last name

emailstring[ 5 .. 255 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required

Email address

Example: "annon@annon.com"
telephoneNumberstring[ 1 .. 100 ] characters

Telephone number

mobileNumberstring[ 1 .. 30 ] characters

Mobile telephone number

contractOwnerIdinteger

Contract Owner identifier (Optional Contract Owner to associate the user to. If they are associated to a Contract Owner then they will only be able to see and manage that Contract Owner's data)

Example: 1
enabledboolean

User is enabled

Default true
userRolesArray of integersrequired
Example: [1]
Response
application/json
{
  "id": 1,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "annon@annon.com",
  "telephoneNumber": "string",
  "mobileNumber": "string",
  "contractOwnerId": 1,
  "enabled": true,
  "userRoles": [
    1
  ]
}

Get a specific user

Request

Security
bearerAuth
Path
user_idinteger(int64)(IdParam)>= 1required

User identifier

Example: 1
curl -i -X GET \
  https://rest.elevatebilling.com/v1/users/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

User found

Bodyapplication/json
idinteger(int64)read-only

User identifier

Example: 1
usernamestring[ 1 .. 100 ] characters[a-zA-Z0-9\p{L}@.\-_]+required

Username

firstNamestring[ 1 .. 50 ] charactersrequired

First name

lastNamestring[ 1 .. 50 ] charactersrequired

Last name

emailstring[ 5 .. 255 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required

Email address

Example: "annon@annon.com"
telephoneNumberstring[ 1 .. 100 ] characters

Telephone number

mobileNumberstring[ 1 .. 30 ] characters

Mobile telephone number

contractOwnerIdinteger

Contract Owner identifier (Optional Contract Owner to associate the user to. If they are associated to a Contract Owner then they will only be able to see and manage that Contract Owner's data)

Example: 1
enabledboolean

User is enabled

Default true
userRolesArray of integersrequired
Example: [1]
Response
application/json
{
  "id": 1,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "annon@annon.com",
  "telephoneNumber": "string",
  "mobileNumber": "string",
  "contractOwnerId": 1,
  "enabled": true,
  "userRoles": [
    1
  ]
}

Update a user

Request

Security
bearerAuth
Path
user_idinteger(int64)(IdParam)>= 1required

User identifier

Example: 1
Bodyapplication/json-patch+jsonrequired

A set of JSONPatch operations to be performed

Array [
opstringrequired

The JSON Patch operation to be performed

Enum"add""remove""replace""move""copy""test"
pathstringrequired

A JSON-Pointer

valueobject

The value to be used within the operations

fromstring

A string containing a JSON Pointer value

]
curl -i -X PATCH \
  https://rest.elevatebilling.com/v1/users/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/firstName",
      "value": "Frank"
    },
    {
      "op": "replace",
      "path": "/lastName",
      "value": "Simpson"
    }
  ]'

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

User identifier

Example: 1
usernamestring[ 1 .. 100 ] characters[a-zA-Z0-9\p{L}@.\-_]+required

Username

firstNamestring[ 1 .. 50 ] charactersrequired

First name

lastNamestring[ 1 .. 50 ] charactersrequired

Last name

emailstring[ 5 .. 255 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required

Email address

Example: "annon@annon.com"
telephoneNumberstring[ 1 .. 100 ] characters

Telephone number

mobileNumberstring[ 1 .. 30 ] characters

Mobile telephone number

contractOwnerIdinteger

Contract Owner identifier (Optional Contract Owner to associate the user to. If they are associated to a Contract Owner then they will only be able to see and manage that Contract Owner's data)

Example: 1
enabledboolean

User is enabled

Default true
userRolesArray of integersrequired
Example: [1]
Response
application/json
{
  "id": 1,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "annon@annon.com",
  "telephoneNumber": "string",
  "mobileNumber": "string",
  "contractOwnerId": 1,
  "enabled": true,
  "userRoles": [
    1
  ]
}

user-roles

Permission groups that can be assigned to users

Operations

app-clients

An identification used by a service that access Elevate APIs programmatically

Operations