UserApp サービス
この章では、DCNM Web サービスの、UserApp サービスに対応する API メソッドについて説明します。
UserApp サービスについて
この章では、ユーザ サービス機能によって公開される API を定義します。
bindUserToAllNetworkElements
すべてのネットワーク要素にユーザをバインドします。
パラメータ
opContext:動作コンテキスト
InstanceNameId:アプリケーション ユーザ
戻り値
void
bindUserToAllNetworkGroups
すべてのネットワーク グループにユーザをバインドします。
パラメータ
opContext:動作コンテキスト
InstanceNameId:アプリケーション ユーザ
戻り値
void
bindUserToNetworkElements
指定されたネットワーク要素にユーザをバインドします。
パラメータ
opContext:動作コンテキスト
InstanceNameId:アプリケーション ユーザ
InstanceNameId:ネットワーク要素のインスタンス ID のリスト
戻り値
void
bindUserToNetworkGroups
指定されたネットワーク グループにユーザをバインドします。
パラメータ
opContext:動作コンテキスト
InstanceNameId:アプリケーション ユーザ
InstanceNameId:ネットワーク グループのインスタンス ID のリスト
戻り値
void
createUsers
アプリケーション ユーザのリストに基づいてユーザを作成します。
パラメータ
opContext:動作コンテキスト
ApplicationUser:アプリケーション ユーザのリスト
戻り値
作成されたアプリケーション ユーザのリスト。
clearUserData
ApplicationUser の次のアソシエーションをクリアします。
• Preferences
• NetworkElementForApplicationUser
• NetworkElementGroupForApplicationUser
• NetworkElementUser
パラメータ
opContext:動作コンテキスト
ppUserInstanceNameIdCol:アソシエーションをクリアする必要のある ApplicationUser InstanceNameId のリスト
戻り値
void
deleteUsers
アプリケーション ユーザのリストに基づいてユーザを削除します。
パラメータ
opContext:動作コンテキスト
ApplicationUser:アプリケーション ユーザのリスト
戻り値
void
getAllUsers
すべてのアプリケーション ユーザのユーザ情報のリストを取得します。
パラメータ
opContext:動作コンテキスト
戻り値
ApplicationUser のリスト
getAllUsersWithUserData
次のいずれかのアソシエーションを持つアプリケーション ユーザだけを戻します。次に示すアソシエーションの読み込みも行います。
• Preferences
• NetworkElementForApplicationUser
• NetworkElementGroupForApplicationUser
• NetworkElementUser
パラメータ
opContext:動作コンテキスト
戻り値
いずれか 1 つのアソシエーションを持つ ApplicationUser のリスト
getCurrentUser
現在ログインしているユーザを戻します。
パラメータ
opContext:動作コンテキスト
戻り値
現在ログインしているユーザおよび読み込まれたそのユーザのロール。
getDefaultNetworkElementUserCredentials
デフォルト ネットワーク要素ユーザ資格情報を取得します。
パラメータ
opContext:動作コンテキスト
戻り値
NetworkElementUserCredentials
getNetworkElementGroupsForUser
指定されたユーザのネットワーク要素グループのリストを取得します。
パラメータ
opContext:動作コンテキスト
InstanceNameId:ユーザのインスタンス名 ID
戻り値
NetworkElementGroup のリスト
getNetworkElementsForUser
指定されたユーザのネットワーク要素のリストを取得します。
パラメータ
opContext:動作コンテキスト
InstanceNameId:ユーザのインスタンス名 ID
戻り値
AbstractNetworkElement のリスト
getPreferences
API を呼び出しているユーザのプリファレンスを戻します。
パラメータ
opContext:動作コンテキスト
戻り値
Preferences
getUserCredentialsForNetworkElementGroups
指定されたネットワーク要素グループのユーザ資格情報のリストを取得します。
パラメータ
opContext:動作コンテキスト
InstanceNameId:アプリケーション ユーザ
InstanceNameId:ネットワーク要素グループのリスト
戻り値
NetworkElementUserCredentials のリスト
getUserCredentialsForNetworkElements
指定されたネットワーク要素のユーザ資格情報のリストを取得します。
パラメータ
opContext:動作コンテキスト
InstanceNameId:アプリケーション ユーザ
InstanceNameId:ネットワーク要素のリスト
戻り値
NetworkElementUserCredentials のリスト
getUsers
指定されたアプリケーション ユーザのユーザ情報のリストを取得します。
パラメータ
opContext:動作コンテキスト
InstanceNameId:アプリケーション ユーザのリスト
戻り値
ApplicationUser のリスト
modifyDefaultNetworkElementUserCredentials
デフォルト ユーザ資格情報を指定された値に変更します。
パラメータ
opContext:動作コンテキスト
NetworkElementUserCredentials:ユーザ資格情報
戻り値
NetworkElementUserCredentials
modifyPreferences
API を呼び出しているユーザのプリファレンスを変更します。
パラメータ
opContext:動作コンテキスト
Preferences:ユーザ プリファレンス
戻り値
Preferences
modifyUserCredentialsForNetworkElementGroups
指定されたユーザおよびネットワーク要素グループの資格情報を変更します。
パラメータ
opContext:動作コンテキスト
InstanceNameId:変更するユーザ
InstanceNameId:変更するネットワーク要素グループのリスト
NetworkElementUserCredentials:ユーザ資格情報
戻り値
void
modifyUserCredentialsForNetworkElements
指定されたユーザおよびネットワーク要素の資格情報を変更します。
パラメータ
opContext:動作コンテキスト
InstanceNameId:変更するユーザ
InstanceNameId:変更するネットワーク要素のリスト
NetworkElementUserCredentials:ユーザ資格情報
戻り値
void
modifyUsers
指定されたリストのアプリケーション ユーザを変更します。
パラメータ
opContext:動作コンテキスト
ApplicationUser:ユーザのリスト
戻り値
void
unbindUserFromAllNetworkElements
指定されたユーザをすべてのネットワーク要素からアンバインドします。
パラメータ
opContext:動作コンテキスト
InstanceNameId:アンバインドするユーザ
戻り値
void
unbindUserFromAllNetworkGroups
指定されたユーザをすべてのネットワーク グループからアンバインドします。
パラメータ
opContext:動作コンテキスト
InstanceNameId:アンバインドするユーザ
戻り値
void
unbindUserFromNetworkElements
指定されたユーザをすべてのネットワーク要素からアンバインドします。
パラメータ
opContext:動作コンテキスト
InstanceNameId:アンバインドするユーザ
InstanceNameId:ネットワーク要素のリスト
戻り値
void
unbindUserFromNetworkGroups
指定されたユーザをすべてのネットワーク グループからアンバインドします。
パラメータ
opContext:動作コンテキスト
InstanceNameId:アンバインドするユーザ
InstanceNameId:ネットワーク グループのリスト
戻り値
void