文档Dynamic Media Image Production System API

getUsers getusers

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • undefined
  • undefined

获取由公司、组和用户角色句柄指定的用户数组。 通过此操作，可对返回的用户进行排序并按字符进行筛选。

授权用户类型 section-6a8f23cc6b22442d8776f701016971ed

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin
名称
类型
必需
说明
includeInactive
xsd:boolean
否
包含或排除不活动的用户。 非IPS管理员用户必须是至少一个公司的活跃成员，才能获得发出任何API调用的授权。 如果用户没有活动的公司成员资格，则会返回授权错误。
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
否
每页返回指定的记录数。
结果页
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