Update an Identity Provider

Update the details of an Identity Provider specified by ID for this Organization.

PATCH /identity-providers/{idp_id}

Update an Identity Provider

cURL

curl --request PATCH \
  --url https://{tenantDomain}/my-org/v1/identity-providers/{idp_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "OIDC IdP",
  "show_as_button": true,
  "assign_membership_on_login": false,
  "is_enabled": true,
  "options": {
    "type": "front_channel",
    "client_id": "a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d",
    "client_secret": "KzQp2sVxR8nTgMjFhYcEWuLoIbDvUoC6A9B1zX7yWqFjHkGrP5sQdLmNp",
    "discovery_url": "https://{yourDomain}/.well-known/openid-configuration"
  }
}
'

import requests

url = "https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}"

payload = {
    "display_name": "OIDC IdP",
    "show_as_button": True,
    "assign_membership_on_login": False,
    "is_enabled": True,
    "options": {
        "type": "front_channel",
        "client_id": "a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d",
        "client_secret": "KzQp2sVxR8nTgMjFhYcEWuLoIbDvUoC6A9B1zX7yWqFjHkGrP5sQdLmNp",
        "discovery_url": "https://{yourDomain}/.well-known/openid-configuration"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: 'OIDC IdP',
    show_as_button: true,
    assign_membership_on_login: false,
    is_enabled: true,
    options: {
      type: 'front_channel',
      client_id: 'a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d',
      client_secret: 'KzQp2sVxR8nTgMjFhYcEWuLoIbDvUoC6A9B1zX7yWqFjHkGrP5sQdLmNp',
      discovery_url: 'https://{yourDomain}/.well-known/openid-configuration'
    }
  })
};

fetch('https://{tenantDomain}/my-org/v1/identity-providers/{idp_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_URL => "https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}",
  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([
    'display_name' => 'OIDC IdP',
    'show_as_button' => true,
    'assign_membership_on_login' => false,
    'is_enabled' => true,
    'options' => [
        'type' => 'front_channel',
        'client_id' => 'a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d',
        'client_secret' => 'KzQp2sVxR8nTgMjFhYcEWuLoIbDvUoC6A9B1zX7yWqFjHkGrP5sQdLmNp',
        'discovery_url' => 'https://{yourDomain}/.well-known/openid-configuration'
    ]
  ]),
  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://{tenantDomain}/my-org/v1/identity-providers/{idp_id}"

	payload := strings.NewReader("{\n  \"display_name\": \"OIDC IdP\",\n  \"show_as_button\": true,\n  \"assign_membership_on_login\": false,\n  \"is_enabled\": true,\n  \"options\": {\n    \"type\": \"front_channel\",\n    \"client_id\": \"a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d\",\n    \"client_secret\": \"KzQp2sVxR8nTgMjFhYcEWuLoIbDvUoC6A9B1zX7yWqFjHkGrP5sQdLmNp\",\n    \"discovery_url\": \"https://{yourDomain}/.well-known/openid-configuration\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"OIDC IdP\",\n  \"show_as_button\": true,\n  \"assign_membership_on_login\": false,\n  \"is_enabled\": true,\n  \"options\": {\n    \"type\": \"front_channel\",\n    \"client_id\": \"a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d\",\n    \"client_secret\": \"KzQp2sVxR8nTgMjFhYcEWuLoIbDvUoC6A9B1zX7yWqFjHkGrP5sQdLmNp\",\n    \"discovery_url\": \"https://{yourDomain}/.well-known/openid-configuration\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"display_name\": \"OIDC IdP\",\n  \"show_as_button\": true,\n  \"assign_membership_on_login\": false,\n  \"is_enabled\": true,\n  \"options\": {\n    \"type\": \"front_channel\",\n    \"client_id\": \"a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d\",\n    \"client_secret\": \"KzQp2sVxR8nTgMjFhYcEWuLoIbDvUoC6A9B1zX7yWqFjHkGrP5sQdLmNp\",\n    \"discovery_url\": \"https://{yourDomain}/.well-known/openid-configuration\"\n  }\n}"

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

200

updateIdPResponseExample

{
  "id": "con_zW1UHutvkVWSWdCC",
  "name": "oidcIdp",
  "display_name": "OIDC IdP",
  "strategy": "oidc",
  "show_as_button": true,
  "assign_membership_on_login": false,
  "access_level": "full",
  "domains": [
    "mydomain.com"
  ],
  "is_enabled": true,
  "options": {
    "type": "front_channel",
    "client_id": "a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d",
    "discovery_url": "https://{yourDomain}/.well-known/openid-configuration"
  },
  "attributes": [
    {
      "sso_field": [
        "userName"
      ],
      "user_attribute": "preferred_username",
      "description": "Preferred Username",
      "label": "Preferred username",
      "is_required": true,
      "is_extra": false,
      "is_missing": false
    },
    {
      "sso_field": [
        "externalId"
      ],
      "user_attribute": "external_id",
      "is_required": true,
      "is_extra": true,
      "is_missing": false
    }
  ]
}

Authorizations

OAuth2ClientCredentialsOAuth2AuthCode

Authorization · string · header · required

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

Path Parameters

idp_id · string · required · read-only

Identity provider identifier.

Pattern: ^con_[A-Za-z0-9]{16}$

Body

application/json

IdP ADFS Update Request

IdP Google Workforce Update Request

IdP OIDC Update Request

IdP Okta Update Request

IdP Ping Update Request

IdP SAML Update Request

IdP Microsoft Azure AD Update Request

display_name · string

Identity provider name used on the login screen. Requires access_level to be 'full'

Required string length: 1 - 128

show_as_button · boolean

Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by Home Realm Discovery (HRD). Requires access_level to be 'full' or 'limited'

assign_membership_on_login · boolean

If true, the user will be made a member of the organization upon login. Requires access_level to be 'full' or 'limited'.

is_enabled · boolean

True if the identity provider is enabled for the organization. Requires access_level to be 'full' or 'limited'

options · adfs_server · object

Identity provider specific options. Requires access_level to be 'full'.

adfs_server

fedMetadataXml

Show child attributes

Response

200

application/json

Identity provider successfully updated.

IdP ADFS Response

IdP Google Workforce Response

IdP OIDC Response

IdP Okta Response

IdP Ping Response

IdP SAML Response

IdP Microsoft Azure AD Response

Identity provider specific options.

strategy · enum<string> · required

The type of the identity provider

Available options: adfs, google-apps, oidc, okta, pingfederate, samlp, waad

Allowed value: "adfs"

options · adfs_server · object · required

Identity provider specific options.

adfs_server

fedMetadataXml

Show child attributes

id · string · read-only

Identity provider identifier.

Pattern: ^con_[A-Za-z0-9]{16}$

name · string | null

The name of the identity provider

Maximum string length: 128

domains · string[]

List of domains for Home Realm Discovery (HRD)

display_name · string

Identity provider name used on the login screen.

Required string length: 1 - 128

show_as_button · boolean

Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by Home Realm Discovery (HRD).

assign_membership_on_login · boolean

If true, the user will be made a member of the organization upon login.

is_enabled · boolean

True if the identity provider is enabled for the organization.

access_level · enum<string> · read-only

The access level allowed for the Organization

Available options: none, readonly, limited, full