Authenticate user and obtain access token

curl --request POST \
  --url https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/auth/token \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "grant_type": "password",
  "user_name": "john_doe",
  "password": "P@ssw0rd!"
}
'

import requests

url = "https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/auth/token"

payload = {
    "grant_type": "password",
    "user_name": "john_doe",
    "password": "P@ssw0rd!"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({grant_type: 'password', user_name: 'john_doe', password: 'P@ssw0rd!'})
};

fetch('https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/auth/token', 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://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/auth/token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'grant_type' => 'password',
    'user_name' => 'john_doe',
    'password' => 'P@ssw0rd!'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$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://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/auth/token"

	payload := strings.NewReader("{\n  \"grant_type\": \"password\",\n  \"user_name\": \"john_doe\",\n  \"password\": \"P@ssw0rd!\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/auth/token")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"grant_type\": \"password\",\n  \"user_name\": \"john_doe\",\n  \"password\": \"P@ssw0rd!\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/auth/token")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"grant_type\": \"password\",\n  \"user_name\": \"john_doe\",\n  \"password\": \"P@ssw0rd!\"\n}"

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

{
  "auth_id": "674d0bf5c28b69001f8e03a1",
  "created_at": "2024-04-22T10:00:00Z",
  "updated_at": "2024-04-22T10:00:00Z",
  "access_token": "fa0b97b2-445f-41d2-b50f-fb3b014a301e",
  "expires_at": "2024-04-22T10:00:00Z",
  "refresh_token": "d1a3e281-96b6-4f77-a587-7b6c8c2a96d9",
  "token_type": "Bearer",
  "user_name": "john_doe"
}

{
  "title": "Human-readable error title.",
  "detail": "Human-readable error details."
}

{
  "title": "Human-readable error title.",
  "detail": "Human-readable error details."
}

POST

auth

token

Authenticate user and obtain access token

curl --request POST \
  --url https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/auth/token \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "grant_type": "password",
  "user_name": "john_doe",
  "password": "P@ssw0rd!"
}
'

import requests

url = "https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/auth/token"

payload = {
    "grant_type": "password",
    "user_name": "john_doe",
    "password": "P@ssw0rd!"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({grant_type: 'password', user_name: 'john_doe', password: 'P@ssw0rd!'})
};

fetch('https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/auth/token', 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://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/auth/token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'grant_type' => 'password',
    'user_name' => 'john_doe',
    'password' => 'P@ssw0rd!'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$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://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/auth/token"

	payload := strings.NewReader("{\n  \"grant_type\": \"password\",\n  \"user_name\": \"john_doe\",\n  \"password\": \"P@ssw0rd!\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/auth/token")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"grant_type\": \"password\",\n  \"user_name\": \"john_doe\",\n  \"password\": \"P@ssw0rd!\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/auth/token")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"grant_type\": \"password\",\n  \"user_name\": \"john_doe\",\n  \"password\": \"P@ssw0rd!\"\n}"

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

{
  "auth_id": "674d0bf5c28b69001f8e03a1",
  "created_at": "2024-04-22T10:00:00Z",
  "updated_at": "2024-04-22T10:00:00Z",
  "access_token": "fa0b97b2-445f-41d2-b50f-fb3b014a301e",
  "expires_at": "2024-04-22T10:00:00Z",
  "refresh_token": "d1a3e281-96b6-4f77-a587-7b6c8c2a96d9",
  "token_type": "Bearer",
  "user_name": "john_doe"
}

{
  "title": "Human-readable error title.",
  "detail": "Human-readable error details."
}

{
  "title": "Human-readable error title.",
  "detail": "Human-readable error details."
}

Authorizations

Authorization

string

header

required

The auth type used by all protected endpoints.

Body

application/json

The request body to create a token requires the following properties: grant_type, user_name, and password.

grant_type

string

required

Tells the login endpoint to perform the resource owner password credential flow.

Example:

"password"

user_name

string

required

The user name for account login purposes. User names cannot contain spaces.

Example:

"john_doe"

password

string

required

Passwords must be at least eight characters long and contain at least one uppercase letter, one lowercase letter, one digit, and one special character (@, $, !, %, *, ?, &).

Example:

"P@ssw0rd!"

Response

Resource created successfully. The response body contains the newly created resource.

The response object returned for both /auth endpoints.

auth_id

string

read-only

A unique alpha-numeric string generated by the system when creating a resource (e.g., dishes, ingredients, etc). Ids are required for retrieving the properties of a specific resource.

Example:

"674d0bf5c28b69001f8e03a1"

created_at

string<date-time>

read-only

The date and time the resource was created. Timestamp uses ISO 8601 format, Ex: 2025-04-05T14:55:03.824Z

Example:

"2024-04-22T10:00:00Z"

updated_at

string<date-time>

read-only

The date and time the resource was last updated.

Timestamp uses ISO 8601 format, Ex: 2025-04-05T14:55:03.824Z

Example:

"2024-04-22T10:00:00Z"

access_token

string

An alpha-numeric string generated when authenicating a user and required for protected endpoints.

Expires after ### seconds.

Example:

"fa0b97b2-445f-41d2-b50f-fb3b014a301e"

expires_at

string<date-time>

read-only

Indicates when a token expires and should be refreshed to maintain a user's authentication. Timestamp uses ISO 8601 format, Ex: 2025-04-05T14:55:03.824Z

Example:

"2024-04-22T10:00:00Z"

refresh_token

string

The alpha-numeric refresh token value, used to re-authenticate a user after the authentication token expires.

Example:

"d1a3e281-96b6-4f77-a587-7b6c8c2a96d9"

token_type

string

The type of token used in an /auth request.

Example:

"Bearer"

user_name

string

The user name for account login purposes. User names cannot contain spaces.

Example:

"john_doe"

API Documentation

Endpoints

Authenticate user and obtain access token

Authorizations

Body

Response