getUsers getusers
会社、グループ、およびユーザの役割のハンドルで指定されたユーザの配列を取得します。 この操作では、返されたユーザーを並べ替え、文字でフィルターできます。
認証済みユーザータイプ section-6a8f23cc6b22442d8776f701016971ed
IpsAdminIpsCompanyAdminTrialSiteAdminImagePortalAdmin
名前
種類
必須
説明
includeInactive
xsd:booleanいいえ
非アクティブなユーザーを含めるか除外します。 IPS 管理者以外のユーザーは、API 呼び出しをおこなう権限を持つ 1 つ以上の会社のアクティブなメンバーである必要があります。 ユーザーがアクティブな会社メンバーシップを持っていない場合、認証エラーが返されます。
includeInvalid
xsd:booleanいいえ
無効なユーザーを含める/除外できます。
companyHandleArray
types:HandleArrayいいえ
結果を会社でフィルタリングします。
groupHandleArray
types:HandleArrayいいえ
結果をグループでフィルターします。
userRoleArray
types:StringArrayいいえ
ユーザーの役割で結果をフィルタリングします。
charFilterField
xsd:stringいいえ
フィールドの文字列プレフィックスで結果をフィルタリングします ( Trash State).
charFilter
xsd:stringいいえ
特定の文字で結果をフィルタリングします。
sortBy
xsd:stringいいえ
ユーザーによる並べ替えフィールドの選択。
recordsPerPage
xsd:intいいえ
1 ページあたりの指定されたレコード数を返します。
resultsPage
xsd:intいいえ
結果ページ。
出力 (getUsersReturn)
名前
種類
必須
説明
userArray
types:UserArrayはい
ユーザーの配列。
例 section-bc43a5dd7b4c4f048d25fc881554dab2
このコードサンプルは、複数のオプションパラメーターのユーザーの配列を返します。 ユーザーの役割、ユーザーの文字フィルターフィールド、ユーザーの並べ替えフィールドは、特定の文字列定数を使用して決定されます。
リクエスト
<ns1:getUsersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:includeInvalid>false</ns1:includeInvalid>
<ns1:companyHandleArray>
<ns1:items>47</ns1:items>
</ns1:companyHandleArray>
<ns1:userRoleArray>
<ns1:items>IpsAdmin</ns1:items>
</ns1:userRoleArray>
<ns1:sortBy>LastName</ns1:sortBy>
</ns1:getUsersParam>
応答
<getUsersReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<userArray>
<items>
<userHandle>70|kmagnusson@adobe.com</userHandle>
<firstName>Kris</firstName>
<lastName>Magnusson</lastName>
<email>kmagnusson@adobe.com</email>
<role>IpsAdmin</role>
<isValid>true</isValid>
<passwordExpires>2107-07-27T15:18:15.816-07:00</passwordExpires>
</items>
...
</userArray>
</getUsersReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681