Update an OAuth2.0 Identity Provider

curl --request PUT \
  --url http://localhost:3001/portal-api/oauth-providers/{provider_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Name": "My Keycloak instance",
  "Type": "Keycloak",
  "WellKnownURL": "http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect",
  "SSLInsecureSkipVerify": false,
  "ScopeClaimName": "scope",
  "RegistrationAccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc"
}
'

import requests

url = "http://localhost:3001/portal-api/oauth-providers/{provider_id}"

payload = {
    "Name": "My Keycloak instance",
    "Type": "Keycloak",
    "WellKnownURL": "http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect",
    "SSLInsecureSkipVerify": False,
    "ScopeClaimName": "scope",
    "RegistrationAccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Name: 'My Keycloak instance',
    Type: 'Keycloak',
    WellKnownURL: 'http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect',
    SSLInsecureSkipVerify: false,
    ScopeClaimName: 'scope',
    RegistrationAccessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc'
  })
};

fetch('http://localhost:3001/portal-api/oauth-providers/{provider_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3001",
  CURLOPT_URL => "http://localhost:3001/portal-api/oauth-providers/{provider_id}",
  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([
    'Name' => 'My Keycloak instance',
    'Type' => 'Keycloak',
    'WellKnownURL' => 'http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect',
    'SSLInsecureSkipVerify' => false,
    'ScopeClaimName' => 'scope',
    'RegistrationAccessToken' => 'eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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 := "http://localhost:3001/portal-api/oauth-providers/{provider_id}"

	payload := strings.NewReader("{\n  \"Name\": \"My Keycloak instance\",\n  \"Type\": \"Keycloak\",\n  \"WellKnownURL\": \"http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect\",\n  \"SSLInsecureSkipVerify\": false,\n  \"ScopeClaimName\": \"scope\",\n  \"RegistrationAccessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc\"\n}")

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

	req.Header.Add("Authorization", "<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.put("http://localhost:3001/portal-api/oauth-providers/{provider_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Name\": \"My Keycloak instance\",\n  \"Type\": \"Keycloak\",\n  \"WellKnownURL\": \"http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect\",\n  \"SSLInsecureSkipVerify\": false,\n  \"ScopeClaimName\": \"scope\",\n  \"RegistrationAccessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3001/portal-api/oauth-providers/{provider_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Name\": \"My Keycloak instance\",\n  \"Type\": \"Keycloak\",\n  \"WellKnownURL\": \"http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect\",\n  \"SSLInsecureSkipVerify\": false,\n  \"ScopeClaimName\": \"scope\",\n  \"RegistrationAccessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc\"\n}"

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

{
  "Name": "My Keycloak instance",
  "Type": "Keycloak",
  "WellKnownURL": "http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect",
  "ClientTypes": [
    {
      "Name": "Server-side application",
      "ResponseTypes": "code,token",
      "GrantType": "authorization_code,refresh_token,password",
      "Description": "Use this client configuration to create server-side applications that don't act on behalf of end-users",
      "TokenEndpointAuthMethod": "client_secret_basic",
      "OktaAppType": "web",
      "ID": 1,
      "CreatedAt": "2023-06-25 13:37",
      "UpdatedAt": "2023-06-25 13:37"
    }
  ],
  "SSLInsecureSkipVerify": false,
  "ScopeClaimName": "scope",
  "ID": 1,
  "CreatedAt": "2023-06-25 13:37",
  "UpdatedAt": "2023-06-25 13:37",
  "IsDuplicate": false,
  "DuplicateOfID": 0
}

{
  "errors": [
    "<string>"
  ]
}

{
  "errors": [
    "<string>"
  ]
}

PUT

oauth-providers

{provider_id}

Update an OAuth2.0 Identity Provider

curl --request PUT \
  --url http://localhost:3001/portal-api/oauth-providers/{provider_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Name": "My Keycloak instance",
  "Type": "Keycloak",
  "WellKnownURL": "http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect",
  "SSLInsecureSkipVerify": false,
  "ScopeClaimName": "scope",
  "RegistrationAccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc"
}
'

import requests

url = "http://localhost:3001/portal-api/oauth-providers/{provider_id}"

payload = {
    "Name": "My Keycloak instance",
    "Type": "Keycloak",
    "WellKnownURL": "http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect",
    "SSLInsecureSkipVerify": False,
    "ScopeClaimName": "scope",
    "RegistrationAccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Name: 'My Keycloak instance',
    Type: 'Keycloak',
    WellKnownURL: 'http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect',
    SSLInsecureSkipVerify: false,
    ScopeClaimName: 'scope',
    RegistrationAccessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc'
  })
};

fetch('http://localhost:3001/portal-api/oauth-providers/{provider_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3001",
  CURLOPT_URL => "http://localhost:3001/portal-api/oauth-providers/{provider_id}",
  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([
    'Name' => 'My Keycloak instance',
    'Type' => 'Keycloak',
    'WellKnownURL' => 'http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect',
    'SSLInsecureSkipVerify' => false,
    'ScopeClaimName' => 'scope',
    'RegistrationAccessToken' => 'eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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 := "http://localhost:3001/portal-api/oauth-providers/{provider_id}"

	payload := strings.NewReader("{\n  \"Name\": \"My Keycloak instance\",\n  \"Type\": \"Keycloak\",\n  \"WellKnownURL\": \"http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect\",\n  \"SSLInsecureSkipVerify\": false,\n  \"ScopeClaimName\": \"scope\",\n  \"RegistrationAccessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc\"\n}")

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

	req.Header.Add("Authorization", "<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.put("http://localhost:3001/portal-api/oauth-providers/{provider_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Name\": \"My Keycloak instance\",\n  \"Type\": \"Keycloak\",\n  \"WellKnownURL\": \"http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect\",\n  \"SSLInsecureSkipVerify\": false,\n  \"ScopeClaimName\": \"scope\",\n  \"RegistrationAccessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3001/portal-api/oauth-providers/{provider_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Name\": \"My Keycloak instance\",\n  \"Type\": \"Keycloak\",\n  \"WellKnownURL\": \"http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect\",\n  \"SSLInsecureSkipVerify\": false,\n  \"ScopeClaimName\": \"scope\",\n  \"RegistrationAccessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc\"\n}"

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

{
  "Name": "My Keycloak instance",
  "Type": "Keycloak",
  "WellKnownURL": "http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect",
  "ClientTypes": [
    {
      "Name": "Server-side application",
      "ResponseTypes": "code,token",
      "GrantType": "authorization_code,refresh_token,password",
      "Description": "Use this client configuration to create server-side applications that don't act on behalf of end-users",
      "TokenEndpointAuthMethod": "client_secret_basic",
      "OktaAppType": "web",
      "ID": 1,
      "CreatedAt": "2023-06-25 13:37",
      "UpdatedAt": "2023-06-25 13:37"
    }
  ],
  "SSLInsecureSkipVerify": false,
  "ScopeClaimName": "scope",
  "ID": 1,
  "CreatedAt": "2023-06-25 13:37",
  "UpdatedAt": "2023-06-25 13:37",
  "IsDuplicate": false,
  "DuplicateOfID": 0
}

{
  "errors": [
    "<string>"
  ]
}

{
  "errors": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

provider_id

integer

required

UID of this OAuth2.0 provider

Example:

1

Body

application/json

Name

string

required

Name of this Identity Provider

Example:

"My Keycloak instance"

Type

enum<string>

required

Type of the identity provider. At the moment we support Keycloak, Gluu, and Okta. If your provider is not in the list but it is compliant with the Dynamic Client Registration protocol, select Other.

Available options:

Keycloak,

Gluu,

Okta,

Other

Examples:

"Keycloak"

"Gluu"

"Okta"

"Other"

WellKnownURL

string

required

The well-known endpoint provides metadata about the OpenID Connect Identity Provider, facilitating dynamic client registration by allowing clients to discover configuration details such as registration endpoints automatically. Check documentation of your Identity provider for more information.

Example:

"http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect"

SSLInsecureSkipVerify

boolean

If enabled, the portal will ignore failed SSL checks when connecting to the Identity provider

Example:

false

ScopeClaimName

string

The JWT claim that holds the granted scopes (e.g. "scope" or "scp"). Leave empty to default to "scope".

Examples:

"scope"

"scp"

RegistrationAccessToken

string

This token is used solely for registering a specific instance of the application.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc"

Response

Name

string

required

Name of this Identity Provider

Example:

"My Keycloak instance"

Type

enum<string>

required

Available options:

Keycloak,

Gluu,

Okta,

Other

Examples:

"Keycloak"

"Gluu"

"Okta"

"Other"

WellKnownURL

string

required

Example:

"http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect"

ClientTypes

object[]

required

OAuth2.0 client types associated with this Identity Provider

Show child attributes

SSLInsecureSkipVerify

boolean

If enabled, the portal will ignore failed SSL checks when connecting to the Identity provider

Example:

false

ScopeClaimName

string

The JWT claim that holds the granted scopes (e.g. "scope" or "scp"). Leave empty to default to "scope".

Examples:

"scope"

"scp"

integer

UID of this Identity Provider

Example:

1

CreatedAt

string

Timestamp of when this Identity provider was created

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$

Example:

"2023-06-25 13:37"

UpdatedAt

string

Timestamp of when this Identity provider was created

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$

Example:

"2023-06-25 13:37"

IsDuplicate

boolean

read-only

True when this provider targets the same Identity Provider as another existing provider. Duplicate providers are rejected at client approval time.

Example:

false

DuplicateOfID

integer

read-only

When IsDuplicate is true, the ID of the OAuth 2.0 Provider that this one duplicates. Zero when not a duplicate.

Example:

0

⌘I

Overview

Getting Started

Installation

Publishing APIs

Consuming APIs

User Management

Portal Administration

Reference

How-To Guides

Troubleshooting

Legacy Products

Update an OAuth2.0 Identity Provider

Authorizations

Path Parameters

Body

Response