cURL
curl --request PUT \
--url https://api.example.com/v1/panel/settings/customer-oidc \
--header 'Content-Type: application/json' \
--header 'X-CSRF-Token: <x-csrf-token>' \
--data '
{
"slug": "<string>",
"displayName": "<string>",
"issuer": "<string>",
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": [
"<string>"
],
"enabled": false,
"icon": "<string>",
"sortOrder": 0,
"requireVerifiedEmail": true,
"allowAutoProvision": true
}
'import requests
url = "https://api.example.com/v1/panel/settings/customer-oidc"
payload = {
"slug": "<string>",
"displayName": "<string>",
"issuer": "<string>",
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": ["<string>"],
"enabled": False,
"icon": "<string>",
"sortOrder": 0,
"requireVerifiedEmail": True,
"allowAutoProvision": True
}
headers = {
"X-CSRF-Token": "<x-csrf-token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-CSRF-Token': '<x-csrf-token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: '<string>',
displayName: '<string>',
issuer: '<string>',
discoveryUrl: '<string>',
clientId: '<string>',
clientSecret: '<string>',
scopes: ['<string>'],
enabled: false,
icon: '<string>',
sortOrder: 0,
requireVerifiedEmail: true,
allowAutoProvision: true
})
};
fetch('https://api.example.com/v1/panel/settings/customer-oidc', 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.example.com/v1/panel/settings/customer-oidc",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'slug' => '<string>',
'displayName' => '<string>',
'issuer' => '<string>',
'discoveryUrl' => '<string>',
'clientId' => '<string>',
'clientSecret' => '<string>',
'scopes' => [
'<string>'
],
'enabled' => false,
'icon' => '<string>',
'sortOrder' => 0,
'requireVerifiedEmail' => true,
'allowAutoProvision' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CSRF-Token: <x-csrf-token>"
],
]);
$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.example.com/v1/panel/settings/customer-oidc"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"displayName\": \"<string>\",\n \"issuer\": \"<string>\",\n \"discoveryUrl\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"enabled\": false,\n \"icon\": \"<string>\",\n \"sortOrder\": 0,\n \"requireVerifiedEmail\": true,\n \"allowAutoProvision\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-CSRF-Token", "<x-csrf-token>")
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.put("https://api.example.com/v1/panel/settings/customer-oidc")
.header("X-CSRF-Token", "<x-csrf-token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"displayName\": \"<string>\",\n \"issuer\": \"<string>\",\n \"discoveryUrl\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"enabled\": false,\n \"icon\": \"<string>\",\n \"sortOrder\": 0,\n \"requireVerifiedEmail\": true,\n \"allowAutoProvision\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/panel/settings/customer-oidc")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"<string>\",\n \"displayName\": \"<string>\",\n \"issuer\": \"<string>\",\n \"discoveryUrl\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"enabled\": false,\n \"icon\": \"<string>\",\n \"sortOrder\": 0,\n \"requireVerifiedEmail\": true,\n \"allowAutoProvision\": true\n}"
response = http.request(request)
puts response.read_body{
"slug": "<string>",
"displayName": "<string>",
"issuer": "<string>",
"discoveryUrl": "<string>",
"clientId": "<string>",
"scopes": [
"<string>"
],
"enabled": true,
"requireVerifiedEmail": true,
"allowAutoProvision": true,
"hasClientSecret": true,
"icon": "<string>",
"sortOrder": 123
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}panel
Put v1panelsettingscustomer oidc
Requires settings.write. Creating or updating a provider. Disabling one also ends the sessions it established, because a provider that is off while its access remains open is not off.
PUT
/
v1
/
panel
/
settings
/
customer-oidc
cURL
curl --request PUT \
--url https://api.example.com/v1/panel/settings/customer-oidc \
--header 'Content-Type: application/json' \
--header 'X-CSRF-Token: <x-csrf-token>' \
--data '
{
"slug": "<string>",
"displayName": "<string>",
"issuer": "<string>",
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": [
"<string>"
],
"enabled": false,
"icon": "<string>",
"sortOrder": 0,
"requireVerifiedEmail": true,
"allowAutoProvision": true
}
'import requests
url = "https://api.example.com/v1/panel/settings/customer-oidc"
payload = {
"slug": "<string>",
"displayName": "<string>",
"issuer": "<string>",
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": ["<string>"],
"enabled": False,
"icon": "<string>",
"sortOrder": 0,
"requireVerifiedEmail": True,
"allowAutoProvision": True
}
headers = {
"X-CSRF-Token": "<x-csrf-token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-CSRF-Token': '<x-csrf-token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: '<string>',
displayName: '<string>',
issuer: '<string>',
discoveryUrl: '<string>',
clientId: '<string>',
clientSecret: '<string>',
scopes: ['<string>'],
enabled: false,
icon: '<string>',
sortOrder: 0,
requireVerifiedEmail: true,
allowAutoProvision: true
})
};
fetch('https://api.example.com/v1/panel/settings/customer-oidc', 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.example.com/v1/panel/settings/customer-oidc",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'slug' => '<string>',
'displayName' => '<string>',
'issuer' => '<string>',
'discoveryUrl' => '<string>',
'clientId' => '<string>',
'clientSecret' => '<string>',
'scopes' => [
'<string>'
],
'enabled' => false,
'icon' => '<string>',
'sortOrder' => 0,
'requireVerifiedEmail' => true,
'allowAutoProvision' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CSRF-Token: <x-csrf-token>"
],
]);
$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.example.com/v1/panel/settings/customer-oidc"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"displayName\": \"<string>\",\n \"issuer\": \"<string>\",\n \"discoveryUrl\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"enabled\": false,\n \"icon\": \"<string>\",\n \"sortOrder\": 0,\n \"requireVerifiedEmail\": true,\n \"allowAutoProvision\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-CSRF-Token", "<x-csrf-token>")
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.put("https://api.example.com/v1/panel/settings/customer-oidc")
.header("X-CSRF-Token", "<x-csrf-token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"displayName\": \"<string>\",\n \"issuer\": \"<string>\",\n \"discoveryUrl\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"enabled\": false,\n \"icon\": \"<string>\",\n \"sortOrder\": 0,\n \"requireVerifiedEmail\": true,\n \"allowAutoProvision\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/panel/settings/customer-oidc")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"<string>\",\n \"displayName\": \"<string>\",\n \"issuer\": \"<string>\",\n \"discoveryUrl\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"enabled\": false,\n \"icon\": \"<string>\",\n \"sortOrder\": 0,\n \"requireVerifiedEmail\": true,\n \"allowAutoProvision\": true\n}"
response = http.request(request)
puts response.read_body{
"slug": "<string>",
"displayName": "<string>",
"issuer": "<string>",
"discoveryUrl": "<string>",
"clientId": "<string>",
"scopes": [
"<string>"
],
"enabled": true,
"requireVerifiedEmail": true,
"allowAutoProvision": true,
"hasClientSecret": true,
"icon": "<string>",
"sortOrder": 123
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}Headers
Echoes the token from the current session. Required on every unsafe method.
Body
application/json
Pattern:
^[a-z0-9][a-z0-9-]{0,38}[a-z0-9]$Required string length:
1 - 80Write-only. Omit to keep the stored secret; it is never returned.
Response
Saved
Whether a subject matching no existing customer may create one. It never adopts an existing customer by email address.
Name of a shipped icon, never a third-party URL.