保護者への招待をキャンセルする
保護者が完了する前に、進行中の保護者招待チャレンジをキャンセルします。保護者が検証中に、プレイヤーがアプリケーション内から保留中の招待をキャンセルした場合に使用します。 キャンセルすると、チャレンジは `failureReason: "cancelled-by-initiator"` を伴って FAIL に遷移し、ホスト型ウィジェットを表示している保護者には「招待がキャンセルされました」の状態が表示されます。 このAPIでキャンセルできるのは `CHALLENGE_PARENT_INVITE` のチャレンジのみです。
Authorization
api-key In: header
Request Body
application/json
Cancel invite request
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/challenge/cancel-invite" \ -H "Content-Type: application/json" \ -d '{ "challengeId": "ae6d4729-af32-42ea-8ef2-ff46c7664802" }'{ "cancelled": true}{ "error": "INVALID_INPUT", "errorMessage": "The request was missing a sessionId parameter."}セッションをアップグレードする POST
プレイヤーのセッションをアクティブなセッションにアップグレードします。要求された権限に保護者の同意が必要な場合はチャレンジを作成します。 セッションは `sessionId`、`kuid`、またはその両方で指定します。両方を指定すると、そのユーザーを既存のセッションに紐付けます。いずれも指定しない場合は不正なリクエストになります。 `options` はこの呼び出しで作成されるチャレンジの年齢保証を調整し、`materialChange` は同意のために提示する法的文書を指定します。`materialChange.acceptanceDeadline` を設定すると期限付きのアップグレードになります。保護者に承認リクエストのリンクがメールで送られ、その日時までに承認する必要があります。将来のUTCタイムスタンプは指定どおりに扱われ、最小の猶予期間も丸め処理もありません。数分後の期限はそのまま数分後です。省略した場合は期限なしで文書を提示します。 文書が変更されて再同意が必要な場合は `priorChallengeId` を設定してください。新しいチャレンジは保留中または進行中のチャレンジに優先し、その文書に追加されます(追加のみ)。以前のリンクは常に最新のものへ解決されます。 返されたチャレンジのワンタイムパスワードには有効期限があります。表示する直前に `/challenge/generate-otp` を呼び出し、チャレンジが進行中になるまで定期的に再生成してください。
チャレンジを一括作成する POST
1人のプレイヤーについて、複数のプロダクト分の保護者同意チャレンジをまとめて作成します。これにより、1回の保護者対応でプロダクトファミリー全体をカバーできます。 レスポンスにはリクエストしたプロダクトごとのチャレンジが含まれます。単一のチャレンジと同様に、チャレンジが成功または失敗すると `oneTimePassword` と `url` は省略されます。