Assign Entity to Role
- Print
- PDF
Assign Entity to Role
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Assign entities (servers, accounts) to roles.
API
- POST /roles/{roleNo}/entities
Requests
Path Variables
| Parameters | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| roleNo | Y | String | Role No |
Body
{
"roleEntityList": [
{
"id": "string",
"type": "string"
}
]
}
| Parameters | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| roleEntityList | Y | array | Role entity list | |
| roleEntityList.id | N | string | ||
| roleEntityList.type | N | string | Server, Service | |
| roleEntityList.entityId | N | integer | Deprecated | |
| roleEntityList.entityType | N | string | Deprecated |
Responses
- Responses
| Parameter name | Requirement status | Type | Description |
|---|---|---|---|
| ProcessResult | Y | Array | Processing result |
- Response examples - Success
[
{
"id": "entityId",
"name": "addEntity",
"success": true
}
]
- Response examples - entities not owned by a user
[
{
"success": false,
"id": "entityId",
"message": "This entity is not owned by an account."
}
]
- Response examples - already registered entity
[
{
"success": false,
"id": "entityId",
"message": "The entity is already registered."
}
]
Errors
Errors that may occur while using this action are listed below. For error response format, see ErrorResponse.
For more information about common errors, see NAVER Cloud Platform API.
| HTTP status code | Error code | Error message |
|---|---|---|
| 401 | 30 | Wrong roleNo |
| 404 | 910 | There are entities that don't fit the RoleType |
API
- POST /roles/{roleNo}/entities/account
Requests
Path Variables
| Parameters | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| roleNo | Y | String | Role No |
Body
{
"isMyAccount" : "boolean",
"accountName" : "string",
"loginId": "string"
}
| Parameters | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| isMyAccount | Y | boolean | My account (true), other main account (false) | |
| accountName | N | string | Username | |
| loginId | N | string | Login ID |
Responses
- Responses
| Parameter name | Requirement status | Type | Description |
|---|---|---|---|
| ProcessResult | Y | Array | Processing result |
- Response examples - Success
{
"success": true
}
Errors
Errors that may occur while using this action are listed below. For error response format, see ErrorResponse.
For more information about common errors, see NAVER Cloud Platform API.
| HTTP status code | Error code | Error message |
|---|---|---|
| 401 | 30 | Wrong roleNo |
| 400 | 400 | isMyAccount is missing |
| 400 | 400 | The value of the entered value is invalid |
| 400 | 9001 | You must enter the account name |
| 400 | 9001 | You must enter login ID |
Was this article helpful?