Cisco MediaSense 開発者ガイド リリース 11.0(1)
ユーザ認証 API
ユーザ認証 API

ユーザ認証 API

はじめに

MediaSense を利用すると、サードパーティの開発者は、サードパーティ製アプリケーションにそれ自体の認証を許可するアプリケーション ユーザを構成できます。 MediaSense API へのすべてのアクセスで認証が必要です。 アプリケーションの最初の手順はそれ自体を認証することです。 認証が成功すると、JSESSION トークンが返されます。 このトークンは、アプリケーションがサインアウトするまで、すべての後続要求で渡す必要があります。 JSESSIONID も signOut API 要求で必要です。

サードパーティ製のアプリケーションがプライマリ サーバとセカンダリ サーバの両方に API 要求を発行するように設計されていれる場合、各ノードに個別にサインインする必要があり、対応する JSESSIONID と要求を返したサーバを常に使用します。

JSESSIONID は、ユーザがログアウトしたときか、または非アクティブになってから 30 分後(いずれか早いほう)に期限切れになります。

要求がブラウザから発信される場合、そのブラウザが自動的にクライアントのセッションを処理します。


(注)  


クライアントがサードパーティ製クライアントにログインし、MediaSense プラットフォームを使用するとき、サードパーティ製ソフトウェアは、そのソフトウェア アプリケーションが指図する認証を実行する必要があります。


signIn

ユーザ認証とログインにこの API を使用します。API は、特定のユーザ名とパスワードの認証を確認します。 ログインが正常に完了すると、JSESSIONID が HTTP 応答ヘッダーの Cookie として返されます。 この JSESSIONID は認証のトークンとして機能し、後続のすべての要求で渡す必要があります。 ログインに成功すると、API は、API の JSON 応答に含まれている、管理者が設定したパラメータのコンフィギュレーション データベースを確認します。 管理者によって設定されていないパラメータは、JSON 応答から除外されます。

URI

https://<host>:<port>/ora/authenticationService/authentication/signIn

HTTP メソッド

POST

パラメータ(Parameters)

  • archiveSearchEnabled:ブール。 値が true の場合、MediaSense Search and Play でアーカイブ検索が有効になっています。

  • authenticationProviders:文字列のオプション入力アレイ。 ユーザ認証に使用するサービスの識別子。 列挙値は次のとおりです。
    • AXL

    • Finesse

    このパラメータが指定されていない場合、システムは上記の順序でプロバイダーと認証を試み、最初の認証が成功すると戻ります。

  • firstNameDisplayConfig:ブール。 値が true の場合、詳細検索のフィールドとして名が表示されます。これは MediaSense Search and Play のエージェント情報の一部として表示されます。

  • inbrowserPlaybackEnabled:ブール。 MediaSense Search and Play でブラウザ内再生が有効になっています。

  • lastNameDisplayConfig:ブール。 値が true の場合、詳細検索のフィールドとして姓が表示されます。これは MediaSense Search and Play のエージェント情報の一部として表示されます。

  • lineNameDisplayConfig:ブール。 値が true の場合、詳細検索のフィールドとして Unified Communications Manager の回線名が表示されます。これは MediaSense Search and Play のエージェント情報の一部として表示されます。

  • loginIdDisplayConfig:ブール。 値が true の場合、詳細検索のフィールドとしてログイン ID が表示されます。これは MediaSense Search and Play のエージェント情報の一部として表示されます。

  • loginNameDisplayConfig:ブール。 値が true の場合、詳細検索のフィールドとしてログイン名が表示されます。これは MediaSense Search and Play のエージェント情報の一部として表示されます。

  • password:必須入力文字列。 MediaSense ユーザとしてプロビジョニングされる Unified Communications Manager ユーザのパスワード。 すべての Unified Communications Manager パスワード制限が適用されます。 Unified Border Element が SSH 認証を使用するため、MediaSense はすべての MediaSense ユーザに対し Unified Communications Manager 認証を使用します。 大文字と小文字が区別されます。

  • username:必須入力文字列。 MediaSense ユーザとしてプロビジョニングされる Unified Communications Manager ユーザのユーザ名。 MediaSense が username(大文字と小文字の区別なし)を使用するのに対し、Unified Communications Manager は「User ID」を使用します。 すべての Unified Communications Manager ユーザ ID の制限が適用されます。 Unified Border Element が SSH 認証を使用するため、MediaSense はすべての MediaSense ユーザに対し Unified Communication Manager 認証を使用します。


(注)  


API ユーザのパスワードが Unified Communications Manager で変更されたとき、MediaSense でその変更が反映されるまで数分かかる場合があります。 成功応答は、cookie 内で JSESSIONID も返します。


例 1

ポート 8440 でサーバ 10.194.118.1 にユーザ名「myUser」とパスワード「cisco」でユーザをログインするには:

認証プロバイダーが指定されていないため、この要求は、AXL と Finesse を含む、考えられるすべての構成済み認証プロバイダーに対して認証を試みます。

HTTPS POST:

https://10.194.118.1:8440/ora/authenticationService/authentication/signIn 

ヘッダー:

Content-Type: application/json

ボディ:

{
   "requestParameters": {
                            "username":"myUser",
                            "password":"cisco"
                      }
}

例 2

ポート 8440 でサーバ 10.194.118.1 にユーザ名「myUser」とパスワード「cisco」で Finesse スーパーバイザをサインインするには:

HTTPS POST:

https://10.194.118.1:8440/ora/authenticationService/authentication/signIn 

ヘッダー:

Content-Type: application/json

本体

{
   "requestParameters": {
                            "username":"myUser",
                            "password":"cisco"
                        },
                      "authenticationProviders": ["FINESSE"]

}

例 3:応答パラメータ

{
    "responseMessage": "Success: Your request was successfully completed.",
    "responseCode": 2000,
    "inbrowserPlaybackEnabled": "true",          
    "lineNameDisplayConfig": "true",    
    "archiveSearchEnabled": "true",
    "agentDataDisplayConfig": {
        "loginNameDisplayConfig": "true",
        "loginIdDisplayConfig": "true",
        "lastNameDisplayConfig": "true",
        "firstNameDisplayConfig": "true"
    }
}

signOut

この API はユーザを MediaSense からログアウトするために使用されます。 ユーザはサインアウトするために JSESSIONID 以外のパラメータを必要としません。

URI

https://<host>:<port>/ora/authenticationService/authentication/signOut

HTTP メソッド

POST

要求パラメータ

なし

前にサインインしたユーザをサインアウトするには:

HTTPS POST:

https://10.194.118.1:8440/ora/authenticationService/
authentication/signOut

ヘッダー:

JSESSIONID: <the jsessionId received from a previous 
signIn request>

Content-Type: application/json

JSESSIONID で識別されたユーザがログアウトされます。