getUsers getusers

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

주제:

작성 대상:

개발자
관리자

회사, 그룹 및 사용자 역할 핸들에 의해 지정된 사용자 배열을 가져옵니다. 이 작업을 통해 반환된 사용자를 정렬하고 문자별로 필터링할 수 있습니다.

승인된 사용자 유형 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

아니요

특정 문자로 결과를 필터링합니다.

정렬 기준

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

4e9b9d8c-5839-4215-aa35-01b652869681