Mettre à jour le provisionnement de l’annuaire

Mettez à jour la configuration de provisioning de l’annuaire d’une connexion.

PATCH https://{tenantDomain}/api/v2/connections/{id}/directory-provisioning

Mettre à jour partiellement une configuration de provisionnement d’annuaire

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/connections/{id}/directory-provisioning \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mapping": [
    {
      "auth0": "<string>",
      "idp": "<string>"
    }
  ],
  "synchronize_automatically": true
}
'

200

{
  "connection_id": "<string>",
  "connection_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "mapping": [
    {
      "auth0": "<string>",
      "idp": "<string>"
    }
  ],
  "strategy": "<string>",
  "synchronize_automatically": true,
  "updated_at": "2023-11-07T05:31:56Z",
  "last_synchronization_at": "2023-11-07T05:31:56Z",
  "last_synchronization_error": "<string>",
  "last_synchronization_status": "<string>"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id · string · requis

L’id de la connexion pour créer sa configuration de provisioning de l’annuaire

Corps

application/jsonapplication/x-www-form-urlencoded

mapping · object[]

Le mapping entre les attributs utilisateur d’Auth0 et de l’IdP

Minimum array length: 1

Show child attributes

synchronize_automatically · boolean

Indique si la synchronisation automatique périodique est activée

synchronize_groups · enum<string> · GA

Configuration de la synchronisation des groupes

Options disponibles: all, off, selected

Réponse

200

application/json

La configuration de provisioning de l’annuaire de la connexion a été mise à jour. Consultez Schémas de réponse pour le schéma.

connection_id · string · requis

L’identifiant de la connexion

connection_name · string · requis

Le nom de la connexion

created_at · string<date-time> · requis

L’horodatage de création de la configuration de provisionnement de l’annuaire

mapping · object[] · requis

Le mapping entre les attributs utilisateur d’Auth0 et de l’IdP

Minimum array length: 1

Show child attributes

strategy · string · requis

La stratégie de la connexion

synchronize_automatically · boolean · requis

Indique si la synchronisation automatique périodique est activée

updated_at · string<date-time> · requis

L’horodatage de la dernière mise à jour de la configuration de provisionnement de l’annuaire

last_synchronization_at · string<date-time>

L’horodatage de la dernière synchronisation de la connexion

last_synchronization_error · string

Le message d’erreur de la dernière synchronisation, le cas échéant

last_synchronization_status · string

Le statut de la dernière synchronisation

synchronize_groups · enum<string> · GA

Configuration de la synchronisation des groupes

Options disponibles: all, off, selected