権限とスコープ

権限の階層

mimi の API 権限は、"デベロッパー"、"アプリケーション"、"クライアント" という3つの階層で管理されています。
それぞれの概念が持つ権限と、主な役割は以下の通りです。

  • デベロッパー権限(最上位)
    • すべての管理権限を持ちます。自身に属するすべてのアプリケーション、クライアントの作成、およびそのリソース(クライアント情報など)を操作できます。
  • アプリケーション権限(中間層)
    • 自身のリソースの参照、自身が管理するクライアントの操作、および許可されたサービスの利用が可能です。
  • クライアント権限(最下層)
    • 自身のリソースの参照と許可されたサービスの利用が可能です。

このページでは、これらの権限で利用できる具体的な「スコープ」について詳しく説明します。

スコープとは

mimi サービスにおけるスコープとは "mimi が提供する各サービス利用の際に認証/認可の対象とするサービスの識別の範囲" を指し、URI 形式で定義しています。
mimi が提供する各種サービスにはそれぞれスコープとして URI が割り振られています(スコープ一覧ページで確認できます)。

・スコープとアクセストークン

mimi の各種サービスを利用する際には "ユーザーがそのサービスを利用できる状態にあるか" の認証/認可を必要とします。mimi の認証/認可では アクセストークン を利用します。そのアクセストークンで利用できる認可対象のサービスが何であるかを示す値がスコープです。利用者がアクセストークンの発行をリクエストする際にはスコープの 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/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

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