セッションを削除する
セッションIDを指定してプレイヤーセッションを削除します。対象のセッションは呼び出し元のプロダクトに属している必要があります。 デフォルトでは論理削除です。セッションは revoked としてマークされ、以後クエリできなくなり、プレイヤーIDは再利用可能になりますが、レコード自体は保持されます。 **この操作は取り消せません。** `hardDelete` に `true` を指定した場合は、セッションとそれに含まれる同意情報を完全に削除します。元に戻すことはできません。ハード削除を明示的に有効化されたデベロッパーのみが利用できます。 A delete here sends a `Session.Delete` webhook with a `revocation` of `actor: developer` and `reason: deleted-by-developer`, or `erased-by-developer` for a hard delete. Treat every `Session.Delete` as "no session", and accept actors and reasons you don't know.
Authorization
api-key In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/session/delete" \ -H "Content-Type: application/json" \ -d '{ "sessionId": "b1a6482d-5242-4b4a-aa88-3fa52595a672" }'{ "error": "NOT_FOUND", "errorMessage": "Session not found"}クライアントトークンを受け取る POST
クレームトークンを、それが指すIDと引き換えます。k-ID SDKを使用している開発者のみ利用できます。
セッションを取得する GET
`sessionId`、またはプロダクトとあわせた `kuid` で指定した、既存のセッションを返します。 `etag` を指定すると条件付き取得になります。そのetagの発行後に変更があった場合のみセッションが返され、変更がない場合は `NOT_MODIFIED` が返されます。セッション全体を取得し直すのではなく、etagを使ってポーリングしてください。 `ACTIVE` はプレイヤーがプロダクトの要件を満たしていることを意味し、レスポンスには現在有効な権限が含まれます。 etagはレスポンス全体を対象としており、プロダクトと管轄区域の設定から導出される `permissions`、`ageStatus`、`ageCategory` も含みます。そのため、セッション自体が更新されていなくても、設定を変更するとetagは変わります。 A session that has ended returns HTTP 400 with `NOT_FOUND`, as if it never existed. A session ends when a parent removes access in Family Connect or when you delete it with `/session/delete`. Each one sends a `Session.Delete` webhook whose `revocation` object says who ended the session (`actor`) and why (`reason`). These values are open sets.