Generate access token

Get an access token to authenticate API requests. If you’re unfamiliar with the authentication process, check out the authentication guide for more details.

POST /as/token.oauth2

Generate access token

cURL

curl --request POST \
  --url https://api.auth.gbgplc.com/as/token.oauth2 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'client_id=<string>' \
  --data 'client_secret=<string>' \
  --data 'username=<string>' \
  --data 'password=<string>' \
  --data grant_type=password

import requests

url = "https://api.auth.gbgplc.com/as/token.oauth2"

payload = {
    "client_id": "<string>",
    "client_secret": "<string>",
    "username": "<string>",
    "password": "<string>",
    "grant_type": "password"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({
    client_id: '<string>',
    client_secret: '<string>',
    username: '<string>',
    password: '<string>',
    grant_type: 'password'
  })
};

fetch('https://api.auth.gbgplc.com/as/token.oauth2', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.auth.gbgplc.com/as/token.oauth2",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "client_id=%3Cstring%3E&client_secret=%3Cstring%3E&username=%3Cstring%3E&password=%3Cstring%3E&grant_type=password",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.auth.gbgplc.com/as/token.oauth2"

	payload := strings.NewReader("client_id=%3Cstring%3E&client_secret=%3Cstring%3E&username=%3Cstring%3E&password=%3Cstring%3E&grant_type=password")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.auth.gbgplc.com/as/token.oauth2")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("client_id=%3Cstring%3E&client_secret=%3Cstring%3E&username=%3Cstring%3E&password=%3Cstring%3E&grant_type=password")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.auth.gbgplc.com/as/token.oauth2")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "client_id=%3Cstring%3E&client_secret=%3Cstring%3E&username=%3Cstring%3E&password=%3Cstring%3E&grant_type=password"

response = http.request(request)
puts response.read_body

200

{
  "access_token": "<string>",
  "expires_in": 123,
  "token_type": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/x-www-form-urlencoded

client_id · string · required

The client ID assigned to your organization.

client_secret · string · required

The client secret assigned to your organization.

username · string · required

The username for API authentication.

password · string · required

The password for API authentication.

grant_type · enum<string> · required

Must always be set to 'password'.

Available options: password

Response

200

application/json

Successfully retrieved access token.

access_token · string

The access token used for authentication.

expires_in · integer

Token expiration time in seconds.

token_type · string

The type of token, usually 'Bearer'.