Créer une demande de connexion de compte

Démarrer un flux d’autorisation pour lier le compte de l’utilisateur authentifié à un fournisseur d’identité externe.

POST https://{host}/me/v1/connected-accounts/connect

Créer une demande de compte connecté

cURL

curl --request POST \
  --url https://{host}/me/v1/connected-accounts/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection": "<string>",
  "redirect_uri": "<string>",
  "authorization_params": {
    "acr_values": "<string>",
    "audience": "<string>",
    "id_token_hint": "<string>",
    "login_hint": "<string>",
    "max_age": 1073741823,
    "resource": "<string>",
    "ui_locales": "<string>"
  },
  "code_challenge": "<string>",
  "code_challenge_method": "<string>",
  "scopes": [
    "openid",
    "offline_access",
    "read:tasks",
    "write:tasks"
  ],
  "state": "<string>"
}
'

201

{
  "auth_session": "<string>",
  "connect_params": {
    "ticket": "<string>"
  },
  "connect_uri": "<string>",
  "expires_in": 2
}

Autorisations

Authorization · string · header · requis

Les jetons Bearer et DPoP sont pris en charge selon la configuration de l’API

Corps

application/json

Corps de la requête pour créer une demande de liaison de compte.

connection · string · requis

Le nom de la connexion avec laquelle lier le compte (p. ex. : 'google-oauth2', 'facebook').

Required string length: 1 - 128

redirect_uri · string<uri> · requis

L’URI de redirection à utiliser une fois le processus de liaison terminé.

Maximum string length: 2048

authorization_params · Authorization Parameters · object

Paramètres d’autorisation à envoyer au fournisseur d’identité (IdP) sous-jacent pendant la requête d’autorisation. Ces paramètres influencent la façon dont l’IdP traite le flux d’autorisation et les autorisations demandées.

Show child attributes

code_challenge · string

Le défi de code PKCE dérivé du vérificateur de code.

Required string length: 43 - 128

code_challenge_method · string

La méthode utilisée pour dériver le défi de code. Obligatoire lorsque code_challenge est fourni.

Allowed value: "S256"

scopes · string[]

Définit les autorisations que l’application demande au fournisseur d’identité. Doit inclure les scopes standard utilisés pour identifier l’utilisateur (p. ex. 'openid', 'email', 'profile'), le scope requis pour obtenir des Refresh Tokens au besoin (p. ex. 'offline_access'), ainsi que tout scope personnalisé dont l’application a besoin pour accéder aux ressources protégées.

Required array length: 1 - 100 elements

Required string length: 1 - 255

Exemple:

[
  "openid",
  "offline_access",
  "read:tasks",
  "write:tasks"
]

state · string

Une valeur opaque utilisée pour maintenir l’état entre la requête et le callback.

Required string length: 1 - 4096

Réponse

201

application/json

Demande de liaison de compte créée avec succès

auth_session · string · requis

L’identifiant de la session d’authentification.

Maximum string length: 64

connect_params · object · requis

Paramètres à utiliser avec l’URI de connexion.

Show child attributes

connect_uri · string<uri> · requis

L’URI de base pour lancer le flux de liaison de compte.

expires_in · integer · requis

Le nombre de secondes avant l’expiration du ticket.

Plage requise: x >= 1