Top > 開発者資料 > REST APIやWebDAVの認証方法

認証について

認証は現時点でBASIC認証のみ利用可能である。

WebDAVアクセスの認証BASIC認証
REST APIBASIC認証に加え、API-KEYが必須(下記を参照)

BASIC認証

すべてのアクセスは、SSL(TLS v1.2以降)が必須となる。

ユーザIDとパスワードは次の方法で認証を行うことができる。

BASIC認証
HTTPのRequest Header、Authorization:を使う方式。preemptiveモードでもnonpreemptiveモードのどちらも対応可。

認証必須領域

WebDAV領域では、各ノードサーバの下記のパス以下が、BASIC認証対象となる。

REST APIは、一部を除き、基本認証必須となる。

 

(※)BASIC認証以外の認証方式について

現在、ほとんどのWebDAVクライアントが対応しているのはBASIC認証であるが、将来に及ぶ認証方式としては十分なものと言い切れない。

たとえばユーザは、WebDAVのクライアントアプリを使う際、必ず自分のIDとパスワードをクライアントアプリに登録する必要がある。このIDとパスワードはTeraCLOUDの場合は、TeraCLOUD自体のログインと同じである為、アプリケーションデベロッパーは、IDとパスワードの保存エリアを気をつける必要が出てしまう。

そのため、将来のTeraCLOUDではOpenID Connect(OAuth2)の対応や、BASIC認証をオプショナル(各ユーザが、自分で有効にする必要がある機能)にすることを予定している。

REST APIアクセスに必要なクレデンシャル

REST APIにアクセスするためには、2つのクレデンシャルを必要とする。この2つが適合して正しいとき、初めてAPIが利用可能となる。

ユーザのID、パスワード
ユーザを決めるもの。BASIC認証などで利用する。通常のWebDAVでの認証と同じ形式。
API KEY
アプリケーション毎に決められたユニークなキー。ラベリングのために利用する。

API KEYの取得

API KEYは申請が必要で、アプリケーションデベロッパーは、対応アプリ登録申請フォームから申し込みができる。

若干の審査が行われるが、法人、個人、オープンソースなど、どのような開発者でも構わない。

技術的に言えば、API KEYはアプリケーション側に埋める必要があるため、実際に保護対象にすることはできない。オープンソースなどであれば、githubなどにコミットされることもあると考えられるものなので、このAPI KEYはあくまで、紳士協定的に、アプリケーションを、名乗るための仕組みと考えて良い。

将来、アプリケーションデベロッパーからの申し出に基づき、API KEYを無効化したり、ユーザが個々で固有のAPI KEYの無効化機能の実装が予定されている。

API KEYの与え方

API KEYは、次のどちらかの方法で送信する必要がある。

HTTP Request Headerで送る方式
HTTPのRequest Headerで送る方式。
Request Headerに、X-TeraCLOUD-API-KEY:を添えて送る。全てのREST APIで利用することができる。
MatrixParamで送る方式
URL上のMatrix Parameterで送る方法。
URLの必要な箇所に、api_key=を添えて送る。全てのREST APIで利用することができる。

TeraCLOUDのREST InterfaceはあくまでもHTTPSでの通信となるため、特殊なREST Clientスタックを必要としない。しかし、利用する言語、ライブラリ・スタック、アプリケーションプログラマの開発手法によって、容易なアクセス方法は異なると考えられる為、現時点では上記2つの方法でのアクセスを選ぶことができる。

その他の情報

API KEYのフォーマット
128ビットを16進数、大文字のBINHEXで送信する。
有効期間
そのリクエストのみ。
 
アカウント作成(無料 10GB)

1分で簡単登録!今すぐスタート!
Works online, Windows, Mac, iOS and Android