権限とスコープ

スコープとは

mimi が提供する各サービス利用の際に認証/認可の対象とするサービスの識別に利用する URI です。

mimi の各種サービス を利用する際には "ユーザーがそのサービスを利用できる状態にあるか" の認証/認可を必要とします。mimi の認証/認可では アクセストークン を利用します。そのアクセストークンで利用できる認可対象のサービスが何であるかを示す値がスコープです。mimi が提供する各種サービスにはそれぞれスコープとして URI が割り振られており(スコープ一覧 )、利用者がアクセストークンの発行をリクエストする際にはスコープの URI を指定する必要があります。そうして発行されたアクセストークンを利用すると、指定したスコープに該当する mimi のサービスの利用が認可されます。

課金種別によって利用できるスコープと利用できないスコープがあります。複数のスコープを指定する場合は、通常 scope 文字列(=スコープの URI )同士をセミコロンで接続します。

"https://apis.mimi.fd.ai/auth/asr/websocket-api-service;https://apis.mimi.fd.ai/auth/asr/http-api-service;https://apis.mimi.fd.ai/auth/nict-tra/http-api-service;"

認証/認可 API 利用時の権限とスコープ

mimi 認証/認可 API を利用すると、各種権限の登録情報を操作できます。
mimi 認証/認可 API のスコープは利用者の権限によって付与できるスコープが異なります。

利用できるスコープについて権限別に表でまとめました。
どの権限でどの操作を実行したいかをふまえてスコープを指定し、アクセストークンの発行を行ってください。
発行されたアクセストークンで mimi 認証/認可 API の利用が可能となります。

略記:C(Create)、R(Read)、U(Update)、D(Delete)

デベロッパー権限でのみ利用可能なスコープ

スコープ説明
https://apis.mimi.fd.ai/auth/developer.rデベロッパーの読込(R)
https://apis.mimi.fd.ai/auth/developer.wデベロッパーの書込(CUD)
https://apis.mimi.fd.ai/auth/applications.rアプリケーションの読込(R)
https://apis.mimi.fd.ai/auth/applications.wアプリケーションの書込(CUD)

デベロッパー権限またはアプリケーション権限でのみ利用可能なスコープ

スコープ説明
https://apis.mimi.fd.ai/auth/applications.rアプリケーションの読込(R)
https://apis.mimi.fd.ai/auth/clients.rクライアントの読込(R)
https://apis.mimi.fd.ai/auth/clients.wクライアントの書込(CUD)

※ アプリケーション権限に基づき発行されたアクセストークンを使用して、アプリケーションを削除することはできません。

デベロッパー権限、アプリケーション権限、またはクライアント権限で利用可能なスコープ

スコープ説明
https://apis.mimi.fd.ai/auth/clients.rクライアントの読込(R)

※ クライアント権限に基づき発行されたアクセストークンを使用して、クライアントを削除することはできません。


What’s Next

スコープ・権限(認可タイプ)一覧については以下を参照してください。