Single view of user information
- Print
- PDF
Single view of user information
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
View all users with account permission such as role user, deleted sub account, and sub account.
API
- GET /users/{subAccountId}
Request
Path Variables
| Parameters | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| includeDeleted | N | boolean | default: false | Whether to include deleted user |
Response
{
"subAccountId": "string",
"loginId": "string",
"name": "string",
"email": "string",
"groups": [
{
"groupId": "string",
"groupName": "string"
}
],
"active": true,
"deleted": true,
"createTime": "string",
"principalType": "string",
"sourceIdentity": {
"type": "string",
"id": "string",
"provider": "string"
},
"roleNrn": "string"
}
| Item | Type | Description | Remarks |
|---|---|---|---|
| principalType | string | User type | IamUser: Sub account, IamRole: Role user |
| subAccountId | string | User ID | |
| loginId | string | Login ID | |
| name | string | Name | |
| string | |||
| groups | array | List of group to which the sub account belongs | |
| groups.groupId | string | Group ID | |
| groups.groupName | string | Group name | |
| active | boolean | Sub account status (true: enabled, false: disabled) | |
| deleted | boolean | Deleted user status | |
| createTime | string | Created date and time: 2019-08-10T13:21:00Z | |
| sourceIdentity | object | Role applied target information | You can view only when the principalType is IamRole see Source Identity list |
| sourceIdentity.type | string | Role applied target type (Principal type) | You can view only when the principalType is IamRole |
| sourceIdentity.id | string | Role applied target unique ID | You can view only when the principalType is IamRole |
| sourceIdentity.provider | string | Department classification of role applied target | You can view only when the principalType is IamRole |
| roleNrn | string | NRN of the role to be switched | You can view only when the principalType is IamRole |
Source Identity
Role applied target information
| Role type | Source Identity type | Source Identity provider | Source Identity id |
|---|---|---|---|
| Account Role | IamUser | Member number | Sub account ID |
| Server Role | Server | N/A | N/A |
| SSO Role | FederatedUser | SSO tenant ID | SSO user ID |
| Service Role | NcloudService | Service ID | Service resource ID |
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 |
|---|---|---|
| 401 | 30 | Nonexistent account |
Was this article helpful?