Update identity provider

curl --request PUT \
  --url https://api.example.com/api/identity-providers/{alias} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "enabled": true,
  "oidc_config": {
    "authorization_url": "<string>",
    "token_url": "<string>",
    "client_id": "<string>",
    "client_secret": "<string>",
    "user_info_url": "<string>",
    "issuer": "<string>",
    "default_scope": "openid email profile",
    "sync_mode": "INHERIT",
    "validate_signature": true,
    "use_jwks_url": true,
    "pkce_enabled": false,
    "pkce_method": "S256"
  },
  "saml_config": {
    "single_sign_on_service_url": "<string>",
    "single_logout_service_url": "<string>",
    "name_id_policy_format": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
    "signing_certificate": "<string>",
    "want_authn_requests_signed": true,
    "post_binding_authn_request": true,
    "post_binding_response": true,
    "sync_mode": "INHERIT"
  },
  "ldap_config": {
    "connection_url": "<string>",
    "bind_dn": "<string>",
    "bind_credential": "<string>",
    "users_dn": "<string>",
    "users_filter": "<string>",
    "vendor": "ad",
    "username_ldap_attribute": "sAMAccountName",
    "rdn_ldap_attribute": "sAMAccountName",
    "uuid_ldap_attribute": "objectGUID",
    "user_object_classes": "person, organizationalPerson, user",
    "search_scope": "2",
    "edit_mode": "READ_ONLY",
    "use_truststore_spi": "always",
    "connection_timeout": 5000,
    "read_timeout": 10000,
    "pagination": true,
    "batch_size_for_sync": 1000,
    "full_sync_period": 604800,
    "changed_sync_period": 86400,
    "sync_registrations": false,
    "import_enabled": true,
    "trust_email": true
  },
  "mappers": [
    {
      "name": "<string>",
      "identity_provider_mapper": "<string>",
      "id": "<string>",
      "config": {}
    }
  ]
}
'

import requests

url = "https://api.example.com/api/identity-providers/{alias}"

payload = {
    "display_name": "<string>",
    "enabled": True,
    "oidc_config": {
        "authorization_url": "<string>",
        "token_url": "<string>",
        "client_id": "<string>",
        "client_secret": "<string>",
        "user_info_url": "<string>",
        "issuer": "<string>",
        "default_scope": "openid email profile",
        "sync_mode": "INHERIT",
        "validate_signature": True,
        "use_jwks_url": True,
        "pkce_enabled": False,
        "pkce_method": "S256"
    },
    "saml_config": {
        "single_sign_on_service_url": "<string>",
        "single_logout_service_url": "<string>",
        "name_id_policy_format": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
        "signing_certificate": "<string>",
        "want_authn_requests_signed": True,
        "post_binding_authn_request": True,
        "post_binding_response": True,
        "sync_mode": "INHERIT"
    },
    "ldap_config": {
        "connection_url": "<string>",
        "bind_dn": "<string>",
        "bind_credential": "<string>",
        "users_dn": "<string>",
        "users_filter": "<string>",
        "vendor": "ad",
        "username_ldap_attribute": "sAMAccountName",
        "rdn_ldap_attribute": "sAMAccountName",
        "uuid_ldap_attribute": "objectGUID",
        "user_object_classes": "person, organizationalPerson, user",
        "search_scope": "2",
        "edit_mode": "READ_ONLY",
        "use_truststore_spi": "always",
        "connection_timeout": 5000,
        "read_timeout": 10000,
        "pagination": True,
        "batch_size_for_sync": 1000,
        "full_sync_period": 604800,
        "changed_sync_period": 86400,
        "sync_registrations": False,
        "import_enabled": True,
        "trust_email": True
    },
    "mappers": [
        {
            "name": "<string>",
            "identity_provider_mapper": "<string>",
            "id": "<string>",
            "config": {}
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: '<string>',
    enabled: true,
    oidc_config: {
      authorization_url: '<string>',
      token_url: '<string>',
      client_id: '<string>',
      client_secret: '<string>',
      user_info_url: '<string>',
      issuer: '<string>',
      default_scope: 'openid email profile',
      sync_mode: 'INHERIT',
      validate_signature: true,
      use_jwks_url: true,
      pkce_enabled: false,
      pkce_method: 'S256'
    },
    saml_config: {
      single_sign_on_service_url: '<string>',
      single_logout_service_url: '<string>',
      name_id_policy_format: 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent',
      signing_certificate: '<string>',
      want_authn_requests_signed: true,
      post_binding_authn_request: true,
      post_binding_response: true,
      sync_mode: 'INHERIT'
    },
    ldap_config: {
      connection_url: '<string>',
      bind_dn: '<string>',
      bind_credential: '<string>',
      users_dn: '<string>',
      users_filter: '<string>',
      vendor: 'ad',
      username_ldap_attribute: 'sAMAccountName',
      rdn_ldap_attribute: 'sAMAccountName',
      uuid_ldap_attribute: 'objectGUID',
      user_object_classes: 'person, organizationalPerson, user',
      search_scope: '2',
      edit_mode: 'READ_ONLY',
      use_truststore_spi: 'always',
      connection_timeout: 5000,
      read_timeout: 10000,
      pagination: true,
      batch_size_for_sync: 1000,
      full_sync_period: 604800,
      changed_sync_period: 86400,
      sync_registrations: false,
      import_enabled: true,
      trust_email: true
    },
    mappers: [
      {
        name: '<string>',
        identity_provider_mapper: '<string>',
        id: '<string>',
        config: {}
      }
    ]
  })
};

fetch('https://api.example.com/api/identity-providers/{alias}', 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/api/identity-providers/{alias}",
  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([
    'display_name' => '<string>',
    'enabled' => true,
    'oidc_config' => [
        'authorization_url' => '<string>',
        'token_url' => '<string>',
        'client_id' => '<string>',
        'client_secret' => '<string>',
        'user_info_url' => '<string>',
        'issuer' => '<string>',
        'default_scope' => 'openid email profile',
        'sync_mode' => 'INHERIT',
        'validate_signature' => true,
        'use_jwks_url' => true,
        'pkce_enabled' => false,
        'pkce_method' => 'S256'
    ],
    'saml_config' => [
        'single_sign_on_service_url' => '<string>',
        'single_logout_service_url' => '<string>',
        'name_id_policy_format' => 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent',
        'signing_certificate' => '<string>',
        'want_authn_requests_signed' => true,
        'post_binding_authn_request' => true,
        'post_binding_response' => true,
        'sync_mode' => 'INHERIT'
    ],
    'ldap_config' => [
        'connection_url' => '<string>',
        'bind_dn' => '<string>',
        'bind_credential' => '<string>',
        'users_dn' => '<string>',
        'users_filter' => '<string>',
        'vendor' => 'ad',
        'username_ldap_attribute' => 'sAMAccountName',
        'rdn_ldap_attribute' => 'sAMAccountName',
        'uuid_ldap_attribute' => 'objectGUID',
        'user_object_classes' => 'person, organizationalPerson, user',
        'search_scope' => '2',
        'edit_mode' => 'READ_ONLY',
        'use_truststore_spi' => 'always',
        'connection_timeout' => 5000,
        'read_timeout' => 10000,
        'pagination' => true,
        'batch_size_for_sync' => 1000,
        'full_sync_period' => 604800,
        'changed_sync_period' => 86400,
        'sync_registrations' => false,
        'import_enabled' => true,
        'trust_email' => true
    ],
    'mappers' => [
        [
                'name' => '<string>',
                'identity_provider_mapper' => '<string>',
                'id' => '<string>',
                'config' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.example.com/api/identity-providers/{alias}"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"enabled\": true,\n  \"oidc_config\": {\n    \"authorization_url\": \"<string>\",\n    \"token_url\": \"<string>\",\n    \"client_id\": \"<string>\",\n    \"client_secret\": \"<string>\",\n    \"user_info_url\": \"<string>\",\n    \"issuer\": \"<string>\",\n    \"default_scope\": \"openid email profile\",\n    \"sync_mode\": \"INHERIT\",\n    \"validate_signature\": true,\n    \"use_jwks_url\": true,\n    \"pkce_enabled\": false,\n    \"pkce_method\": \"S256\"\n  },\n  \"saml_config\": {\n    \"single_sign_on_service_url\": \"<string>\",\n    \"single_logout_service_url\": \"<string>\",\n    \"name_id_policy_format\": \"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent\",\n    \"signing_certificate\": \"<string>\",\n    \"want_authn_requests_signed\": true,\n    \"post_binding_authn_request\": true,\n    \"post_binding_response\": true,\n    \"sync_mode\": \"INHERIT\"\n  },\n  \"ldap_config\": {\n    \"connection_url\": \"<string>\",\n    \"bind_dn\": \"<string>\",\n    \"bind_credential\": \"<string>\",\n    \"users_dn\": \"<string>\",\n    \"users_filter\": \"<string>\",\n    \"vendor\": \"ad\",\n    \"username_ldap_attribute\": \"sAMAccountName\",\n    \"rdn_ldap_attribute\": \"sAMAccountName\",\n    \"uuid_ldap_attribute\": \"objectGUID\",\n    \"user_object_classes\": \"person, organizationalPerson, user\",\n    \"search_scope\": \"2\",\n    \"edit_mode\": \"READ_ONLY\",\n    \"use_truststore_spi\": \"always\",\n    \"connection_timeout\": 5000,\n    \"read_timeout\": 10000,\n    \"pagination\": true,\n    \"batch_size_for_sync\": 1000,\n    \"full_sync_period\": 604800,\n    \"changed_sync_period\": 86400,\n    \"sync_registrations\": false,\n    \"import_enabled\": true,\n    \"trust_email\": true\n  },\n  \"mappers\": [\n    {\n      \"name\": \"<string>\",\n      \"identity_provider_mapper\": \"<string>\",\n      \"id\": \"<string>\",\n      \"config\": {}\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <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/api/identity-providers/{alias}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"enabled\": true,\n  \"oidc_config\": {\n    \"authorization_url\": \"<string>\",\n    \"token_url\": \"<string>\",\n    \"client_id\": \"<string>\",\n    \"client_secret\": \"<string>\",\n    \"user_info_url\": \"<string>\",\n    \"issuer\": \"<string>\",\n    \"default_scope\": \"openid email profile\",\n    \"sync_mode\": \"INHERIT\",\n    \"validate_signature\": true,\n    \"use_jwks_url\": true,\n    \"pkce_enabled\": false,\n    \"pkce_method\": \"S256\"\n  },\n  \"saml_config\": {\n    \"single_sign_on_service_url\": \"<string>\",\n    \"single_logout_service_url\": \"<string>\",\n    \"name_id_policy_format\": \"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent\",\n    \"signing_certificate\": \"<string>\",\n    \"want_authn_requests_signed\": true,\n    \"post_binding_authn_request\": true,\n    \"post_binding_response\": true,\n    \"sync_mode\": \"INHERIT\"\n  },\n  \"ldap_config\": {\n    \"connection_url\": \"<string>\",\n    \"bind_dn\": \"<string>\",\n    \"bind_credential\": \"<string>\",\n    \"users_dn\": \"<string>\",\n    \"users_filter\": \"<string>\",\n    \"vendor\": \"ad\",\n    \"username_ldap_attribute\": \"sAMAccountName\",\n    \"rdn_ldap_attribute\": \"sAMAccountName\",\n    \"uuid_ldap_attribute\": \"objectGUID\",\n    \"user_object_classes\": \"person, organizationalPerson, user\",\n    \"search_scope\": \"2\",\n    \"edit_mode\": \"READ_ONLY\",\n    \"use_truststore_spi\": \"always\",\n    \"connection_timeout\": 5000,\n    \"read_timeout\": 10000,\n    \"pagination\": true,\n    \"batch_size_for_sync\": 1000,\n    \"full_sync_period\": 604800,\n    \"changed_sync_period\": 86400,\n    \"sync_registrations\": false,\n    \"import_enabled\": true,\n    \"trust_email\": true\n  },\n  \"mappers\": [\n    {\n      \"name\": \"<string>\",\n      \"identity_provider_mapper\": \"<string>\",\n      \"id\": \"<string>\",\n      \"config\": {}\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/identity-providers/{alias}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"display_name\": \"<string>\",\n  \"enabled\": true,\n  \"oidc_config\": {\n    \"authorization_url\": \"<string>\",\n    \"token_url\": \"<string>\",\n    \"client_id\": \"<string>\",\n    \"client_secret\": \"<string>\",\n    \"user_info_url\": \"<string>\",\n    \"issuer\": \"<string>\",\n    \"default_scope\": \"openid email profile\",\n    \"sync_mode\": \"INHERIT\",\n    \"validate_signature\": true,\n    \"use_jwks_url\": true,\n    \"pkce_enabled\": false,\n    \"pkce_method\": \"S256\"\n  },\n  \"saml_config\": {\n    \"single_sign_on_service_url\": \"<string>\",\n    \"single_logout_service_url\": \"<string>\",\n    \"name_id_policy_format\": \"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent\",\n    \"signing_certificate\": \"<string>\",\n    \"want_authn_requests_signed\": true,\n    \"post_binding_authn_request\": true,\n    \"post_binding_response\": true,\n    \"sync_mode\": \"INHERIT\"\n  },\n  \"ldap_config\": {\n    \"connection_url\": \"<string>\",\n    \"bind_dn\": \"<string>\",\n    \"bind_credential\": \"<string>\",\n    \"users_dn\": \"<string>\",\n    \"users_filter\": \"<string>\",\n    \"vendor\": \"ad\",\n    \"username_ldap_attribute\": \"sAMAccountName\",\n    \"rdn_ldap_attribute\": \"sAMAccountName\",\n    \"uuid_ldap_attribute\": \"objectGUID\",\n    \"user_object_classes\": \"person, organizationalPerson, user\",\n    \"search_scope\": \"2\",\n    \"edit_mode\": \"READ_ONLY\",\n    \"use_truststore_spi\": \"always\",\n    \"connection_timeout\": 5000,\n    \"read_timeout\": 10000,\n    \"pagination\": true,\n    \"batch_size_for_sync\": 1000,\n    \"full_sync_period\": 604800,\n    \"changed_sync_period\": 86400,\n    \"sync_registrations\": false,\n    \"import_enabled\": true,\n    \"trust_email\": true\n  },\n  \"mappers\": [\n    {\n      \"name\": \"<string>\",\n      \"identity_provider_mapper\": \"<string>\",\n      \"id\": \"<string>\",\n      \"config\": {}\n    }\n  ]\n}"

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

{
  "alias": "<string>",
  "display_name": "<string>",
  "provider_id": "<string>",
  "enabled": true,
  "internal_id": "<string>",
  "config": {},
  "mapper_count": 0
}

{
  "error": "<string>",
  "code": 500
}

{
  "error": "<string>",
  "code": 500
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

PUT

api

identity-providers

{alias}

Update identity provider

curl --request PUT \
  --url https://api.example.com/api/identity-providers/{alias} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "enabled": true,
  "oidc_config": {
    "authorization_url": "<string>",
    "token_url": "<string>",
    "client_id": "<string>",
    "client_secret": "<string>",
    "user_info_url": "<string>",
    "issuer": "<string>",
    "default_scope": "openid email profile",
    "sync_mode": "INHERIT",
    "validate_signature": true,
    "use_jwks_url": true,
    "pkce_enabled": false,
    "pkce_method": "S256"
  },
  "saml_config": {
    "single_sign_on_service_url": "<string>",
    "single_logout_service_url": "<string>",
    "name_id_policy_format": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
    "signing_certificate": "<string>",
    "want_authn_requests_signed": true,
    "post_binding_authn_request": true,
    "post_binding_response": true,
    "sync_mode": "INHERIT"
  },
  "ldap_config": {
    "connection_url": "<string>",
    "bind_dn": "<string>",
    "bind_credential": "<string>",
    "users_dn": "<string>",
    "users_filter": "<string>",
    "vendor": "ad",
    "username_ldap_attribute": "sAMAccountName",
    "rdn_ldap_attribute": "sAMAccountName",
    "uuid_ldap_attribute": "objectGUID",
    "user_object_classes": "person, organizationalPerson, user",
    "search_scope": "2",
    "edit_mode": "READ_ONLY",
    "use_truststore_spi": "always",
    "connection_timeout": 5000,
    "read_timeout": 10000,
    "pagination": true,
    "batch_size_for_sync": 1000,
    "full_sync_period": 604800,
    "changed_sync_period": 86400,
    "sync_registrations": false,
    "import_enabled": true,
    "trust_email": true
  },
  "mappers": [
    {
      "name": "<string>",
      "identity_provider_mapper": "<string>",
      "id": "<string>",
      "config": {}
    }
  ]
}
'

import requests

url = "https://api.example.com/api/identity-providers/{alias}"

payload = {
    "display_name": "<string>",
    "enabled": True,
    "oidc_config": {
        "authorization_url": "<string>",
        "token_url": "<string>",
        "client_id": "<string>",
        "client_secret": "<string>",
        "user_info_url": "<string>",
        "issuer": "<string>",
        "default_scope": "openid email profile",
        "sync_mode": "INHERIT",
        "validate_signature": True,
        "use_jwks_url": True,
        "pkce_enabled": False,
        "pkce_method": "S256"
    },
    "saml_config": {
        "single_sign_on_service_url": "<string>",
        "single_logout_service_url": "<string>",
        "name_id_policy_format": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
        "signing_certificate": "<string>",
        "want_authn_requests_signed": True,
        "post_binding_authn_request": True,
        "post_binding_response": True,
        "sync_mode": "INHERIT"
    },
    "ldap_config": {
        "connection_url": "<string>",
        "bind_dn": "<string>",
        "bind_credential": "<string>",
        "users_dn": "<string>",
        "users_filter": "<string>",
        "vendor": "ad",
        "username_ldap_attribute": "sAMAccountName",
        "rdn_ldap_attribute": "sAMAccountName",
        "uuid_ldap_attribute": "objectGUID",
        "user_object_classes": "person, organizationalPerson, user",
        "search_scope": "2",
        "edit_mode": "READ_ONLY",
        "use_truststore_spi": "always",
        "connection_timeout": 5000,
        "read_timeout": 10000,
        "pagination": True,
        "batch_size_for_sync": 1000,
        "full_sync_period": 604800,
        "changed_sync_period": 86400,
        "sync_registrations": False,
        "import_enabled": True,
        "trust_email": True
    },
    "mappers": [
        {
            "name": "<string>",
            "identity_provider_mapper": "<string>",
            "id": "<string>",
            "config": {}
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: '<string>',
    enabled: true,
    oidc_config: {
      authorization_url: '<string>',
      token_url: '<string>',
      client_id: '<string>',
      client_secret: '<string>',
      user_info_url: '<string>',
      issuer: '<string>',
      default_scope: 'openid email profile',
      sync_mode: 'INHERIT',
      validate_signature: true,
      use_jwks_url: true,
      pkce_enabled: false,
      pkce_method: 'S256'
    },
    saml_config: {
      single_sign_on_service_url: '<string>',
      single_logout_service_url: '<string>',
      name_id_policy_format: 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent',
      signing_certificate: '<string>',
      want_authn_requests_signed: true,
      post_binding_authn_request: true,
      post_binding_response: true,
      sync_mode: 'INHERIT'
    },
    ldap_config: {
      connection_url: '<string>',
      bind_dn: '<string>',
      bind_credential: '<string>',
      users_dn: '<string>',
      users_filter: '<string>',
      vendor: 'ad',
      username_ldap_attribute: 'sAMAccountName',
      rdn_ldap_attribute: 'sAMAccountName',
      uuid_ldap_attribute: 'objectGUID',
      user_object_classes: 'person, organizationalPerson, user',
      search_scope: '2',
      edit_mode: 'READ_ONLY',
      use_truststore_spi: 'always',
      connection_timeout: 5000,
      read_timeout: 10000,
      pagination: true,
      batch_size_for_sync: 1000,
      full_sync_period: 604800,
      changed_sync_period: 86400,
      sync_registrations: false,
      import_enabled: true,
      trust_email: true
    },
    mappers: [
      {
        name: '<string>',
        identity_provider_mapper: '<string>',
        id: '<string>',
        config: {}
      }
    ]
  })
};

fetch('https://api.example.com/api/identity-providers/{alias}', 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/api/identity-providers/{alias}",
  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([
    'display_name' => '<string>',
    'enabled' => true,
    'oidc_config' => [
        'authorization_url' => '<string>',
        'token_url' => '<string>',
        'client_id' => '<string>',
        'client_secret' => '<string>',
        'user_info_url' => '<string>',
        'issuer' => '<string>',
        'default_scope' => 'openid email profile',
        'sync_mode' => 'INHERIT',
        'validate_signature' => true,
        'use_jwks_url' => true,
        'pkce_enabled' => false,
        'pkce_method' => 'S256'
    ],
    'saml_config' => [
        'single_sign_on_service_url' => '<string>',
        'single_logout_service_url' => '<string>',
        'name_id_policy_format' => 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent',
        'signing_certificate' => '<string>',
        'want_authn_requests_signed' => true,
        'post_binding_authn_request' => true,
        'post_binding_response' => true,
        'sync_mode' => 'INHERIT'
    ],
    'ldap_config' => [
        'connection_url' => '<string>',
        'bind_dn' => '<string>',
        'bind_credential' => '<string>',
        'users_dn' => '<string>',
        'users_filter' => '<string>',
        'vendor' => 'ad',
        'username_ldap_attribute' => 'sAMAccountName',
        'rdn_ldap_attribute' => 'sAMAccountName',
        'uuid_ldap_attribute' => 'objectGUID',
        'user_object_classes' => 'person, organizationalPerson, user',
        'search_scope' => '2',
        'edit_mode' => 'READ_ONLY',
        'use_truststore_spi' => 'always',
        'connection_timeout' => 5000,
        'read_timeout' => 10000,
        'pagination' => true,
        'batch_size_for_sync' => 1000,
        'full_sync_period' => 604800,
        'changed_sync_period' => 86400,
        'sync_registrations' => false,
        'import_enabled' => true,
        'trust_email' => true
    ],
    'mappers' => [
        [
                'name' => '<string>',
                'identity_provider_mapper' => '<string>',
                'id' => '<string>',
                'config' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.example.com/api/identity-providers/{alias}"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"enabled\": true,\n  \"oidc_config\": {\n    \"authorization_url\": \"<string>\",\n    \"token_url\": \"<string>\",\n    \"client_id\": \"<string>\",\n    \"client_secret\": \"<string>\",\n    \"user_info_url\": \"<string>\",\n    \"issuer\": \"<string>\",\n    \"default_scope\": \"openid email profile\",\n    \"sync_mode\": \"INHERIT\",\n    \"validate_signature\": true,\n    \"use_jwks_url\": true,\n    \"pkce_enabled\": false,\n    \"pkce_method\": \"S256\"\n  },\n  \"saml_config\": {\n    \"single_sign_on_service_url\": \"<string>\",\n    \"single_logout_service_url\": \"<string>\",\n    \"name_id_policy_format\": \"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent\",\n    \"signing_certificate\": \"<string>\",\n    \"want_authn_requests_signed\": true,\n    \"post_binding_authn_request\": true,\n    \"post_binding_response\": true,\n    \"sync_mode\": \"INHERIT\"\n  },\n  \"ldap_config\": {\n    \"connection_url\": \"<string>\",\n    \"bind_dn\": \"<string>\",\n    \"bind_credential\": \"<string>\",\n    \"users_dn\": \"<string>\",\n    \"users_filter\": \"<string>\",\n    \"vendor\": \"ad\",\n    \"username_ldap_attribute\": \"sAMAccountName\",\n    \"rdn_ldap_attribute\": \"sAMAccountName\",\n    \"uuid_ldap_attribute\": \"objectGUID\",\n    \"user_object_classes\": \"person, organizationalPerson, user\",\n    \"search_scope\": \"2\",\n    \"edit_mode\": \"READ_ONLY\",\n    \"use_truststore_spi\": \"always\",\n    \"connection_timeout\": 5000,\n    \"read_timeout\": 10000,\n    \"pagination\": true,\n    \"batch_size_for_sync\": 1000,\n    \"full_sync_period\": 604800,\n    \"changed_sync_period\": 86400,\n    \"sync_registrations\": false,\n    \"import_enabled\": true,\n    \"trust_email\": true\n  },\n  \"mappers\": [\n    {\n      \"name\": \"<string>\",\n      \"identity_provider_mapper\": \"<string>\",\n      \"id\": \"<string>\",\n      \"config\": {}\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <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/api/identity-providers/{alias}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"enabled\": true,\n  \"oidc_config\": {\n    \"authorization_url\": \"<string>\",\n    \"token_url\": \"<string>\",\n    \"client_id\": \"<string>\",\n    \"client_secret\": \"<string>\",\n    \"user_info_url\": \"<string>\",\n    \"issuer\": \"<string>\",\n    \"default_scope\": \"openid email profile\",\n    \"sync_mode\": \"INHERIT\",\n    \"validate_signature\": true,\n    \"use_jwks_url\": true,\n    \"pkce_enabled\": false,\n    \"pkce_method\": \"S256\"\n  },\n  \"saml_config\": {\n    \"single_sign_on_service_url\": \"<string>\",\n    \"single_logout_service_url\": \"<string>\",\n    \"name_id_policy_format\": \"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent\",\n    \"signing_certificate\": \"<string>\",\n    \"want_authn_requests_signed\": true,\n    \"post_binding_authn_request\": true,\n    \"post_binding_response\": true,\n    \"sync_mode\": \"INHERIT\"\n  },\n  \"ldap_config\": {\n    \"connection_url\": \"<string>\",\n    \"bind_dn\": \"<string>\",\n    \"bind_credential\": \"<string>\",\n    \"users_dn\": \"<string>\",\n    \"users_filter\": \"<string>\",\n    \"vendor\": \"ad\",\n    \"username_ldap_attribute\": \"sAMAccountName\",\n    \"rdn_ldap_attribute\": \"sAMAccountName\",\n    \"uuid_ldap_attribute\": \"objectGUID\",\n    \"user_object_classes\": \"person, organizationalPerson, user\",\n    \"search_scope\": \"2\",\n    \"edit_mode\": \"READ_ONLY\",\n    \"use_truststore_spi\": \"always\",\n    \"connection_timeout\": 5000,\n    \"read_timeout\": 10000,\n    \"pagination\": true,\n    \"batch_size_for_sync\": 1000,\n    \"full_sync_period\": 604800,\n    \"changed_sync_period\": 86400,\n    \"sync_registrations\": false,\n    \"import_enabled\": true,\n    \"trust_email\": true\n  },\n  \"mappers\": [\n    {\n      \"name\": \"<string>\",\n      \"identity_provider_mapper\": \"<string>\",\n      \"id\": \"<string>\",\n      \"config\": {}\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/identity-providers/{alias}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"display_name\": \"<string>\",\n  \"enabled\": true,\n  \"oidc_config\": {\n    \"authorization_url\": \"<string>\",\n    \"token_url\": \"<string>\",\n    \"client_id\": \"<string>\",\n    \"client_secret\": \"<string>\",\n    \"user_info_url\": \"<string>\",\n    \"issuer\": \"<string>\",\n    \"default_scope\": \"openid email profile\",\n    \"sync_mode\": \"INHERIT\",\n    \"validate_signature\": true,\n    \"use_jwks_url\": true,\n    \"pkce_enabled\": false,\n    \"pkce_method\": \"S256\"\n  },\n  \"saml_config\": {\n    \"single_sign_on_service_url\": \"<string>\",\n    \"single_logout_service_url\": \"<string>\",\n    \"name_id_policy_format\": \"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent\",\n    \"signing_certificate\": \"<string>\",\n    \"want_authn_requests_signed\": true,\n    \"post_binding_authn_request\": true,\n    \"post_binding_response\": true,\n    \"sync_mode\": \"INHERIT\"\n  },\n  \"ldap_config\": {\n    \"connection_url\": \"<string>\",\n    \"bind_dn\": \"<string>\",\n    \"bind_credential\": \"<string>\",\n    \"users_dn\": \"<string>\",\n    \"users_filter\": \"<string>\",\n    \"vendor\": \"ad\",\n    \"username_ldap_attribute\": \"sAMAccountName\",\n    \"rdn_ldap_attribute\": \"sAMAccountName\",\n    \"uuid_ldap_attribute\": \"objectGUID\",\n    \"user_object_classes\": \"person, organizationalPerson, user\",\n    \"search_scope\": \"2\",\n    \"edit_mode\": \"READ_ONLY\",\n    \"use_truststore_spi\": \"always\",\n    \"connection_timeout\": 5000,\n    \"read_timeout\": 10000,\n    \"pagination\": true,\n    \"batch_size_for_sync\": 1000,\n    \"full_sync_period\": 604800,\n    \"changed_sync_period\": 86400,\n    \"sync_registrations\": false,\n    \"import_enabled\": true,\n    \"trust_email\": true\n  },\n  \"mappers\": [\n    {\n      \"name\": \"<string>\",\n      \"identity_provider_mapper\": \"<string>\",\n      \"id\": \"<string>\",\n      \"config\": {}\n    }\n  ]\n}"

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

{
  "alias": "<string>",
  "display_name": "<string>",
  "provider_id": "<string>",
  "enabled": true,
  "internal_id": "<string>",
  "config": {},
  "mapper_count": 0
}

{
  "error": "<string>",
  "code": 500
}

{
  "error": "<string>",
  "code": 500
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

alias

string

required

Body

application/json

Request to update an identity provider.

display_name

string | null

enabled

boolean | null

oidc_config

OidcConfig · object | null

OIDC-specific IdP configuration.

Show child attributes

saml_config

SamlConfig · object | null

SAML-specific IdP configuration.

Show child attributes

ldap_config

LdapConfig · object | null

LDAP user federation configuration for Active Directory or generic LDAP.

Show child attributes

mappers

IdpMapperConfig · object[] | null

Show child attributes

Response

Identity provider updated.

Response for a single identity provider.

alias

string

required

display_name

string

required

provider_id

string

required

enabled

boolean

required

internal_id

string | null

known_provider

enum<string> | null

Available options:

okta,

entra_id,

auth0,

google,

github,

ping_identity,

onelogin,

custom_oidc,

custom_saml,

active_directory

config

Config · object

Provider configuration. NexusOne masks the secrets.

mapper_count

integer

default:0

Number of configured mappers.

⌘I