Skip to main content
POST
/
oauth-providers
Create an OAuth provider
curl --request POST \
  --url https://api.hexclave.com/api/v1/oauth-providers \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "3241a285-8329-4d69-8f3d-316e08cf140c",
  "email": "test@gmail.com",
  "allow_sign_in": true,
  "allow_connected_accounts": true,
  "account_id": "google-account-id-12345"
}
'
import requests

url = "https://api.hexclave.com/api/v1/oauth-providers"

payload = {
"user_id": "3241a285-8329-4d69-8f3d-316e08cf140c",
"email": "test@gmail.com",
"allow_sign_in": True,
"allow_connected_accounts": True,
"account_id": "google-account-id-12345"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
user_id: '3241a285-8329-4d69-8f3d-316e08cf140c',
email: 'test@gmail.com',
allow_sign_in: true,
allow_connected_accounts: true,
account_id: 'google-account-id-12345'
})
};

fetch('https://api.hexclave.com/api/v1/oauth-providers', 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.hexclave.com/api/v1/oauth-providers",
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([
'user_id' => '3241a285-8329-4d69-8f3d-316e08cf140c',
'email' => 'test@gmail.com',
'allow_sign_in' => true,
'allow_connected_accounts' => true,
'account_id' => 'google-account-id-12345'
]),
CURLOPT_HTTPHEADER => [
"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://api.hexclave.com/api/v1/oauth-providers"

payload := strings.NewReader("{\n \"user_id\": \"3241a285-8329-4d69-8f3d-316e08cf140c\",\n \"email\": \"test@gmail.com\",\n \"allow_sign_in\": true,\n \"allow_connected_accounts\": true,\n \"account_id\": \"google-account-id-12345\"\n}")

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

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://api.hexclave.com/api/v1/oauth-providers")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"3241a285-8329-4d69-8f3d-316e08cf140c\",\n \"email\": \"test@gmail.com\",\n \"allow_sign_in\": true,\n \"allow_connected_accounts\": true,\n \"account_id\": \"google-account-id-12345\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.hexclave.com/api/v1/oauth-providers")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"3241a285-8329-4d69-8f3d-316e08cf140c\",\n \"email\": \"test@gmail.com\",\n \"allow_sign_in\": true,\n \"allow_connected_accounts\": true,\n \"account_id\": \"google-account-id-12345\"\n}"

response = http.request(request)
puts response.read_body
{
  "account_id": "google-account-id-12345",
  "user_id": "3241a285-8329-4d69-8f3d-316e08cf140c",
  "id": "b3d396b8-c574-4c80-97b3-50031675ceb2",
  "provider_config_id": "google",
  "type": "google",
  "allow_sign_in": true,
  "allow_connected_accounts": true,
  "email": "test@gmail.com"
}

Body

application/json
user_id
string
required

The ID of the user, or the special value me for the currently authenticated user

Example:

"3241a285-8329-4d69-8f3d-316e08cf140c"

provider_config_id
string
required
allow_sign_in
boolean
required

Whether the user can use this OAuth provider to sign in. Only one OAuth provider per type can have this set to true.

Example:

true

allow_connected_accounts
boolean
required

Whether the user can use this OAuth provider as connected account. Multiple OAuth providers per type can have this set to true.

Example:

true

account_id
string
required

Account ID of the OAuth provider. This uniquely identifies the account on the provider side.

Example:

"google-account-id-12345"

email
string

Email of the OAuth provider. This is used to display and identify the OAuth provider in the UI.

Example:

"test@gmail.com"

Response

201 - application/json

Successful response

account_id
string
required

Account ID of the OAuth provider. This uniquely identifies the account on the provider side.

Example:

"google-account-id-12345"

user_id
string
required

The ID of the user, or the special value me for the currently authenticated user

Example:

"3241a285-8329-4d69-8f3d-316e08cf140c"

id
string
required

The unique identifier of the OAuth provider

Example:

"b3d396b8-c574-4c80-97b3-50031675ceb2"

provider_config_id
string
required

Provider config ID of the OAuth provider. This uniquely identifies the provider config on config.json file

Example:

"google"

type
enum<string>
required

OAuth provider type, one of google, github, microsoft, spotify, facebook, discord, gitlab, bitbucket, linkedin, apple, x, twitch

Available options:
google,
github,
microsoft,
spotify,
facebook,
discord,
gitlab,
bitbucket,
linkedin,
apple,
x,
twitch
Example:

"google"

allow_sign_in
boolean
required

Whether the user can use this OAuth provider to sign in. Only one OAuth provider per type can have this set to true.

Example:

true

allow_connected_accounts
boolean
required

Whether the user can use this OAuth provider as connected account. Multiple OAuth providers per type can have this set to true.

Example:

true

email
string

Email of the OAuth provider. This is used to display and identify the OAuth provider in the UI.

Example:

"test@gmail.com"