ドキュメントAEMDynamic Media Image Production System API

getUsers getusers

最終更新日： 2024年7月22日

作成対象：

  • Developer
  • Admin

会社、グループ、ユーザーの役割ハンドルで指定されたユーザーの配列を取得します。 この操作では、返されたユーザーを並べ替え、文字でフィルタリングできます。

承認済みユーザータイプ section-6a8f23cc6b22442d8776f701016971ed

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin
名前
種類
必須
説明
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
いいえ
ページあたりの指定されたレコード数を返します。
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
dynamic-media-developer-resources-help-aem-ips-api