Sm_PolicyApi_DeleteAffiliate()
既存のアフィリエイトを削除します。
casso127jpjp
既存のアフィリエイトを削除します。
Type
フェデレーション関数
構文
int SM_EXTERN Sm_PolicyApi_DeleteAffiliate (void*pSessionHandle,const char*pszAffiliateOid);
パラメータ | I/O | 説明 |
pSessionHandle
| I | 内部ポリシー管理 API データ構造体へのポインタ。この構造体は、管理者セッションおよびクライアント セッションに関する情報を保持します。 |
pszAffiliateOid
| I | 既存のアフィリエイトのオブジェクト識別子が含まれ、NULL で終わる文字列です。 |
注釈
この関数は、Artifact プロファイルまたは POST プロファイルに基づいたアフィリエイト オブジェクトを削除します(Sm_PolicyApi_Affiliate_t フィールドの SAMLProfile を参照してください)。POST プロファイルに基づいてアフィリエイト オブジェクトを削除するには、SM_POLICY_API_VERSION_6_0_2 以上の API バージョンが必要です。それ以前のバージョンが含まれているとき関数で POST プロファイルに基づいてアフィリエイト オブジェクトを指定した場合、リクエストは失敗します。
戻り値
- Sm_PolicyApi_Success。アフィリエイトが正常に削除されました。
- Sm_PolicyApi_Failure。アフィリエイトが正常に削除されませんでした。
- Sm_PolicyApi_NoSession。有効な管理者セッションがありません。
- Sm_PolicyApi_InvalidHandle。このコールに先立つ有効な初期化はありませんでした。
- Sm_PolicyApi_NoPrivilege。管理者には、アフィリエイトを削除する権限がありません。
- Sm_PolicyApi_InvalidOid。アフィリエイト OID が見つかりませんでした。