Sm_PolicyApi_GetUserContext()

ポリシー管理 API の呼び出し元によるユーザ コンテキスト情報へのアクセスを可能にします。
casso1283
ポリシー管理 API の呼び出し元によるユーザ コンテキスト情報へのアクセスを可能にします。
Type
ユーザ ディレクトリ関数、グローバル範囲。
構文
int SM_EXTERN Sm_PolicyApi_GetUserContext (
void*
pSessionHandle
,
const char*
lpszUserDirOid
,
const char*
lpszUserPath
,
const char*
lpszSessionID
,
Sm_PolicyApi_UserContext_t**
ppPolicyApiUserContext
);
);
パラメータ
I/O
説明
pSessionHandle
I
内部ポリシー管理 API データ構造体へのポインタ。この構造体は、管理者セッションおよびクライアント セッションに関する情報を保持します。
lpszUserDirOid
I
lpszUserPath
で指定したユーザのユーザ ディレクトリのオブジェクト識別子が含まれ、NULL で終わる文字列です。
lpszUserPath
I
ユーザの識別名。
lpszSessionID
I
セッションの一意の識別子。
ログインに成功した後、セッション ID が Sm_AgentApi_Session_t 構造体の
lpszSessionId
フィールドに返されます。
セッション ID が認識されない場合は、このパラメータに空の文字列 ("") を割り当てます。
ppPolicyApiUserContext
O
SiteMinder
が関数へ渡すユーザ コンテキスト情報。
 
注釈
この関数は、アプリケーションが基礎となるユーザ ディレクトリに接続する必要なしに、ユーザに関する情報にアクセスすることを可能にします。ユーザ情報を取得するには、アプリケーションは、Sm_Api_UserContext_t 構造で関数を呼び出し、それは ppPolicyApiUserContext で返されます。以下は例です。
  • ユーザ属性を取得または設定するには fGetProp or fSetProp を呼び出します。
  • ユーザ パスワードを確認するには fAuthenticate を呼び出します。
  • ディレクトリを検索し結果を検討し、正しいユーザが見つかったことを確認するには fGetProp を呼び出します。
  • ログイン ユーザでないユーザの属性を取得するには fGetProp を呼び出します。
Sm_GetUserContext() を呼び出した後、Sm_PolicyApi_FreeMemoryEx() を呼び出して割り当てられたメモリを解放します。そうしないと、一部のポリシー サーバのパフォーマンスが低下します。
戻り値
  • Sm_PolicyApi_Success。取得の操作が成功しました。
  • Sm_PolicyApi_Failure。取得の操作が成功しませんでした。
  • Sm_PolicyApi_NoSession。有効な管理者セッションがありません。
  • Sm_PolicyApi_Invalid。指定されたユーザまたはディレクトリは有効でありませんでした。
  • Sm_PolicyApi_InvalidHandle。このコールに先立つ有効な初期化はありませんでした。
  • Sm_PolicyApi_NoPrivilege。管理者には、ユーザ ディレクトリを取得する権限がありません。