Viewing assignment list
- Print
- PDF
Viewing assignment list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
You can view the list of assignments.
Requests
- GET /assignments
Request parameters
| Parameters | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| searchColumn | N | String | assignmentName | - Search column assignmentName |
| searchWord | N | String | Search keyword | |
| page | N | int | - Page number Default: 0 | |
| size | N | int | - Number of results Default: 20 |
Responses
Response bodies
{
"page": "integer",
"totalPages": "integer",
"totalItems": "integer",
"hasPrevious": "boolean",
"hasNext": "boolean",
"items": [
{
"assignmentId": "String",
"assignmentName": "String",
"description": "String",
"nrn": "String",
"status": "String",
"iamRoleNrn": "String",
"createdAt": "String",
"updatedAt": "String",
"accountMbrNo": "String",
"accountName": "String",
"accountAlias": "String",
"permissionSetId": "String",
"consoleAccessAllowed": "String",
"consoleAccessRestricted": "String",
"apiAccessAllowed": "String",
"apiAccessRestricted": "String"
}
],
"isFirst": "boolean",
"isLast": "boolean"
}
| Parameters | Type | Description | Restrictions |
|---|---|---|---|
| page | Number | Page of the returned result (required) | |
| totalPages | Number | totalPage of the returned result (required) | |
| totalItems | Number | totalItems of the returned result (required) | |
| hasPrevious | Boolean | Whether the current page has a previous page (required) | |
| hasNext | Boolean | Whether the current page has a next page (required) | |
| isFirst | Boolean | Whether the current page is the first page (required) | |
| isLast | Boolean | Whether the current page is the last page (required) | |
| items.[].assignmentId | String | Assignment ID | |
| items.[].assignmentName | String | Assignment name | |
| items.[].description | String | Assignment description | |
| items.[].nrn | String | Assignment nrn | |
| items.[].status | String | Assignment status | active, suspend |
| items.[].iamRoleNrn | String | IAM Role nrn | |
| items.[].createdAt | String | Creation time (UTC, e.g., 2023-04-25T13:11:50Z) | |
| items.[].updatedAt | String | Edit time (UTC, e.g., 2023-04-25T13:11:50Z) | |
| items.[].accountMbrNo | Number | Account number | |
| items.[].accountName | String | Account name | |
| items.[].accountAlias | String | Account alias | |
| items.[].permissionSetId | String | PermissionSet ID | |
| items.[].consoleAccessAllowed | Boolean | Whether console access is allowed | |
| items.[].consoleAccessRestricted | Boolean | Whether console access is restricted | |
| items.[].apiAccessAllowed | Boolean | Whether API access is allowed | |
| items.[].apiAccessRestricted | Boolean | Whether API access is restricted |
Errors
Errors that may occur while using this action are listed below. For error response format, see ErrorResponse.
For more information on common errors, see NAVER Cloud Platform API.
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | Invalid request |
Was this article helpful?