Assignment Target 조회
- 인쇄
- PDF
Assignment Target 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Assignment Target 목록을 조회합니다.
요청
- GET /assignments/{assignmentId}/targets
요청 Path
| 파라미터 | 필수여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| assignmentId | Y | String | Assignment Id |
요청 파라미터
| 파라미터 | 필수여부 | 타입 | 제약사항 | 설명 |
|---|---|---|---|---|
| targetType | Y | String | user, group | target type |
| page | N | int | - 페이지 번호 기본값: 0 | |
| size | N | int | - 결과 목록 크기 기본값: 20 |
응답
응답 바디 (targetType: user)
{
"page" : "integer",
"totalPages" : "integer",
"totalItems" : "integer",
"hasPrevious" : "boolean",
"hasNext" : "boolean",
"items" : [ {
"userId" : "string",
"loginId" : "string",
"nrn" : "string",
"userProfile" : {
"firstName" : "string",
"lastName" : "string",
"email" : "string",
"emailVerified" : "boolean",
"empNo" : "string",
"phoneCountryCode" : "string",
"phoneNo" : "string",
"phoneNoVerified" : "boolean",
"deptName" : "string"
},
"accessRules" : {
"consoleAccessAllowed" : "boolean",
"apiAccessAllowed" : "boolean"
},
"status" : "string",
"description" : "string",
"lastLoginAt" : "string",
"createdAt" : "string",
"updatedAt" : "string"
} ],
"isFirst" : "boolean",
"isLast" : "boolean"
}
| 파라미터 | 타입 | 설명 | 제약사항 |
|---|---|---|---|
| page | Number | page (required) 반환 받은 결과의 page | |
| totalPages | Number | totalPages (required) 반환 받은 결과의 totalPage | |
| totalItems | Number | totalItems (required) 반환 받은 결과의 totalItems | |
| hasPrevious | Boolean | hasPrevious (required) 현재 페이지 기준으로 이전 페이지 존재 여부 | |
| hasNext | Boolean | hasNext (required) 현재 페이지 기준으로 다음 페이지 존재 여부 | |
| isFirst | Boolean | isFirst (required) 전체 페이지 기준으로 현재 페이지가 처음 페이지인지 여부 | |
| isLast | Boolean | isLast (required) 전체 페이지 기준으로 현재 페이지가 마지막 페이지인지 여부 | |
| items.[].userId | String | 유저 아이디 | |
| items.[].loginId | String | 로그인 아이디 (email) | |
| items.[].nrn | String | 생성된 유저 nrn | |
| items.[].userProfile | Object | User profile | |
| items.[].userProfile.firstName | String | 이름 | |
| items.[].userProfile.lastName | String | 성 | |
| items.[].userProfile.email | String | 이메일 | |
| items.[].userProfile.emailVerified | Boolean | 이메일 검증 여부 | |
| items.[].userProfile.empNo | String | 사원 번호 | |
| items.[].userProfile.phoneCountryCode | String | 핸드폰 번호 국가 번호 | |
| items.[].userProfile.phoneNo | String | 핸드폰 번호 | |
| items.[].userProfile.phoneNoVerified | Boolean | 핸드폰 번호 검증 여부 | |
| items.[].userProfile.deptName | String | 부서명 | |
| items.[].accessRules | Object | 접근 규칙 | |
| items.[].accessRules.consoleAccessAllowed | Boolean | 콘솔 접근 허용 여부 | |
| items.[].accessRules.apiAccessAllowed | Boolean | API 접근 허용 여부 | |
| items.[].status | String | 유저 상태 (active, suspended, deleted) | |
| items.[].lastLoginAt | String | 최종 로그인 일시 (UTC, ex. 2023-04-25T13:11:50Z) | |
| items.[].createdAt | String | 생성 일시 (UTC, ex. 2023-04-25T13:11:50Z) | |
| items.[].updatedAt | String | 수정 일시 (UTC, ex. 2023-04-25T13:11:50Z) | |
| items.[].description | String | 유저 설명 |
응답 바디 (targetType: group)
{
"page" : "integer",
"totalPages" : "integer",
"totalItems" : "integer",
"hasPrevious" : "boolean",
"hasNext" : "boolean",
"items" : [ {
"groupId":"String",
"groupName":"String",
"nrn":"String",
"createdAt":"String",
"updatedAt":"String",
"description":"String"
}
],
"isFirst" : "boolean",
"isLast" : "boolean"
}
| 파라미터 | 타입 | 설명 | 제약사항 |
|---|---|---|---|
| page | Number | page (required) 반환 받은 결과의 page | |
| totalPages | Number | totalPages (required) 반환 받은 결과의 totalPage | |
| totalItems | Number | totalItems (required) 반환 받은 결과의 totalItems | |
| hasPrevious | Boolean | hasPrevious (required) 현재 페이지 기준으로 이전 페이지 존재 여부 | |
| hasNext | Boolean | hasNext (required) 현재 페이지 기준으로 다음 페이지 존재 여부 | |
| isFirst | Boolean | isFirst (required) 전체 페이지 기준으로 현재 페이지가 처음 페이지인지 여부 | |
| isLast | Boolean | isLast (required) 전체 페이지 기준으로 현재 페이지가 마지막 페이지인지 여부 | |
| items.[].groupId | String | 그룹 아이디 (UUID) | |
| items.[].tenantId | String | 테넌트 아이디 | |
| items.[].groupName | String | 그룹 이름 | |
| items.[].nrn | String | 그룹 nrn | |
| items.[].description | String | 그룹 설명 | |
| items.[].createdAt | String | 생성 일시 (UTC, ex. 2023-04-25T13:11:50Z) | |
| items.[].updatedAt | String | 수정 일시 (UTC, ex. 2023-04-25T13:11:50Z) | |
| items.[].relationCreatedAt | String | 수정 일시 (UTC, ex. 2023-04-25T13:11:50Z) |
에러
아래 에러 코드는 이 액션(Action)에서 특징적으로 발생하는 에러입니다. 에러 응답 형식은 ErrorResponse를 참고해 주십시오.
공통적으로 발생하는 에러에 대한 상세한 설명은 NAVER Cloud Platform API를 참조해 주십시오.
| HTTP status code | 에러 코드 | 에러 메시지 |
|---|---|---|
| 400 | 400 | 잘못된 요청 |
| 400 | 9080 | Assignment가 존재하지 않음 |
이 문서가 도움이 되었습니까?