Skip to content

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

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

Get a list of App Clients

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
namestring(StringFilterParam)

Filter by name

Example: name=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/app-clients?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-onlyrequired

User identifier

Example: 1
contractOwnerIdintegerread-only

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
namestringrequired
descriptionstring
appClientIdstringread-onlyrequired
lastSuccessfulAuthenticationstring(date-time)read-only
lastFailedAuthenticationstring(date-time)read-only
userRolesArray of integersrequired
Example: [1]
]
Response
application/json
[
  {
    "id": 1,
    "contractOwnerId": 1,
    "name": "string",
    "description": "string",
    "appClientId": "string",
    "lastSuccessfulAuthentication": "2019-08-24T14:15:22Z",
    "lastFailedAuthentication": "2019-08-24T14:15:22Z",
    "userRoles": [ … ]
  }
]

Create an App Client

Request

Bodyapplication/jsonrequired

request

namestringrequired
descriptionstring
userRolesArray of integers
Example: [1]
curl -i -X POST \
  https://rest.elevatebilling.com/v1/app-clients \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "userRoles": [
      1
    ]
  }'

Responses

Created

Bodyapplication/json
idinteger(int64)read-onlyrequired

User identifier

Example: 1
contractOwnerIdintegerread-only

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
namestringrequired
descriptionstring
appClientIdstringread-onlyrequired
lastSuccessfulAuthenticationstring(date-time)read-only
lastFailedAuthenticationstring(date-time)read-only
userRolesArray of integersrequired
Example: [1]
clientSecretstring
Response
application/json
{
  "id": 1,
  "contractOwnerId": 1,
  "name": "string",
  "description": "string",
  "appClientId": "string",
  "lastSuccessfulAuthentication": "2019-08-24T14:15:22Z",
  "lastFailedAuthentication": "2019-08-24T14:15:22Z",
  "userRoles": [
    1
  ],
  "clientSecret": "string"
}

Get App Client by ID

Request

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

App Client ID

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

Responses

OK

Bodyapplication/json
idinteger(int64)read-onlyrequired

User identifier

Example: 1
contractOwnerIdintegerread-only

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
namestringrequired
descriptionstring
appClientIdstringread-onlyrequired
lastSuccessfulAuthenticationstring(date-time)read-only
lastFailedAuthenticationstring(date-time)read-only
userRolesArray of integersrequired
Example: [1]
Response
application/json
{
  "id": 1,
  "contractOwnerId": 1,
  "name": "string",
  "description": "string",
  "appClientId": "string",
  "lastSuccessfulAuthentication": "2019-08-24T14:15:22Z",
  "lastFailedAuthentication": "2019-08-24T14:15:22Z",
  "userRoles": [
    1
  ]
}

Update App Client

Request

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

App Client ID

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/app-clients/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/name",
      "value": "application name"
    }
  ]'

Responses

Success

Bodyapplication/json
idinteger(int64)read-onlyrequired

User identifier

Example: 1
contractOwnerIdintegerread-only

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
namestringrequired
descriptionstring
appClientIdstringread-onlyrequired
lastSuccessfulAuthenticationstring(date-time)read-only
lastFailedAuthenticationstring(date-time)read-only
userRolesArray of integersrequired
Example: [1]
Response
application/json
{
  "id": 1,
  "contractOwnerId": 1,
  "name": "string",
  "description": "string",
  "appClientId": "string",
  "lastSuccessfulAuthentication": "2019-08-24T14:15:22Z",
  "lastFailedAuthentication": "2019-08-24T14:15:22Z",
  "userRoles": [
    1
  ]
}

Delete App Client

Request

Path
idinteger(int64)(IdParam)>= 1required

App Client ID

Example: 1
curl -i -X DELETE \
  https://rest.elevatebilling.com/v1/app-clients/1

Responses

Success

Body