View assignment target
- Print
- PDF
View assignment target
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Views assignment target
Request
- GET /assignments/{assignmentId}/targets
Request path
| Parameters | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| assignmentId | Y | String | Assignment Id |
Request parameters
| Parameters | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| targetType | Y | String | user, group | target type |
| page | N | int | - Page number Default value: 0 | |
| size | N | int | - Size of result list Default value: 20 |
Response
Response bodies (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"
}
| Parameters | Type | Description | Restrictions |
|---|---|---|---|
| page | Number | page (required) returned result of page | |
| totalPages | Number | totalPages (required) returned result of totalPage | |
| totalItems | Number | totalItems (required) returned result of totalItems | |
| hasPrevious | Boolean | hasPrevious (required) indicates whether the previous page exists based on the current page | |
| hasNext | Boolean | hasNext (required) indicates whether the next page exists based on the current page | |
| isFirst | Boolean | isFirst (required) indicates whether the current page is recognized as the first page based on all pages | |
| isLast | Boolean | isLast (required) indicates whether the current page is recognized as the last page based on all pages | |
| items.[].userId | String | User ID | |
| items.[].loginId | String | Login ID (email) | |
| items.[].nrn | String | Created user nrn | |
| items.[].userProfile | Object | User profile | |
| items.[].userProfile.firstName | String | Name | |
| items.[].userProfile.lastName | String | Last name | |
| items.[].userProfile.email | String | ||
| items.[].userProfile.emailVerified | Boolean | Indicate email verification | |
| items.[].userProfile.empNo | String | Employee number | |
| items.[].userProfile.phoneCountryCode | String | Phone number country code | |
| items.[].userProfile.phoneNo | String | Phone number | |
| items.[].userProfile.phoneNoVerified | Boolean | Indicate phone number verification | |
| items.[].userProfile.deptName | String | Department name | |
| items.[].accessRules | Object | Access rule | |
| items.[].accessRules.consoleAccessAllowed | Boolean | Allow or deny console access | |
| items.[].accessRules.apiAccessAllowed | Boolean | Allow or deny API access | |
| items.[].status | String | User status (active, suspended, deleted) | |
| items.[].lastLoginAt | String | Last login date and time (UTC, ex. 2023-04-25T13:11:50Z) | |
| items.[].createdAt | String | Created date and time (UTC, ex. 2023-04-25T13:11:50Z) | |
| items.[].updatedAt | String | Edited date and time (UTC, ex. 2023-04-25T13:11:50Z) | |
| items.[].description | String | User description |
Response bodies (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"
}
| Parameters | Type | Description | Restrictions |
|---|---|---|---|
| page | Number | page (required) returned result of page | |
| totalPages | Number | totalPages (required) returned result of totalPage | |
| totalItems | Number | totalItems (required) returned result of totalItems | |
| hasPrevious | Boolean | hasPrevious (required) indicates whether the previous page exists based on the current page | |
| hasNext | Boolean | hasNext (required) indicates whether the next page exists based on the current page | |
| isFirst | Boolean | isFirst (required) indicates whether the current page is recognized as the first page based on all pages | |
| isLast | Boolean | isLast (required) indicates whether the current page is recognized as the last page based on all pages | |
| items.[].groupId | String | Group ID (UUID) | |
| items.[].tenantId | String | Tenant ID | |
| items.[].groupName | String | Group name | |
| items.[].nrn | String | Group nrn | |
| items.[].description | String | Group description | |
| items.[].createdAt | String | Created date and time (UTC, ex. 2023-04-25T13:11:50Z) | |
| items.[].updatedAt | String | Edited date and time (UTC, ex. 2023-04-25T13:11:50Z) | |
| items.[].relationCreatedAt | String | Edited date and time (UTC, ex. 2023-04-25T13:11:50Z) |
Errors
Errors that specifically occur while using this action are listed below. For error response format, see ErrorResponse.
For more information about common errors, see the NAVER Cloud Platform API.
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | 400 | Invalid request |
| 400 | 9080 | Assignment does not exist |
Was this article helpful?