ISSOTicket.RedeemTicket メソッド

 

RedeemTicket メソッドは、IssueTicket メソッドで以前に発行された Enterprise Single Sign-On (SSO) サーバー チケットを引き換えます。

構文

  
HRESULT RedeemTicket(  
BSTR bstrApplicationName,  
BSTR bstrTicket,  
LONG lFlags,  
BSTR* pbstrExternalUserName,  
SAFEARRAY BSTR  
);  

パラメーター

bstrApplicationName
[入力]アプリケーション名を指定する文字列。 このパラメーターには、NULL や空の文字列は指定できず、スペースを含めることもできません。 アプリケーション名では大文字と小文字は区別されませんが、大文字と小文字は保持されます。 たとえば、"ABC"、"abc"、"AbC" は同じアプリケーションと見なされます。

bstrTicket
[入力] IssueTicket メソッドから取得したチケット値を指定する文字列。

lFlags
[in] 設定するフラグを指定する long 整数。 資格情報のキャッシュをバイパスすることを示すには、SSO_FLAG_REFRESH フラグを使用します。

pbstrExternalUserName
[out]チケットに関連付けられている外部ユーザー名を受け取る文字列へのポインター。

BSTR
[out]チケットに関連付けられている外部資格情報を受け取る文字列。 資格情報がない場合、返される配列のサイズはゼロです。

戻り値

このプロパティは、正常に終了したかどうかを示す HRESULT を返します。 詳細については、「エラー値」セクションを参照してください。

エラー値

このメソッドは、次の表のいずれかの値を含む HRESULT を返します。

値	説明
S_OK	メソッドが成功しました。
E_ACCESSDENIED	呼び出し元へのアクセスは拒否されました。
E_INVALIDARG	無効なパラメーターが検出されました。

解説

このメソッドでは資格情報がプレーン テキストで返信されるため、呼び出し元は使用後にそれらを直ちにクリア (上書き) する必要があります。

このメソッドにアクセスするには、SSO 管理者、SSO 関連管理者、またはアプリケーション管理者である必要があります。

必要条件

プラットフォーム： Windows

参照

ISSOTicket インターフェイス (COM)
ISSOTicket メンバー
Enterprise Single Sign-On によるプログラミング