認証状態

GET /v1/auth/status

機密情報を伏せた認証プロファイルと、Minara のセッションおよび接続状態を取得します。

レスポンス本文

{
  "minara_connected": true,
  "minara_oauth_connected": true,
  "minara_source": "oauth-profile",
  "minara_session": {
    "state": "present",
    "connection": "ready"
  },
  "minara_account_scope": "opaque-account-scope",
  "minara_credential_revision": "opaque-credential-revision"
}

補足

例は Minara のフィールドのみを示します。レスポンスにはプロバイダー設定と機密情報を伏せたプロファイルも含まれます。minara_session.state は absent、present、reauth_required、unknown のいずれかです。独立した connection は ready、refreshing、unavailable のいずれかです。present はローカルの認可情報を保持していることを示し、サーバーに接続できるとは限りません。unknown は資格情報を一時的に読み取れない状態です。任意の reason は明確な拒否や鍵ストアの問題を示します。接続できないことだけを理由にログインを開始しないでください。

minara_account_scope は解釈せずにキャッシュの区分として扱い、値が変わったらアカウントに紐づくキャッシュを消去します。資格情報を読み取れない間はこのフィールドが省略される場合があります。省略だけでログアウトと判断しないでください。値の解析や認証への使用は避けてください。従来の接続状態の真偽値も利用できます。minara_oauth_connected は OAuth ID を必要とするため、API key で Web アプリを解除することはできません。

minara_credential_revision は適用済み資格情報の不透明な世代識別子です。token の更新、資格情報やバックエンドの変更、プロセスの再起動で変わり、資格情報を読み取れない場合は省略されます。既知の世代が変わったら、一時停止した読み取りをサーバーへ再試行できます。アカウント区分が同じならキャッシュを保持します。同じ値や欠落した値では読み取りを再開しません。新しい世代は権限の昇格を示さず、サーバーが再認証を要求する場合があります。失敗した書き込みを自動再実行せず、この識別子を認証に使わないでください。