Squadbase
Squadbase Docs

REST API

REST APIの使い方について学びます。

Squadbase REST API

SquadbaseのREST APIを使用すると、アプリからSquadbaseのユーザー情報を取得し簡単にアクセスコントロールやRBACを実装することができます。 以下のガイドでは、APIの使用方法を詳しく説明します。

開発環境では、以下のSDKを使用することでモックデータを活用できます。これにより、cookieが存在しない場合でもAPIのテストが可能です。

ユーザー情報の取得

ユーザー情報を取得するためのAPIエンドポイントは以下の通りです。

POST https://{projectid or custom subdomain}.squadbase.app/_sqcore/auth

リクエスト

リクエストには、cookieから取得した認証情報をAuthorizationヘッダーに渡す必要があります。 認証情報は、__Host-squadbase-sessionという名前のcookieを使用してください。

headers: {
  "Authorization": "Bearer <token>"
}

レスポンス

APIは以下のユーザー情報をJSON形式で返します。

PropTypeDefault
username?
string
-
email?
string
-
firstName?
string
-
lastName?
string
-
iconUrl?
string | null
-
roles?
string[]
-

On this page