連絡先管理メソッド

この記事には、以下のトピックが含まれています。
casm173
この記事には、以下のトピックが含まれています。
このセクションでは、Web サービスの連絡先管理メソッドについて説明します。
login
login メソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
username
文字列
ユーザ ID を指定します。
password
文字列
パスワードを指定します。
説明
login は、CA SDM のログイン検証によりユーザを検証し、他のほとんどの Web メソッド コールに必要な一意のセッション ID を返します。 このキーはlogout()によって解放されます。 タイムアウトまで使用されない場合、SID の有効期限が切れる可能性があります。
CA SDM Web クライアントと同一のユーザ名およびパスワードであることが検証されます。検証方法は連絡先のアクセス タイプで指定します。 この関数のコールが成功すると、デフォルトのアクセス ポリシーが適用され、以降のすべてのアクセスが制御および管理されます。 ログイン ユーザ(デフォルトのポリシーに指定された代理連絡先ではない)が以降の Web サービス アクティビティの担当者になります。 ログイン ユーザには、すべてのファンクション グループ セキュリティおよびデータ パーティションが適用されます。
戻り値
以下の値が返されます。
パラメータ
タイプ
説明
<SID>
整数
ほかの Web サービス コールすべてで使用する一意の SID を示します。
loginService
loginService メソッドでは以下のパラメータを使用します。
パラメータ
タイプ
説明
username
文字列
ユーザ ID を指定します。
password
文字列
パスワードを指定します。
policy
文字列
(必須)ポリシー コードを指定します。平文で定義する必要があります。 このパラメータは必須ですが、空にもできます。
説明
従来のユーザ名/パスワード認証スキーマに従ってユーザをログインさせます。有効であれば、一意のセッション ID を返します。 このキーはlogout()によって解放されます。 タイムアウトまで使用されない場合、SIDの有効期限が切れる可能性があります。
ユーザ認証はユーザ名およびパスワードに対して行われます。アクセス コントロールは指定したポリシーに基づいて適用されます。 認証は、login() で説明したように行われます。 ポリシーが空の場合は、デフォルトのポリシーが自動的に適用されます。 ログイン ユーザ(ポリシーに指定された代理連絡先ではない)が以降の Web サービス アクティビティの担当者になります。 ログイン ユーザには、すべてのファンクション グループ セキュリティおよびデータ パーティションが適用されます。
戻り値
以下の値が返されます。
パラメータ
タイプ
説明
SID
整数
ほかの Web サービス コールすべてで使用する一意の SID を示します。
impersonate
impersonate メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
username
文字列
(必須)代理ユーザのユーザ名を指定します。
説明
追加のユーザ認証を行うことなく、現在の Web サービス セッションのすべての Web サービス アクティビティの担当ユーザを管理者が切り替えることができます。 このメソッドを呼び出せるのは、PKI アクセス認証スキーマを使用して現在の Web サービス セッションを開始していて、アクセス ポリシーに代理の許可を定義している場合に限られます。
代理ユーザのアクセス タイプは、現在の Web サービス セッションに使用されているポリシーの代理ユーザのアクセス タイプと照合されます。 新規ユーザのアクセス タイプの access_level が代理ユーザのアクセス タイプの grant_level と等しいかそれ以下である場合、このメソッドによって現在のユーザが新規ユーザに切り替えられます。 新しい Web サービス セッションが開始され、古いセッションが終了します。 その後、新しい
SID が返されます。 新規ユーザはこの新しいセッションでこれ以降に発生するすべてのアクティビティの担当者となります。 新規ユーザには、すべてのファンクション グループ セキュリティおよびデータ パーティションが適用されます。
戻り値
以下の値が返されます。
パラメータ
タイプ
説明
SID
整数
ほかの Web サービス コールすべてで使用する一意の SID を示します。
logout
logout メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
説明
login()、loginService()、および loginServiceManaged() で取得した SID を無効にします。
戻り値
なし。
loginWithArtifact
以下のパラメータが loginWithArtifact メソッドに適用されます。
パラメータ
タイプ
説明
userid
文字列
ユーザ ID を指定します。
artifact
文字列
CA EEM から取得したアーチファクトを識別します。
説明
提供される CA EEM アーチファクトによってユーザ認証を実行し、バックエンド サーバでセッションを開始します。 アーチファクトは、認証用に 1 回のみ使用できます。 返されたセッション ID(SID)は、後続の Web サービス メソッド呼び出しに使用できます。 アーチファクトは、CA EEM から直接取得できます。また、getArtifact メソッドによっても取得できます。
この操作を行うには、Service Desk と CA EEM が統合されている必要があります。
この SID は logout() によって解放されます。 タイムアウトまで使用されない場合、SIDの有効期限が切れる可能性があります。
戻り値
以下の値が返されます。
パラメータ
タイプ
説明
SID
文字列
ほかの Web サービス コールすべてで使用する一意のセッション ID(SID)を示します。 平文となっています。