メインコンテンツまでスキップ

Consoleガイド

Console（管理画面）でアプリケーションまたはシステム連携を作成し、API 利用に必要な認証情報とスコープを設定する手順を解説します。

概要​

AGENTIC STAR の API を利用するには、Console で利用目的に応じたクライアントを事前に作成する必要があります。

アプリケーションシステム連携
用途ユーザーがログインして利用するアプリケーションサーバー間のシステム連携（管理 API 等）
認証フローAuthorization CodeClient Credentials
ユーザー認証あり（ブラウザ経由のログイン）なし（クライアント認証情報のみ）
Console メニュー「アプリ一覧」「システム連携」
前提条件
  • Console にログインできること（developer ロール以上）
  • 組織の管理者から API 利用の許可を得ていること

詳細は認証ガイドを参照してください。

アプリケーションの作成手順​

Console の「アプリ一覧」メニューから「新規作成」をクリックして作成を開始します。

1. アプリケーションの種類の選択​

利用用途に応じてアプリケーションの種類を選択します。種類によって認証方式やセキュリティ設定が自動的に決定されます。作成後に種類は変更できません。

Web アプリケーションSPAモバイル / ネイティブ
用途サーバーサイドで動作する Web アプリケーションブラウザ上で動作する Single Page Applicationモバイルアプリやデスクトップアプリ
クライアントタイプConfidential（Client Secret あり）Public（Client Secret なし、PKCE で認証）Public（Client Secret なし、PKCE で認証）
認証フローAuthorization CodeAuthorization Code + PKCE（必須）Authorization Code + PKCE（必須）
Redirect URI必須必須必須
Web Origins（CORS）任意必須—
SPA / モバイルアプリの場合

SPA およびモバイルアプリは Public Client として設定されます。PKCE（S256）が必須となり、code_challenge / code_verifier によるチャレンジ検証で保護されます。S256 以外の方式（plain 等）には対応していません。

2. 基本情報の入力​

項目必須説明
アプリ名✓アプリケーションの表示名（最大256文字）。認可画面にも表示されます。
ロゴ✓アプリケーションのロゴ画像（PNG, JPEG, SVG 形式、500KB 以下、推奨 128x128px 以上）。
短い説明✓50文字以内の簡潔な説明。アプリ一覧に表示されます。
詳細説明✓アプリケーションの詳細な説明。
サポートURLサポートページの URL。同意画面に表示されます。
プライバシーポリシーURLプライバシーポリシーの URL。同意画面に表示されます。
利用規約URL利用規約の URL。同意画面に表示されます。

3. 技術設定​

項目必須説明
Client ID—自動生成される UUID です。変更はできません。作成後にコピーして利用します。
Redirect URI✓認可完了後のリダイレクト先 URL を1つ以上登録します。完全一致で検証されるため、正確な URL を入力してください。
Web Origins（CORS）※SPA の場合のみ必須。ブラウザからの直接 API 呼び出しを許可するオリジン URL を登録します。Web アプリケーションの場合は任意で、未入力のときは登録した Redirect URI のオリジンが自動的に許可されます。モバイルの場合は表示されません。
Redirect URI の登録について

Redirect URI はセキュリティ上、完全一致で検証されます。開発環境用（http://localhost:3000/callback）と本番環境用（https://yourapp.com/callback）の両方を登録しておくことをお勧めします。ワイルドカードは使用できません。

4. スコープの選択​

アプリケーションが利用する機能に応じて、必要なスコープを選択します。選択したスコープが、このアプリケーションで利用可能な権限の最大範囲になります。

利用可能なスコープの一覧と選択指針については、認証ガイド — スコープを参照してください。

5. 公開設定​

アプリケーションの公開範囲を設定します。トグルスイッチで切り替えます。

設定説明
非公開（デフォルト）開発者権限を持つユーザーのみがアクセスできます。開発中はこの設定を推奨します。
公開組織内の全ユーザーがアクセスできます。

6. 同意画面​

同意画面を有効にするかどうかを設定します。有効にすると、基本情報で設定したアプリケーション名・ロゴ・説明、サポート URL、プライバシーポリシー URL、利用規約 URL が同意画面に反映されます。同意画面を有効にする場合は、これらを正確に入力してください。

同意画面の挙動（表示タイミング・表示される情報）については、認証ガイド — 同意画面を参照してください。

7. 作成の完了​

「作成」ボタンをクリックすると、アプリケーションが作成されます。作成完了後、アプリ詳細画面に遷移します。ここで Client ID と Client Secret を確認できます。

システム連携の作成手順​

管理 API をサーバー間連携で利用する場合は、「システム連携」メニューから Client Credentials クライアントを作成します。ユーザーのログインは不要で、クライアント認証情報のみでアクセストークンを取得します。

Console の「システム連携」メニューから「新規作成」をクリックして作成を開始します。

1. 基本情報の入力​

項目必須説明
名前✓連携先の表示名（最大256文字）。
説明連携の用途や目的の説明。

2. スコープの選択​

システム連携で利用する管理 API に応じて、必要なスコープを選択します。

利用可能なスコープの一覧は、認証ガイド — スコープを参照してください。

書き込みスコープの選択

users:manage や master:manage 等の書き込みスコープは、データの変更・削除を伴います。必要最小限のスコープを選択してください。

3. 作成の完了​

「作成」ボタンをクリックすると、システム連携が作成されます。作成完了後、詳細画面に遷移します。ここで Client ID、Client Secret、Token URL を確認できます。

認証情報の確認​

クライアント作成後、API 利用に必要な認証情報は詳細画面で確認できます。

アプリケーションの認証情報​

アプリ詳細画面で以下の情報を確認できます。

  • Client ID — 「技術設定」セクションに表示されます。コピーボタンでクリップボードにコピーできます。
  • Client Secret — Web アプリケーション（Confidential）の場合に発行されます。
操作説明
表示目のアイコンをクリックすると、マスクされた Client Secret が表示されます。
コピーコピーアイコンをクリックすると、Client Secret をクリップボードにコピーできます。
再生成更新アイコンをクリックすると、新しい Client Secret が生成されます。以前の Secret は即座に無効になります。

システム連携の認証情報​

システム連携の詳細画面で以下の情報を確認できます。

  • Client ID — コピーボタンでクリップボードにコピーできます。
  • Client Secret — 表示・コピー・再生成が可能です（アプリケーションと同じ操作）。
  • Token URL — アクセストークン取得先の URL です。コピーボタンでクリップボードにコピーできます。
Client Secret の取り扱い
  • Client Secret はパスワードと同等の機密情報です。安全に保管してください。
  • ソースコードやバージョン管理システムにハードコードしないでください。環境変数や Secret Manager の利用を推奨します。
  • Client Secret を再生成すると、旧 Secret を使用しているすべてのシステムで認証が失敗します。事前に影響範囲を確認してください。

次のステップ​

認証情報を取得したら、利用目的に応じて以下のガイドに進んでください。