> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/reference/ja/ren-zheng/authentication/sign-in-with-roboflow-getting-started.md).

# Sign In With Roboflow（入門）

OAuth 2.1 と PKCE を使用して、ユーザーが Roboflow アカウントでアプリにサインインできるようにします。

PKCE を使用した OAuth 2.1 認可コードフローで、ユーザーが Roboflow アカウントを使ってアプリケーションにサインインできるようにできます。アプリはその後、ユーザーに代わって操作しますが、その範囲はユーザーが承認した権限に限られます。

OAuth アクセストークンは `api.roboflow.com` に対して、 `Authorization: Bearer`を使って機能します。詳しくは [REST API での認証](https://docs.roboflow.com/reference/ja/platform/rest-api/authenticate-with-the-rest-api.md) をご覧ください。

ホスト、公開範囲、エラー、および実行可能なサンプルアプリについては、 [Roboflow でのサインイン（開発者向けリファレンス）](https://docs.roboflow.com/reference/ja/ren-zheng/authentication/sign-in-with-roboflow-developer-reference.md).

## OAuth アプリを作成する

アプリケーションを登録するには、次の手順に従います。

{% stepper %}
{% step %}

### 開発者設定を開く

Roboflow ダッシュボードで「ワークスペース設定 > 開発者」に移動します。 [app.roboflow.com](https://app.roboflow.com).

<figure><img src="https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-4023eba1338a5f7415538890ca8a1d0b17af4a8a%2Fsiwf-workspace-settings-developer.png?alt=media" alt="Developer settings with OAuth applications"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### 新しい OAuth アプリを作成する

「OAuth アプリを作成」（または「新しいアプリ」）をクリックし、次の項目を入力します。

<table data-search="false"><thead><tr><th>フィールド</th><th>説明</th></tr></thead><tbody><tr><td>名前</td><td>同意画面と OAuth アプリ一覧に表示される名前です。</td></tr><tr><td>ホームページ URL</td><td>製品の URL です。情報提供のため、同意画面に表示されます。</td></tr><tr><td>リダイレクト URI</td><td>1 つ以上のコールバック URL です。それぞれ、コードで送信する <code>redirect_uri</code> と完全に一致する必要があります。</td></tr><tr><td>トークンエンドポイントの認証</td><td>アプリがトークンエンドポイントにシークレットを送信する方法です。 <code>client_secret_post</code> （リクエストボディ内。デフォルト）または <code>client_secret_basic</code> （HTTP Basic の <code>Authorization</code> ヘッダー内）を指定します。ほとんどの MCP ゲートウェイ（例：Azure、TrueFoundry）では、 <code>client_secret_basic</code>.</td></tr><tr><td>許可するスコープ</td><td>サインイン時にリクエストするすべてのスコープです。</td></tr><tr><td>公開範囲</td><td>内部、限定公開、または公開です。詳しくは <a href="https://docs.roboflow.com/reference/ja/ren-zheng/authentication/sign-in-with-roboflow-developer-reference.md#visibility">公開範囲</a>.</td></tr></tbody></table>

<figure><img src="https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-822549b57159083c3cd1dc87019e973ce44df7bf%2Fsiwf-oauth-apps-list.png?alt=media" alt="OAuth applications list on the Developer page"><figcaption></figcaption></figure>

<figure><img src="https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-aa529ca046c38a2926caff5c41f5d496878f4e98%2Fsiwf-oauth-create-app-form.png?alt=media" alt="Create OAuth application form"><figcaption></figcaption></figure>

クライアント ID とクライアントシークレット（`rfcs_…`）が発行されます。シークレットは一度しか表示されないため、サーバーに保存してください。
{% endstep %}
{% endstepper %}

### リダイレクト URI の例

<table data-search="false"><thead><tr><th>リダイレクト URI</th><th>一般的な用途</th></tr></thead><tbody><tr><td><code>http://localhost:3001/oauth/callback</code></td><td>ポート 3001 でのローカル開発</td></tr><tr><td><code>http://127.0.0.1:3001/oauth/callback</code></td><td>アプリが次を使用する場合も同様です <code>127.0.0.1</code></td></tr><tr><td><code>https://yourapp.com/oauth/callback</code></td><td>本番環境</td></tr></tbody></table>

公開ホストでは HTTPS が必要です。HTTP が使えるのはループバックアドレス（`localhost`, `127.0.0.1`, `::1`).

## 認可フロー

Roboflow は PKCE（Proof Key for Code Exchange）を使用する認可コードグラントを採用しています。すべてのクライアントで、次の方式を使った PKCE が必要です。 `S256` 方式。

{% stepper %}
{% step %}

### PKCE コードベリファイアとチャレンジを生成する

ランダムな `code_verifier` （43～128 文字）を作成し、SHA-256 を使ってそこから `code_challenge` を導出します。

```python
import hashlib, base64, secrets

code_verifier = secrets.token_urlsafe(32)
code_challenge = base64.urlsafe_b64encode(
    hashlib.sha256(code_verifier.encode()).digest()
).rstrip(b"=").decode()
```

{% endstep %}

{% step %}

### 認可を求めるためにユーザーをリダイレクトする

ユーザーのブラウザーを Roboflow の認可 URL に移動させます。

```
https://app.roboflow.com/oauth/authorize?
  client_id=YOUR_CLIENT_ID&
  redirect_uri=https://yourapp.com/callback&
  response_type=code&
  scope=openid profile email workspace:read&
  code_challenge=YOUR_CODE_CHALLENGE&
  code_challenge_method=S256&
  state=YOUR_STATE_VALUE
```

ランダムな `state` 値を使用し、コールバック時に照合してください。Roboflow では必須ではありません `state`が、偽造されたコールバックをブロックするためにアプリでは必要です。 `code_verifier` は、コードを交換するまでサーバー上に保持してください。

ユーザーには、アプリが要求した権限を示す同意画面が表示され、付与するワークスペースを選択します。

この画面でワークスペースを事前選択するには、 `workspace=YOUR_WORKSPACE_ID` を認可 URL に追加します。ユーザーがそのワークスペースへの権限を付与できない場合、Roboflow はこの指定を無視し、付与可能な最初のワークスペースを選択します。そのため、サインイン後に付与されたワークスペースを確認してください。

<figure><img src="https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-942df7ec61e36430c7df0770a51d0c22c1600deb%2Fsiwf-oauth-consent-screen.png?alt=media" alt="OAuth consent screen with workspace selection and scopes"><figcaption></figcaption></figure>

ユーザーが承認すると、Roboflow は `redirect_uri` に `code` と `state`.
{% endstep %}

{% step %}

### コードをトークンに交換する

サーバー上で（ブラウザーでは絶対に行わず）、コードと `code_verifier` をトークンエンドポイントに送信し、 `grant_type=authorization_code`。コードは1回限り有効で、60秒後に期限切れとなるため、すぐに交換してください。詳しくは [トークンの取得または更新](#get-or-refresh-tokens).
{% endstep %}
{% endstepper %}

## トークン

### トークンの取得または更新

トークンエンドポイントは、コードの交換とトークンの更新の両方を処理します。 `grant_type=authorization_code` をコールバックで受け取ったコードとともに送信するか、 `grant_type=refresh_token` をリフレッシュトークンとともに送信します。

アクセストークンの有効期間は1時間（MCPクライアントでは24時間）、リフレッシュトークンの有効期間は30日です。アクセストークンの期限が切れたら更新してください。更新に失敗して `invalid_grant`が返された場合は、ユーザーに再度サインインしてもらってください。

{% openapi src="/files/7a5b370d857a9984a15f37c834e4a85a9a2fa935" path="/oauth/token" method="post" %}
[sign-in-with-roboflow.yaml](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-5e04f3f2d52edd3c9a11b3f2b4ac16e9bf05206c%2Fsign-in-with-roboflow.yaml?alt=media)
{% endopenapi %}

### アクセストークンの使用

アクセストークンを `Authorization` ヘッダーに指定して `api.roboflow.com`:

```bash
curl -H "Authorization: Bearer rfoa_..." https://api.roboflow.com/
```

### トークンの検証

クライアント認証情報を使わずに、アクセストークンの状態と有効期限を確認します。 `rfoa_` トークンを受け取るリソースサーバー（MCPサーバーなど）は、トークンの有効期限が切れるまでキャッシュするためにこのエンドポイントを使用します。

{% openapi src="/files/7a5b370d857a9984a15f37c834e4a85a9a2fa935" path="/oauth/validate" method="get" %}
[sign-in-with-roboflow.yaml](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-5e04f3f2d52edd3c9a11b3f2b4ac16e9bf05206c%2Fsign-in-with-roboflow.yaml?alt=media)
{% endopenapi %}

### トークンの取り消し

アクセストークンまたはリフレッシュトークンを取り消します。ユーザーがアプリからサインアウトするときに呼び出してください。

{% openapi src="/files/7a5b370d857a9984a15f37c834e4a85a9a2fa935" path="/oauth/revoke" method="post" %}
[sign-in-with-roboflow.yaml](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-5e04f3f2d52edd3c9a11b3f2b4ac16e9bf05206c%2Fsign-in-with-roboflow.yaml?alt=media)
{% endopenapi %}

### ユーザー情報の取得

サインイン中のユーザーのプロフィールを返します。トークンには `openid` スコープが必要です。

{% openapi src="/files/7a5b370d857a9984a15f37c834e4a85a9a2fa935" path="/oauth/userinfo" method="get" %}
[sign-in-with-roboflow.yaml](https://1568109427-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-5e04f3f2d52edd3c9a11b3f2b4ac16e9bf05206c%2Fsign-in-with-roboflow.yaml?alt=media)
{% endopenapi %}

## 利用可能なスコープ

アプリでは、これらのスコープを任意に組み合わせてリクエストできます。各スコープは、OAuthアプリの「許可するスコープ」リストにも含まれている必要があります。

### IDスコープ

<table data-search="false"><thead><tr><th>スコープ</th><th>説明</th></tr></thead><tbody><tr><td><code>openid</code></td><td>安定したユーザーIDを <code>sub</code> クレームで返します。 <code>id_token</code> およびユーザー情報に必要です。</td></tr><tr><td><code>profile</code></td><td>ユーザーの表示名とメールアドレスを読み取ります。</td></tr><tr><td><code>email</code></td><td>ユーザーのメールアドレスを読み取ります。</td></tr></tbody></table>

### APIスコープ

<table data-search="false"><thead><tr><th>スコープ</th><th>説明</th></tr></thead><tbody><tr><td><code>workspace:read</code></td><td>ワークスペースの詳細の読み取り、プロジェクト一覧の取得</td></tr><tr><td><code>project:create</code></td><td>プロジェクトの作成</td></tr><tr><td><code>project:read</code></td><td>プロジェクトの詳細の読み取り</td></tr><tr><td><code>project:update</code></td><td>プロジェクト設定を更新</td></tr><tr><td><code>image:create</code></td><td>画像をアップロード</td></tr><tr><td><code>image:read</code></td><td>画像を読み取り、ダウンロード</td></tr><tr><td><code>image:tag</code></td><td>画像タグを追加・削除</td></tr><tr><td><code>image:annotate</code></td><td>アノテーションを作成・更新</td></tr><tr><td><code>model:infer</code></td><td>推論を実行</td></tr><tr><td><code>model:deploy</code></td><td>モデルをデプロイ</td></tr><tr><td><code>model:manage</code></td><td>モデル設定を管理</td></tr><tr><td><code>model-eval:read</code></td><td>モデル評価結果を読み取り</td></tr><tr><td><code>workflow:create</code></td><td>ワークフローを作成</td></tr><tr><td><code>workflow:read</code></td><td>ワークフローを読み取り</td></tr><tr><td><code>workflow:update</code></td><td>ワークフローを更新</td></tr><tr><td><code>version:create</code></td><td>データセットのバージョンを作成</td></tr><tr><td><code>version:read</code></td><td>データセットのバージョンを読み取り</td></tr><tr><td><code>version:export</code></td><td>データセットのバージョンをエクスポートしてダウンロード</td></tr><tr><td><code>version:update</code></td><td>データセットのバージョンを更新</td></tr><tr><td><code>training-job:create</code></td><td>トレーニングジョブを開始</td></tr><tr><td><code>folder:create</code></td><td>プロジェクトフォルダーを作成</td></tr><tr><td><code>folder:read</code></td><td>プロジェクトフォルダーを読み取り</td></tr><tr><td><code>folder:update</code></td><td>プロジェクトフォルダーを更新</td></tr><tr><td><code>folder:delete</code></td><td>プロジェクトフォルダーを削除</td></tr></tbody></table>

<details>

<summary>追加のスコープ</summary>

<table data-search="false"><thead><tr><th>スコープ</th><th>説明</th></tr></thead><tbody><tr><td><code>device:read</code></td><td>デバイスを読み取り</td></tr><tr><td><code>device:update</code></td><td>デバイス設定を更新</td></tr><tr><td><code>vision-events:read</code></td><td>ビジョンイベントを読み取り</td></tr><tr><td><code>vision-events:write</code></td><td>ビジョンイベントを作成</td></tr><tr><td><code>vision-events:manage</code></td><td>ビジョンイベントのユースケースを管理</td></tr><tr><td><code>annotation-job:create</code></td><td>アノテーションジョブを作成</td></tr><tr><td><code>annotation-job:read</code></td><td>アノテーションジョブを読み取り</td></tr><tr><td><code>video-inference-job:create</code></td><td>動画推論ジョブを作成</td></tr><tr><td><code>video-inference-job:read</code></td><td>動画推論ジョブを読み取り</td></tr><tr><td><code>integration:create</code></td><td>インテグレーションを作成</td></tr><tr><td><code>integration:delete</code></td><td>インテグレーションを削除</td></tr><tr><td><code>credentials:create</code></td><td>認証情報を作成</td></tr><tr><td><code>credentials:read</code></td><td>認証情報を読み取り</td></tr><tr><td><code>credentials:update</code></td><td>認証情報を更新</td></tr><tr><td><code>credentials:delete</code></td><td>認証情報を削除</td></tr><tr><td><code>data-staging:read</code></td><td>ステージング済みデータを読み取り</td></tr><tr><td><code>data-staging:write</code></td><td>ステージング済みデータを書き込み</td></tr><tr><td><code>data-staging:delete</code></td><td>ステージング済みデータを削除</td></tr><tr><td><code>batch-processing:read</code></td><td>バッチジョブを読み取り</td></tr><tr><td><code>batch-processing:trigger</code></td><td>バッチ処理を開始</td></tr><tr><td><code>batch:read</code></td><td>バッチを読み取り</td></tr><tr><td><code>workspace-stats:read</code></td><td>ワークスペースの統計情報を読み取り</td></tr></tbody></table>

</details>

## OIDC Discovery

Roboflowは標準のOpenID Connectディスカバリードキュメントを公開しています。OAuthおよびOIDCクライアントライブラリはこれらを読み取り、上記のエンドポイントを特定します。

* OpenID構成: `https://app.roboflow.com/.well-known/openid-configuration`
* IDトークンの検証に使用するJWKS: `https://app.roboflow.com/.well-known/jwks.json`

## 次のステップ

* [Roboflowでサインイン（開発者向けリファレンス）](https://docs.roboflow.com/reference/ja/ren-zheng/authentication/sign-in-with-roboflow-developer-reference.md)：ホスト、公開設定、エラー、サンプルアプリ
* [REST APIで認証する](https://docs.roboflow.com/reference/ja/platform/rest-api/authenticate-with-the-rest-api.md)
