Update auth configuration
curl --request PATCH \
--url https://{subdomain}.nudj.cx/api/v2/admin/auth-config \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"enabledProviders": [],
"oidcProviders": [
{
"id": "<string>",
"name": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"issuer": "<string>",
"userinfo_endpoint": "<string>",
"customUserInfoEndpoint": "<string>",
"scopes": [
"<string>"
]
}
],
"email": {
"host": "<string>",
"port": 32768,
"username": "<string>",
"password": "<string>",
"fromAddress": "jsmith@example.com"
}
}
'import requests
url = "https://{subdomain}.nudj.cx/api/v2/admin/auth-config"
payload = {
"enabledProviders": [],
"oidcProviders": [
{
"id": "<string>",
"name": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"issuer": "<string>",
"userinfo_endpoint": "<string>",
"customUserInfoEndpoint": "<string>",
"scopes": ["<string>"]
}
],
"email": {
"host": "<string>",
"port": 32768,
"username": "<string>",
"password": "<string>",
"fromAddress": "jsmith@example.com"
}
}
headers = {
"x-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabledProviders: [],
oidcProviders: [
{
id: '<string>',
name: '<string>',
clientId: '<string>',
clientSecret: '<string>',
issuer: '<string>',
userinfo_endpoint: '<string>',
customUserInfoEndpoint: '<string>',
scopes: ['<string>']
}
],
email: {
host: '<string>',
port: 32768,
username: '<string>',
password: '<string>',
fromAddress: 'jsmith@example.com'
}
})
};
fetch('https://{subdomain}.nudj.cx/api/v2/admin/auth-config', 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://{subdomain}.nudj.cx/api/v2/admin/auth-config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'enabledProviders' => [
],
'oidcProviders' => [
[
'id' => '<string>',
'name' => '<string>',
'clientId' => '<string>',
'clientSecret' => '<string>',
'issuer' => '<string>',
'userinfo_endpoint' => '<string>',
'customUserInfoEndpoint' => '<string>',
'scopes' => [
'<string>'
]
]
],
'email' => [
'host' => '<string>',
'port' => 32768,
'username' => '<string>',
'password' => '<string>',
'fromAddress' => 'jsmith@example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-token: <api-key>"
],
]);
$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://{subdomain}.nudj.cx/api/v2/admin/auth-config"
payload := strings.NewReader("{\n \"enabledProviders\": [],\n \"oidcProviders\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"issuer\": \"<string>\",\n \"userinfo_endpoint\": \"<string>\",\n \"customUserInfoEndpoint\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n }\n ],\n \"email\": {\n \"host\": \"<string>\",\n \"port\": 32768,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"fromAddress\": \"jsmith@example.com\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-token", "<api-key>")
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.patch("https://{subdomain}.nudj.cx/api/v2/admin/auth-config")
.header("x-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabledProviders\": [],\n \"oidcProviders\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"issuer\": \"<string>\",\n \"userinfo_endpoint\": \"<string>\",\n \"customUserInfoEndpoint\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n }\n ],\n \"email\": {\n \"host\": \"<string>\",\n \"port\": 32768,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"fromAddress\": \"jsmith@example.com\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.nudj.cx/api/v2/admin/auth-config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabledProviders\": [],\n \"oidcProviders\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"issuer\": \"<string>\",\n \"userinfo_endpoint\": \"<string>\",\n \"customUserInfoEndpoint\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n }\n ],\n \"email\": {\n \"host\": \"<string>\",\n \"port\": 32768,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"fromAddress\": \"jsmith@example.com\"\n }\n}"
response = http.request(request)
puts response.read_body{
"enabledProviders": [
"42-school"
],
"oidcProviders": [
{
"id": "<string>",
"name": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"issuer": "<string>",
"userinfo_endpoint": "<string>",
"customUserInfoEndpoint": "<string>",
"scopes": [
"<string>"
]
}
],
"email": {
"host": "<string>",
"port": 32768,
"username": "<string>",
"fromAddress": "jsmith@example.com"
}
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Auth Config
Update auth configuration
Update the authentication configuration settings.
PATCH
/
auth-config
Update auth configuration
curl --request PATCH \
--url https://{subdomain}.nudj.cx/api/v2/admin/auth-config \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"enabledProviders": [],
"oidcProviders": [
{
"id": "<string>",
"name": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"issuer": "<string>",
"userinfo_endpoint": "<string>",
"customUserInfoEndpoint": "<string>",
"scopes": [
"<string>"
]
}
],
"email": {
"host": "<string>",
"port": 32768,
"username": "<string>",
"password": "<string>",
"fromAddress": "jsmith@example.com"
}
}
'import requests
url = "https://{subdomain}.nudj.cx/api/v2/admin/auth-config"
payload = {
"enabledProviders": [],
"oidcProviders": [
{
"id": "<string>",
"name": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"issuer": "<string>",
"userinfo_endpoint": "<string>",
"customUserInfoEndpoint": "<string>",
"scopes": ["<string>"]
}
],
"email": {
"host": "<string>",
"port": 32768,
"username": "<string>",
"password": "<string>",
"fromAddress": "jsmith@example.com"
}
}
headers = {
"x-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabledProviders: [],
oidcProviders: [
{
id: '<string>',
name: '<string>',
clientId: '<string>',
clientSecret: '<string>',
issuer: '<string>',
userinfo_endpoint: '<string>',
customUserInfoEndpoint: '<string>',
scopes: ['<string>']
}
],
email: {
host: '<string>',
port: 32768,
username: '<string>',
password: '<string>',
fromAddress: 'jsmith@example.com'
}
})
};
fetch('https://{subdomain}.nudj.cx/api/v2/admin/auth-config', 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://{subdomain}.nudj.cx/api/v2/admin/auth-config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'enabledProviders' => [
],
'oidcProviders' => [
[
'id' => '<string>',
'name' => '<string>',
'clientId' => '<string>',
'clientSecret' => '<string>',
'issuer' => '<string>',
'userinfo_endpoint' => '<string>',
'customUserInfoEndpoint' => '<string>',
'scopes' => [
'<string>'
]
]
],
'email' => [
'host' => '<string>',
'port' => 32768,
'username' => '<string>',
'password' => '<string>',
'fromAddress' => 'jsmith@example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-token: <api-key>"
],
]);
$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://{subdomain}.nudj.cx/api/v2/admin/auth-config"
payload := strings.NewReader("{\n \"enabledProviders\": [],\n \"oidcProviders\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"issuer\": \"<string>\",\n \"userinfo_endpoint\": \"<string>\",\n \"customUserInfoEndpoint\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n }\n ],\n \"email\": {\n \"host\": \"<string>\",\n \"port\": 32768,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"fromAddress\": \"jsmith@example.com\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-token", "<api-key>")
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.patch("https://{subdomain}.nudj.cx/api/v2/admin/auth-config")
.header("x-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabledProviders\": [],\n \"oidcProviders\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"issuer\": \"<string>\",\n \"userinfo_endpoint\": \"<string>\",\n \"customUserInfoEndpoint\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n }\n ],\n \"email\": {\n \"host\": \"<string>\",\n \"port\": 32768,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"fromAddress\": \"jsmith@example.com\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.nudj.cx/api/v2/admin/auth-config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabledProviders\": [],\n \"oidcProviders\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"issuer\": \"<string>\",\n \"userinfo_endpoint\": \"<string>\",\n \"customUserInfoEndpoint\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n }\n ],\n \"email\": {\n \"host\": \"<string>\",\n \"port\": 32768,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"fromAddress\": \"jsmith@example.com\"\n }\n}"
response = http.request(request)
puts response.read_body{
"enabledProviders": [
"42-school"
],
"oidcProviders": [
{
"id": "<string>",
"name": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"issuer": "<string>",
"userinfo_endpoint": "<string>",
"customUserInfoEndpoint": "<string>",
"scopes": [
"<string>"
]
}
],
"email": {
"host": "<string>",
"port": 32768,
"username": "<string>",
"fromAddress": "jsmith@example.com"
}
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Authorizations
Body
application/json
Input for updating authentication configuration settings
List of enabled authentication providers
Available options:
42-school, api-auth-link, api-token-link, apple, asgardeo, atlassian, auth0, authentik, azure-ad-b2c, azure-ad, azure-devops, battlenet, beyondidentity, box, boxyhq-saml, bungie, click-up, cognito, coinbase, descope, discord, dribbble, dropbox, duende-identity-server6, email, eveonline, facebook, faceit, foursquare, freshbooks, fusionauth, github, gitlab, google, hubspot, identity-server4, instagram, kakao, keycloak, line, linkedin, mailchimp, mailru, mastodon, mattermost, medium, naver, netlify, notion, okta, onelogin, organisation-oidc, osso, osu, passage, patreon, pinterest, pipedrive, reddit, salesforce, slack, spotify, strava, tiktok, todoist, trakt, twitch, twitter, united-effects, vk, wikimedia, wordpress, workos, yandex, youtube, zitadel, zoho, zoom OIDC provider configurations
Show child attributes
Show child attributes
Authentication configuration email settings
Show child attributes
Show child attributes
Response
Successful response
List of enabled authentication providers
Available options:
42-school, api-auth-link, api-token-link, apple, asgardeo, atlassian, auth0, authentik, azure-ad-b2c, azure-ad, azure-devops, battlenet, beyondidentity, box, boxyhq-saml, bungie, click-up, cognito, coinbase, descope, discord, dribbble, dropbox, duende-identity-server6, email, eveonline, facebook, faceit, foursquare, freshbooks, fusionauth, github, gitlab, google, hubspot, identity-server4, instagram, kakao, keycloak, line, linkedin, mailchimp, mailru, mastodon, mattermost, medium, naver, netlify, notion, okta, onelogin, organisation-oidc, osso, osu, passage, patreon, pinterest, pipedrive, reddit, salesforce, slack, spotify, strava, tiktok, todoist, trakt, twitch, twitter, united-effects, vk, wikimedia, wordpress, workos, yandex, youtube, zitadel, zoho, zoom OIDC provider configurations
Show child attributes
Show child attributes
Authentication configuration email settings
Show child attributes
Show child attributes
Was this page helpful?

