REST API
REST APIの使い方について学びます。
Squadbase REST API
SquadbaseのREST APIを使用すると、アプリからSquadbaseのユーザー情報を取得し簡単にアクセスコントロールやRBACを実装することができます。 以下のガイドでは、APIの使用方法を詳しく説明します。
開発環境では、以下のSDKを使用することでモックデータを活用できます。これにより、cookieが存在しない場合でもAPIのテストが可能です。
- Streamlit: squadbase-streamlit
- Next.js: @squadbase/nextjs
- サーバーサイドJavaScript: @squadbase/server
ユーザー情報の取得
ユーザー情報を取得するためのAPIエンドポイントは以下の通りです。
リクエスト
リクエストには、cookieから取得した認証情報をAuthorizationヘッダーに渡す必要があります。
認証情報は、__Host-squadbase-session
という名前のcookieを使用してください。
レスポンス
APIは以下のユーザー情報をJSON形式で返します。
Prop | Type | Default |
---|---|---|
username? | string | - |
email? | string | - |
firstName? | string | - |
lastName? | string | - |
iconUrl? | string | null | - |
roles? | string[] | - |