SetAuthorisation

<< 目次を表示 >>

ページ位置:  プロジェクトの作成と管理 > Proクラウドサーバ > 有料ライセンスで利用できる機能 > 外部ツールとの連携 > 独自の連携プラグインの作成 > ISBPIIntegrationPluginインターフェース >

SetAuthorisation

入力

パラメータ

説明

parameters

  • C++: const char*
  • C#: string

 

JSON形式の文字列です。以下のフィールドを利用できます。

  • username
  • password
  • accessToken - OAuthのアクセストークン

 

 

コールバック経由の戻り値

[任意] LogMessage あるいは SetError - ユーザーからのフィードバックを戻します。

 

 

詳細

このメソッドは、Enterprise Architectでユーザーが入力した認証情報を受け取ります。

 

ユーザー名・パスワードか、OAuthのアクセストークンが渡されます。

 

Enterprise Architectは、各セッション(外部ツールとの連携開始・プロジェクトを開く・ユーザーを変更 など)の最初に SetAuthorisation メソッドを呼び出します。渡された値で外部ツールとの認証を実行してください。

 

渡される情報を内部で永続保持しないでください。一時的に保持することは構いません。

 

 

実装例

 

void ExampleIntegrationPlugin::SetAuthorisation(const char* parameters)

{

LogMessage(LOG_TRACE, __FUNCTION__);

 

Json::Value jsonParameters;

if (strlen(parameters))

{

std::stringstream(parameters) >> jsonParameters;

}

 

m_username = jsonParameters["username"].asString(); // If basic authorisation is used.

m_password = jsonParameters["password"].asString();

m_accessToken = jsonParameters["accessToken"].asString(); // If OAuth is used.

}