getUsers

獲取由公司、組和用戶角色句柄指定的用戶陣列。 此操作允許您按字元對返回的用戶進行排序和篩選。

授權用戶類型

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin
名稱 類型 必要 說明
包括非活動 xsd:boolean 包括或排除非活動用戶。 非IPS管理員用戶必須是至少一家公司的活動成員,才能被授權進行任何API調用。 如果用戶沒有有效的公司成員資格,則返回授權錯誤。
includeInvalid xsd:boolean 允許您包括/排除無效用戶。
companyHandleArray types:HandleArray 按公司篩選結果。
groupHandleArray types:HandleArray 按組篩選結果。
userRoleArray types:StringArray 按用戶角色篩選結果。
charFilterField xsd:string 按欄位的字串前置詞篩選結果(請參見 Trash State).
char篩選器 xsd:string 按特定字元篩選結果。
排序依據 xsd:string 用戶排序欄位的選擇。
記錄每頁 xsd:int 返回每頁指定的記錄數。
結果頁 xsd:int 結果頁面。

輸出(getUsersReturn)

名稱 類型 必要 說明
用戶陣列 types:UserArray 一組用戶。

範例

此代碼示例返回多個可選參數的用戶陣列。 用戶角色、用戶字元篩選器欄位和用戶排序欄位是使用特定字串常數確定的。

請求

<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>

本頁內容