Créer un fournisseur d’identité pour une organisation

Créer un nouveau fournisseur d’identité pour cette Organisation.

POST /identity-providers

Créer un fournisseur d’identité

cURL

curl --request POST \
  --url https://{tenantDomain}/my-org/v1/identity-providers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assign_membership_on_login": false,
  "display_name": "OIDC IdP",
  "domains": [
    "mydomain.com"
  ],
  "is_enabled": true,
  "name": "oidcIdp",
  "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,
  "strategy": "oidc"
}
'

201

createIdPResponseExample

{
  "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": "client_a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7did",
    "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.

Corps

application/json

IdP ADFS Request

IdP Google Workforce Request

IdP OIDC Request

IdP Okta Request

IdP Ping Request

IdP SAML Request

IdP Microsoft Azure AD Request

Options propres au fournisseur d’identité.

name · string · requis

Le nom du fournisseur d’identité

Required string length: 1 - 128

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

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)

is_enabled · boolean

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

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).

Réponse

201

application/json

Fournisseur d’identité créé 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).