searchUserGroup
認証情報マネージャ データベースからユーザ グループのリストを取得するには、searchUserGroup コマンドを使用します。ユーザが個々に指定されると、そのユーザが所属するグループのみが表示されます。
capamnew
認証情報マネージャ データベースからユーザ グループのリストを取得するには、searchUserGroup コマンドを使用します。ユーザが個々に指定されると、そのユーザが所属するグループのみが表示されます。
例
capam_command capam=capamServer adminUserID=admin cmdName=searchUserGroup UserGroup.ID=1
パラメータ
UserGroup.ID
指定された ID に一致するユーザ グループの結果をフィルタします。
必須 | デフォルト値 | 有効な値 |
いいえ | 該当なし | 文字列 |
UserGroup.name
指定された名前に一致するユーザ グループの結果をフィルタします。
必須 | デフォルト値 | 有効な値 |
いいえ | 該当なし | 文字列 |
UserGroup.description
指定された説明に一致するユーザ グループの結果をフィルタします。
必須 | デフォルト値 | 有効な値 |
いいえ | 該当なし | 文字列 |
UserGroup.userID
指定されたユーザが所属するユーザ グループの結果をフィルタします。
必須 | デフォルト値 | 有効な値 |
いいえ | 該当なし | 文字列 |
Page.Number
結果が複数のページに分割されている場合に戻るページを指定します。このパラメータは、Page.Size と連携して動作します。
必須 | デフォルト値 | 有効な値 |
いいえ | 1 | 数値 |
Page.Size
各ページに戻るには、レコードの数を指定します。
必須 | デフォルト値 | 有効な値 |
いいえ | 10000 | 数値 |
Sort.Property
結果の並べ替えに使用するフィールドを指定するには、Sort.Property を使用します。
必須 | デフォルト値 | 有効な値 |
いいえ | UserGroup.name | UserGroup.ID、UserGroup.name、UserGroup.description、UserGroup.userID、UserGroup.amUserGroupID |
Sort.Direction
Sort.Direction では、結果が表示される順序を指定します。昇順の場合は[
asc
]を、降順の場合は[desc
]を指定します。必須 | デフォルト値 | 有効な値 |
いいえ | asc | asc、desc |
UserGroup.amUserGroupID
UserGroup.amUserGroupID は、指定された AM ユーザ グループが属するユーザ グループの結果をフィルタします。
必須 | デフォルト値 | 有効な値 |
いいえ | 該当なし | 整数 |
UserGroup.includeInheritedCmGroups
UserGroup.includeInheritedCmGroups は UserGroupID パラメータのみと使用します。指定されたユーザではなく、直接および継承された CM ユーザ グループの両方を返します。
必須 | デフォルト値 | 有効な値 |
false | false | ブール値(true/false) |