Skip to content

Elevate Authentication & Users API (1.9)

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

Create bearer token

Request

Bodyapplication/jsonrequired

request

brandstringrequired

This is the prefix of your Elevate IQ billing portal URL. For example, if you access Elevate via mycompany.elevatebilling.com, your brand is mycompany. If you're unsure, please contact the support team

usernamestring[ 1 .. 100 ] charactersrequired

If you're using basic authentication, this is the username you use to access the Elevate billing system. However, we encourage using app clients for API access instead. You can create an app client in Elevate via the top-right context menu, under Manage App Client. In that case, the username is the app client ID

passwordstring[ 1 .. 100 ] charactersrequired

If you're using basic authentication, this is the password you use to access the Elevate billing system. However, if you're using an app client, the password is the client secret

curl -i -X POST \
  https://rest.elevatebilling.com/v1/authenticate \
  -H 'Content-Type: application/json' \
  -d '{
    "brand": "string",
    "username": "string",
    "password": "string"
  }'

Responses

OK

Bodyapplication/json
tokenstring

JWT Bearer token to use in subsequent requests

usernamestring[ 1 .. 100 ] characters

API user name

Response
application/json
{
  "token": "string",
  "username": "string"
}

users

An identification used by a person with access to Elevate

Operations

user-roles

Permission groups that can be assigned to users

Operations

vmbUsers

An identification used by a person with access to Elevate end customer portal, View My Bill

Operations

app-clients

An identification used by a service that access Elevate APIs programmatically

Operations

identity-providers

Federated identity providers configured for a billing client

Operations