GetAuthorisationDetails

<< 目次を表示 >>

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

GetAuthorisationDetails

外部ツールが必要とする認証形式を返します。

 

対応する形式は以下のいずれかです。

 

 

入力

パラメータ

説明

parameters

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

 

JSON形式の文字列です。将来の拡張のために用意されていて、値は含まれません。

 

 

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

 

 

詳細

認証が必要ない場合には、このメソッドに対して処理を行う必要はありません。

 

Enterprise Architectは、OAuth 2.0 Authorization Code Grantにのみ対応します。

 

OAuthを利用する場合には、Enterprise Architectはブラウザを開き、認証のページを開きます。'authorization endpoint URI'の値に従ってユーザーは認証を実行します。

 

OAuthプロバイダはEnterprise Architectに「コード」を戻します。そのコードはPostOAuthCodeで渡されます。

 

もし、OAuthが指定された場合に、ベーシック認証よりも優先度を高く対応します。

 

OAuthの場合には、authorizationEndpointURI および redirectURI の情報が必要です。

 

Enterprise Architectの場合には、redirectURI は"http://localhost:8888/oauth/callback" のみが利用可能です。

 

この値をOAuthプロバイダに渡す必要があります。

 

ベーシック認証の場合には、Enterprise Architectはユーザー名とパスワードの入力欄を表示します。入力された値を渡します。

 

 

実装例

 

基本認証:

 

AddProperty(index, "basic", "true");

 

 

OAuth:

 

AddProperty(index, "OAuthConfiguration", "true");

AddProperty(index, "authorizationEndpointURI", "https://example.com/oauth/authorize");

AddProperty(index, "redirectURI", "http://localhost:8888/oauth/callback");