ID 設定を取得

GET /v1/identity-settings · 権限 identity-settings:read

環境のユーザー名設定を返します (環境ごとに 1 つのリソース)。設定が一度も書き込まれていない場合は、テーブルの既定値 (username_identifier: off、3～64 文字、空の予約リスト) が ETag: "0" と updated_at: null とともに返されます。ETag レスポンスヘッダーには、PATCH で If-Match として送るバージョンが入っています。

verification_policy (既定値 before_sign_in) と unverified_account_ttl_days (既定値 7) は未確認アカウントのクリーンアップを制御します。ID 設定を更新を参照してください。

リクエスト

この操作はパス、クエリ、ボディのフィールドを取りません。環境は認証情報から決まります。

レスポンス

200 OK、設定と ETag ヘッダー。

{
  "username_identifier": "optional",
  "username_min_length": 3,
  "username_max_length": 32,
  "reserved_usernames": ["admin", "root", "support"],
  "verification_policy": "before_sign_in",
  "unverified_account_ttl_days": 7,
  "updated_at": "2026-10-05T09:30:00.123456Z"
}

エラー

HTTP	コード	概要
401	`unauthenticated`	認証情報が見つからない、無効、または取り消されています。
403	`insufficient_permissions`	認証情報に必要な権限がありません。
429	`rate_limited`	レート制限を超えました。`Retry-After` 期間後に再試行してください。
503	`service_unavailable`	依存関係が一時的に利用できません。`Retry-After` 期間後に再試行してください。

例

curl https://api.eu.keenauth.com/v1/identity-settings \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"