post https://auth.mimi.fd.ai/v2/token
アプリケーションまたはクライアント権限でアクセストークンを発行する
API 実行時に指定するスコープ
発行するアクセストークンで利用可能とするサービスのスコープをセミコロン区切りで指定します。最後に指定するスコープに続けてのセミコロンは不要です。
スコープについてはドキュメントの 権限とスコープ および API Reference のスコープ一覧を参照ください。
クライアントの種類
ドキュメント 基本概念に記載の "アプリケーション" と "クライアント" の説明を参照ください。
アクセストークン取得 API リクエスト時のクライアント(以降 "リクエストクライアント" と記載する)には、上記概念で説明しているところの "アプリケーション" と "クライアント" が指定可能です。
クライアントの種類と API のパラメータに指定する値
アクセストークンを取得する API のリクエストクライアント次第で API のパラメータ grant_type
、client_id
に指定する値が異なります。
【リクエストクライアントが "アプリケーション" である場合】
- grant_type に指定する値:
https://auth.mimi.fd.ai/grant_type/application_credentials
- client_id に指定する値:
<アプリケーションID>
【リクエストクライアントが "クライアント" である場合】
- grant_type に指定する値:
https://auth.mimi.fd.ai/grant_type/client_credentials
- client_id に指定する値:
<アプリケーションID>:<クライアントID>
※ 半角コロン(:
)区切りでひとつのテキストとして指定する
シークレットの取得
リクエストクライアントがアプリケーションのシークレットの取得
ドキュメント アプリケーションシークレットの発行を参照ください。
リクエストクライアントがクライアントのシークレットの取得
ドキュメント クライアントシークレットの発行
または
API Reference クライアントシークレットを発行する
を参照ください。
応答
応答ヘッダ (Response Headers)
キー | 内容 |
---|---|
content-type | application/json |
応答例
本ページの応答例( 本ページ右 "RESPONSE" で "200 - Result" を選択)を参照ください。
応答ボディ (Response Body)
各要素の型は本ページの "RESPONSES" を参照ください。
( resonse ステータス "200" をクリック)
キー | 内容 |
---|---|
code | HTTPレスポンス ステータスコード |
error | エラー発生時、エラー事由 |
status | ステータス。成功=success, 失敗=error, 受付済=acceptedなど。 |
progress | プログレス。進捗率(%) |
kind | オペレーション種別 |
accessToken | アクセストークン |
expires_in | アクセストークンの有効期限 |
operationId | オペレーションID |
selfLink | このオペレーションリソースを示すURI。現在、オペレーションリソースに対する GET は未実装。 |
targetLink | このオペレーションによって影響を受けたリソースを示す URI |
startTimestamp | 実行開始時刻(unixtime) |
endTimestamp | 実行終了時刻(unixtime) |