接続済みアカウントの作成リクエスト

認証されたユーザーのアカウントを外部IDプロバイダーにリンクするための認可フローを開始します。

POST https://{host}/me/v1/connected-accounts/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
}

承認

Authorization · string · header · 必須

Bearer トークンと DPoP トークンは、API の設定に応じてサポートされます

ボディ

application/json

アカウント接続リクエストを作成するためのリクエスト本文。

connection · string · 必須

アカウントをリンクする接続の名前（例: 'google-oauth2'、'facebook'）。

Required string length: 1 - 128

redirect_uri · string<uri> · 必須

接続プロセスの完了後にリダイレクトする URI。

Maximum string length: 2048

authorization_params · Authorization Parameters · object

認可リクエスト中に基盤となるIDプロバイダー（IdP）へ送信される認可パラメーターです。これらのパラメーターは、IdP が認可フローをどのように処理するかや、どの権限を要求するかに影響します。

Show child attributes

code_challenge · string

code verifier から導出された PKCE の code challenge。

Required string length: 43 - 128

code_challenge_method · string

code challenge の導出に使用される方式。code_challenge が指定されている場合は必須です。

Allowed value: "S256"

scopes · string[]

クライアントがIDプロバイダーに要求する権限を定義します。ユーザーを識別するために使用される標準のスコープ（例: 'openid'、'email'、'profile'）、必要に応じてリフレッシュトークンを取得するために必要なスコープ（例: 'offline_access'）、および保護されたリソースへのアクセスに必要なカスタムスコープを含める必要があります。

Required array length: 1 - 100 elements

Required string length: 1 - 255

例:

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

state · string

リクエストと callback の間で state を維持するために使用される不透明な値。

Required string length: 1 - 4096

レスポンス

201

application/json

アカウント接続リクエストが正常に作成されました

auth_session · string · 必須

認証セッション識別子。

Maximum string length: 64

connect_params · object · 必須

connect URI で使用するパラメーター。

Show child attributes

connect_uri · string<uri> · 必須

アカウント接続フローを開始するためのベース URI。

expires_in · integer · 必須

ticket の有効期限が切れるまでの秒数。

必須範囲: x >= 1