Mettre à jour le fournisseur d’identité de l’organisation

Mettre à jour les détails d’un fournisseur d’identité spécifié par ID pour cette Organisation.

PATCH /identity-providers/{idp_id}

Mettre à jour un fournisseur d’identité

cURL

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

200

updateIdPResponseExample

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

Autorisations

OAuth2ClientCredentialsOAuth2AuthCode

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

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

assign_membership_on_login · boolean

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

display_name · string

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

Required string length: 1 - 128

is_enabled · boolean

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

show_as_button · boolean

Permet d’afficher un bouton pour la connexion sur la page de connexion (nouvelle expérience uniquement). Si la valeur est false, elle ne pourra être utilisée que par la détection du domaine d’origine (HRD). Nécessite que access_level soit défini à 'full' ou 'limited'

options · adfs_server · object

Options propres au fournisseur d’identité. Nécessite que access_level soit défini à 'full'.

adfs_server

fedMetadataXml

Show child attributes

Réponse

200

application/json

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

IdP ADFS Response

IdP Google Workforce Response

IdP OIDC Response

IdP Okta Response

IdP Ping Response

IdP SAML Response

IdP Microsoft Azure AD Response

Options propres au fournisseur d’identité.

strategy · enum<string> · requis

Type du fournisseur d’identité

Options disponibles: adfs, google-apps, oidc, okta, pingfederate, samlp, waad

Allowed value: "adfs"

options · adfs_server · object · requis

Options propres au fournisseur d’identité.

adfs_server

fedMetadataXml

Show child attributes

access_level · enum<string> · read-only

Options disponibles: none, readonly, limited, full

assign_membership_on_login · boolean

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

display_name · string

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

Required string length: 1 - 128

domains · string[]

Liste des domaines pour la détection du domaine d’origine (HRD)

id · string · read-only

Identifiant du fournisseur d’identité.

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

is_enabled · boolean

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

name · string | null

Le nom du fournisseur d’identité

Maximum string length: 128

show_as_button · boolean

Permet d’afficher un bouton pour la connexion sur la page de connexion (nouvelle expérience uniquement). Si la valeur est false, elle ne pourra être utilisée que par la détection du domaine d’origine (HRD).