Sm_PolicyApi_CreateUserDir()

目次
casso127jpjp
目次
新規
CA Single Sign-on
ユーザ ディレクトリ オブジェクトをグローバル範囲で作成します。
pstructUserDir
構造にユーザ ディレクトリの属性が含まれています。
ユーザ ディレクトリ オブジェクトが存在し、
bUpdate
フラグが「真」の場合、アイテムが更新されます。
Type
ユーザ ディレクトリ関数、グローバル範囲。
構文
int SM_EXTERN Sm_PolicyApi_CreateUserDir (
void*pSessionHandle,
Sm_PolicyApi_UserDir_t*pstructUserDir,
const boolbUpdate
);
パラメータ
I/O
説明
pSessionHandle
I
内部ポリシー管理 API データ構造体へのポインタ。この構造体は、管理者セッションおよびクライアント セッションに関する情報を保持します。
pstructUserDir
I
値の入力が完了しているユーザ ディレクトリ構造へのポインタです。
bUpdate
I
既存のオブジェクトが見つかる場合にそれが更新されることを示すフラグです。
SM_PolicyAPI_UserDir_t フィールドの使用
ユーザ ディレクトリの異なるタイプに対して Sm_PolicyApi_CreateUserDir() が使用する SM_PolicyAPI_UserDir_t フィールドを以下の表に示します。
フィールド
ユーザ ディレクトリのタイプ
ODBC
LDAP
Windows NT
カスタム
pszOid
更新されているユーザ ディレクトリのオブジェクト識別子
X
X
X
X
pszName
必須フィールド
X
X
X
X
pszDesc
X
X
X
X
pszNamespace
必須フィールド
ODBC
LDAP
Windows NT
カスタム
pszServer
必須フィールド
ODBC データ ソース
IP アドレス
NT ドメイン名
共有ライブラリの名前
pszODBCQuerySchemeOid
必須フィールド
X
pszSearchRoot
X
パラメータ文字列
pszUserLookupStart
X
pszUserLookupEnd
X
bRequireCredentials
X
X
X
X
pszUsername
bRequireCredentials
が「真」の場合、必須フィールド。
X
X
X
X
pszPassword
bRequireCredentials
が「真」の場合、必須フィールド。
X
X
X
X
nSearchResults
X
検索の上限
nSearchScope
X
nSearchTimeout
X
タイムアウトの上限
bSecureConnection
X
X
pszDisabledAttr
X
X
(異なる)
pszUniversalIDAttr
X
X
X
(異なる)
pszAnonymousId
X
(異なる)
pszPasswordData
X
X
(異なる)
pszPasswordAttribute
X
X
(異なる)
pszEmailAddressAttr
pszChallengeRespAttr
X
(異なる)
注:
カスタム ディレクトリで、「異なる」と表示されているフィールドは、作成されるユーザ ディレクトリ オブジェクトに適用できる場合と適用できない場合があります。
戻り値
  • Sm_PolicyApi_Success。ユーザ ディレクトリが正常に作成されました。
  • Sm_PolicyApi_Failure。ユーザ ディレクトリが正常に作成されませんでした。
  • Sm_PolicyApi_NoSession。有効な管理者セッションがありません。
  • Sm_PolicyApi_InvalidHandle。このコールに先立つ有効な初期化はありませんでした。
  • Sm_PolicyApi_NoPrivilege。管理者には、ユーザ ディレクトリを作成する権限がありません。
  • Sm_PolicyApi_InvalidOid:
    • 指定された OID でのユーザ ディレクトリ タイプは見つかりませんでした。
    • ユーザ ディレクトリ OID を見つけることができません。これは、この関数が呼び出されるとき bUpdate の設定が「真」であり、
      pszOid
      が更新中のユーザ ディレクトリの OID を保持する場合に生じます。
    • ODBC ユーザ ディレクトリを作成中です。OCBC クエリ方式の OID が見つかりませんでした。
  • Sm_PolicyApi_NotUnique。同じ名前のユーザ ディレクトリが存在します。
  • Sm_PolicyApi_MissingProperty。必須フィールドの 1 つが設定されていません。