Sm_PolicyApi_AddSAMLScheme()
新規 SAML 2.0 認証方式オブジェクトを追加するか、または既存のものを変更します。この関数はまた、関連するアイデンティティ プロバイダのメタデータ プロパティを定義します。メタデータ プロパティは認証方式で保存されます。
casso1283
新規 SAML 2.0 認証方式オブジェクトを追加するか、または既存のものを変更します。この関数はまた、関連するアイデンティティ プロバイダのメタデータ プロパティを定義します。メタデータ プロパティは認証方式で保存されます。
Type
SAML 2.0 設定関数、グローバル範囲。
構文
int SM_EXTERN Sm_PolicyApi_AddSAMLScheme(void*pHandle,Sm_PolicyApi_Scheme_t*pstructScheme,Sm_PolicyApi_SAMLProviderProp_t*pProps,const boolbUpdate,char**pszErrMsg);
パラメータ | I/O | 説明 |
pHandle | I | 内部ポリシー管理 API データ構造体へのポインタ。この構造体は、管理者セッションおよびクライアント セッションに関する情報を保持します。 |
pstructScheme | I | 値の入力が完了している認証方式の構造体へのポインタです。 |
pProps | I | 認証方式と関連付けられた SAML 2.0 メタデータ プロパティです。 デフォルト値に関連付けられたプロパティに値を割り当てない場合、デフォルトが割り当てられます。 |
bUpdate | I | 更新操作を既存のオブジェクトで実行するかどうかを指定します。 |
pszErrMsg | O | 認証方式が正常に追加または更新されない場合に、エラー メッセージを含む文字列です。 ポリシー管理 API はこのパラメータに対してメモリを動的に割り当てます。Sm_PolicyApi_FreeString() の呼び出しによるメモリの解放は、カスタム アプリケーションで行います。 Sm_PolicyApi_MissingProperty または Sm_PolicyApi_InvalidProp が返される場合、このフィールドには欠落または無効のプロパティ名が含まれます。 |
戻り値
- Sm_PolicyApi_Success。SAML 2.0 認証方式の操作が成功しました。
- Sm_PolicyApi_Failure。SAML 2.0 認証の操作が成功しませんでした。
- Sm_PolicyApi_InvalidProp。指定されたプロパティは無効です。プロパティ名がpszErrMsgで返されます。
- Sm_PolicyApi_MissingProperty。必要なプロパティが指定されませんでした。プロパティ名がpszErrMsgで返されます。
- Sm_PolicyApi_InvalidHandle。このコールに先立つ有効な初期化はありませんでした。
- Sm_PolicyApi_NoSession。有効な管理者セッションがありません。
- Sm_PolicyApi_NoPrivilege。管理者には、SAML 2.0 認証方式を作成する権限がありません。
- Sm_PolicyApi_SAMLIDP_IncorrectParameters。指定された SAML プロバイダ プロパティが未完了か、または正しくありません。
- Sm_PolicyApi_SAMLIDP_ProviderIdNotUnique。指定された SAML プロバイダ ID は一意ではありません。