사용자 API 검색
사용자 검색 API를 이용하여 Control Room의 모든 사용자를 검색합니다.
전제 조건
사용자 보기 권한을 가진 관리자 역할 또는 맞춤형 역할이 있어야 합니다.
프로시저
- 요청 헤더에 인증 토큰을 추가합니다.
- 필터를 적용하여 웹페이지를 처리하기 위한 기본 조건부 쿼리 및 페이지 매김 제어 기능을 수행합니다. 필터링과 관련된 세 가지 기본 기능으로 필터링 조건, 열 정렬 및 페이지 매김 매개변수가 있습니다. API 요청 본문의 필터를 참고하십시오.
-
POST 메소드 및 엔드포인트 URL 이용:
<your_control_room_url>/v1/usermanagement/users/list
요청 본문:
{ "fields": [], "filter": { "operator": "and", "operands": [ { "operator": "substring", "field": "username", "value": "mdadmin" }, { "operator": "gt", "field": "createdOn", "value": "2020-09-01T00:00:00.989Z" }, { "operator": "lt", "field": "createdOn", "value": "2020-09-06T23:00:00.123Z" } ] } }
-
요청 전송.
다음 요청은
admin
을 포함하고 2020년 9월 1일에서 9월 6일 사이에 생성된사용자 이름
을 가진 모든 사용자를 찾습니다.응답 본문:{ "page": { "offset": 0, "total": 310, "totalFilter": 2 }, "list": [ { "id": 1513, "username": "mdadmin", "domain": "", "firstName": "MD_tester", "lastName": "MD_user", "version": 17, "principalId": 1513, "email": "md@aa.com", "emailVerified": true, "passwordSet": true, "questionsSet": true, "enableAutoLogin": false, "disabled": false, "clientRegistered": false, "description": "To be used for API testing", "createdBy": 1, "createdOn": "2020-09-01T11:01:17.760Z", "updatedBy": 1, "updatedOn": "2020-09-01T11:01:17.760Z", "licenseFeatures": [], "roles": [ { "id": 1, "name": "AAE_Admin" }, { "id": 2, "name": "AAE_Basic" } ], "deleted": false }, { "id": 1520, "username": "mt_admin", "domain": "", "firstName": "", "lastName": "", "version": 6, "principalId": 1520, "email": "a@a.com", "emailVerified": true, "passwordSet": true, "questionsSet": true, "enableAutoLogin": false, "disabled": false, "clientRegistered": false, "description": "", "createdBy": 1, "createdOn": "2020-09-02T08:47:19.723Z", "updatedBy": 1, "updatedOn": "2020-09-02T08:47:19.723Z", "licenseFeatures": [], "roles": [ { "id": 1, "name": "AAE_Admin" } ], "deleted": false } ] }
이 응답은
admin
,mdadmin
및mt_admin
이라는 단어가 포함된 사용자 두 사람의 이름에 대한 데이터를 반환했습니다.응답 매개변수:매개변수 이름 설명 id 사용자를 생성한 ID 번호로 시스템이 생성한 것. username 새 사용자의 사용자 이름. domain Active Directory의 도메인 이름. version 새 사용자에 대해 시스템이 생성한 버전 번호. email 새 사용자의 이메일 주소. passwordSet 문자열: 8-15자, a-z, A-Z, 0-9, @, -, _, !, #, $, %, &, 및 .(마침표). 새 사용자에 대한 비밀번호만 설정합니다. PrincipalId 새 사용자를 만든 Active Directory 주 사용자의 ID 번호로 시스템이 생성한 것. 권한 특정 권한 ID. licenseFeatures 이 역할과 연계된 Automation Anywhere 라이선스. Roles: id 이 사용자와 연계된 역할 ID 번호로, 시스템이 생성한 것. 모든 사용자에게 연결된 역할이 있는 것은 아님. createdBy 새 사용자를 생성한 관리자의 ID 번호로, 시스템이 생성한 것. updatedBy 사용자를 업데이트한 관리자의 ID 번호로, 시스템이 생성한 것. REST API는 HTTP 응답 코드를 이용하여 각 요청에 응답합니다. 응답 코드에 대한 자세한 내용은 API 응답 코드를 참고하십시오.