Mettre à jour un fournisseur d’identité

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

{
  "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": "Nom d’utilisateur préféré",
      "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
    }
  ]
}

PATCH

identity-providers

{idp_id}

Mettre à jour un fournisseur d’identité

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

{
  "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": "Nom d’utilisateur préféré",
      "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
    }
  ]
}

Autorisations

Authorization

string

header

requis

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

Paramètres de chemin

idp_id

string

requis

read-only

Identifiant du fournisseur d’identité.

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

Corps

application/json

display_name

string

Nom du fournisseur d’identité utilisé sur l’écran de connexion. Nécessite que access_level soit défini sur 'full'

Required string length: 1 - 128

show_as_button

boolean

Permet d’afficher un bouton pour la connexion sur la page de connexion (nouvelle expérience seulement). Si false, elle pourra être utilisée uniquement par Home Realm Discovery (HRD). Nécessite que access_level soit défini sur 'full' ou 'limited'

Si true, l’utilisateur deviendra membre de l’organisation lors de la connexion. Nécessite que access_level soit défini sur 'full' ou 'limited'.

is_enabled

boolean

True si le fournisseur d’identité est activé pour l’organisation. Nécessite que access_level soit défini sur 'full' ou 'limited'

use_for_third_party_client_access

boolean

Vrai si les applications tierces peuvent l'utiliser. Si faux, seules les applications propriétaires pour lesquelles la connexion est activée peuvent l'utiliser. Nécessite que access_level soit défini sur 'full'. La valeur par défaut est faux.

cross_app_access_resource_app

object

Configuration de l'application de ressources d'accès interapplications. Présente uniquement lorsque la fonctionnalité d'application de ressources d'accès interapplications est activée pour votre organisation.

Show child attributes

options

adfs_server · object

Options spécifiques au fournisseur d’identité. Nécessite que access_level soit défini sur 'full'.

adfs_server
fedMetadataXml

Show child attributes

Réponse

Le fournisseur d’identité a été mis à jour avec succès.

Options spécifiques au fournisseur d’identité.

strategy

enum<string>

requis

Le type de fournisseur d’identité

Options disponibles:

adfs,

google-apps,

oidc,

okta,

pingfederate,

samlp,

waad

Allowed value: "adfs"

string

read-only

Identifiant du fournisseur d’identité.

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

name

string | null

Le nom du fournisseur d’identité

Maximum string length: 128

domains

string[]

Liste des domaines pour Home Realm Discovery (HRD)

display_name

string

Nom du fournisseur d’identité utilisé sur l’écran de connexion.

Required string length: 1 - 128

show_as_button

boolean

Permet d’afficher un bouton pour la connexion sur la page de connexion (nouvelle expérience seulement). Si false, elle pourra être utilisée uniquement par Home Realm Discovery (HRD).

Si true, l’utilisateur deviendra membre de l’organisation lors de la connexion.

is_enabled

boolean

True si le fournisseur d’identité est activé pour l’organisation.

access_level

enum<string>

read-only

Le niveau d’accès autorisé pour l’Organisation

Options disponibles:

none,

readonly,

limited,

full

member_access_level

enum<string>

read-only

Le niveau d’accès des membres de l’Organization pour cette connexion.

Options disponibles:

none,

readonly,

limited,

full

use_for_third_party_client_access

boolean

Vrai si les applications tierces peuvent l'utiliser. Si faux, seules les applications propriétaires pour lesquelles la connexion est activée peuvent l'utiliser. La valeur par défaut est faux.

cross_app_access_resource_app

object

Show child attributes

options

adfs_server · object

Options spécifiques au fournisseur d’identité.

adfs_server
fedMetadataXml

Show child attributes