User group¶
User group contains roles that defines permission for resources
Create UserGroup¶
Creates new role, also binds components and permissions
# Http requestPOSThttp://localhost:8080/api/userGroupHTTP/1.1
Request¶
userGroup.icon` should be null. Because icon upload will be send by another request
Header:¶Authorization : Bearer {jwt.token}
Content-Type : application/json
# List of permissions you can get from following requestPOSThttp://localhost:8080/api/permission/all HTTP/1.1 Response: { "_embedded": { "permissionResources": [ { "enhanceId": 1, "name": "CREATE", "description": "Create operation" }, { "enhanceId": 2, "name": "UPDATE", "description": "Update operation" }, { "enhanceId": 3, "name": "DELETE", "description": "Delete operation" }, { "enhanceId": 4, "name": "READ", "description": "Read operation" } ] } }
# List of components you will find from following requestPOSThttp://localhost:8080/api/component/all HTTP/1.1 Response: { "_embedded": { "componentResources": [ { "enhanceId": 1, "name": "CONNECTION", "description": "Connection description", "permissions": null }, { "enhanceId": 2, "name": "CONNECTOR", "description": "Connector description", "permissions": null }, { "enhanceId": 3, "name": "EVENT", "description": "Event description", "permissions": null }, { "enhanceId": 4, "name": "USER", "description": "User description", "permissions": null }, { "enhanceId": 5, "name": "USERGROUP", "description": "User Group description", "permissions": null }, { "enhanceId": 6, "name": "MYPROFILE", "description": "My profile description", "permissions": null } ] } }
Whole json for creating UserGroup is look like:
Body:¶{
"role": "ADMIN_ROLE",
"description": "User role",
"icon": null,
"components": [
{
"enhanceId":1,
"permissions": [
"READ",
"CREATE",
"UPDATE"
]
},
{
"enhanceId":2,
"permissions": [
"READ",
"CREATE",
"UPDATE"
]
}
]
}
Response¶
Success:
Header:¶201 Created
Body:¶{
"enhanceId": 2,
"role": "USER_ROLE",
"description": "User role",
"icon": null,
"components": [
{
"enhanceId": 2,
"name": "CONNECTOR",
"description": "Connector description",
"permissions": [
"READ",
"CREATE",
"UPDATE"
]
},
{
"enhanceId": 1,
"name": "CONNECTION",
"description": "Connection description",
"permissions": [
"READ",
"CREATE",
"UPDATE"
]
}
]
}
Error:
Body:¶{
"timestamp" : "2018-05-24T12:44:26.295+0000",
"status" : 404,
"error" : "Page not found",
"message" : "NOT_FOUND",
"path" : "/api/userGroup"
}
Upload UserGroup Icon¶
Before sending request for uploading UserGroup Icon, you have to send request for Creating UserGroup or be sure that UserGroup has been created already! After this operation you can send request for uploading Icon.
# Http request for picture uploadPOSThttp://localhost:8080/api/storage/groupIconHTTP/1.1
Header:¶Authorization : Bearer {jwt.token}
Content-Type : multipart/form-data
Body: |
|
|---|---|
| Key | Value |
| file | { uploaded file } |
| userGroupId | { user group Id } |
If error will occur you will get response.
Error:
Header:¶Internal Error 500
Body:¶{
"timestamp" : "2018-05-24T12:44:26.295+0000",
"status" : 500,
"error" : "Internal Error",
"message" : "WRONG_FORMAT",
"path" : "/api/user/all"
}
Get All UserGroups¶
# Http requestGEThttp://localhost:8080/api/userGroup/allHTTP/1.1
Response¶
Success:
Body:¶{
"_embedded": {
"userGroupResources": [
{
"enhanceId": 1,
"role": "ROLE_ADMIN",
"description": "Admin role",
"icon": null,
"components": [
{
"enhanceId": 4,
"name": "USER",
"description": "User description",
"permissions": [
"READ",
"DELETE",
"CREATE",
"UPDATE"
]
},
{
"enhanceId": 6,
"name": "MYPROFILE",
"description": "My profile description",
"permissions": [
"READ",
"DELETE",
"CREATE",
"UPDATE"
]
},
{
"enhanceId": 3,
"name": "EVENT",
"description": "Event description",
"permissions": [
"READ",
"DELETE",
"CREATE",
"UPDATE"
]
},
{
"enhanceId": 1,
"name": "CONNECTION",
"description": "Connection description",
"permissions": [
"READ",
"DELETE",
"CREATE",
"UPDATE"
]
},
{
"enhanceId": 5,
"name": "USERGROUP",
"description": "User Group description",
"permissions": [
"READ",
"DELETE",
"CREATE",
"UPDATE"
]
},
{
"enhanceId": 2,
"name": "CONNECTOR",
"description": "Connector description",
"permissions": [
"READ",
"DELETE",
"CREATE",
"UPDATE"
]
}
]
},
{
"enhanceId": 2,
"role": "USER_ROLE",
"description": "User role",
"icon": null,
"components": [
{
"enhanceId": 1,
"name": "CONNECTION",
"description": "Connection description",
"permissions": [
"READ",
"CREATE",
"UPDATE"
]
},
{
"enhanceId": 2,
"name": "CONNECTOR",
"description": "Connector description",
"permissions": [
"READ",
"CREATE",
"UPDATE"
]
}
]
}
]
}
}
Error:
Header:¶Internal Error 500
Body:¶{
"timestamp" : "2018-05-24T12:44:26.295+0000",
"status" : 500,
"error" : "Password or email doesnt match",
"message" : "INTERNAL_ERROR",
"path" : "/api/userGroup/all"
}
Get UserGroup¶
Retrieve user group by Id.
# Http requestGEThttp://localhost:8080/api/userGroup/{userGroupId}HTTP/1.1
Response¶
Success:
Body:¶{
"enhanceId": 2,
"role": "USER_ROLE",
"description": "User role",
"icon": null,
"components": [
{
"enhanceId": 2,
"name": "CONNECTOR",
"description": "Connector description",
"permissions": [
"READ",
"CREATE",
"UPDATE"
]
},
{
"enhanceId": 1,
"name": "CONNECTION",
"description": "Connection description",
"permissions": [
"READ",
"CREATE",
"UPDATE"
]
}
]
}
Error:
Body:¶{
"timestamp" : "2018-05-24T12:44:26.295+0000",
"status" : 500,
"error" : "Internal Error",
"message" : "ROLE_NOT_EXIST",
"path" : "/api/userGroup/{userGroupId}"
}
Delete UserGroup¶
UserGroup could be delete if it is not linked to User. Otherwise you will get an error
# Http requestDELETEhttp://localhost:8080/api/{userGroupId}HTTP/1.1
Change UserGroup¶
Change User Group, .
# Http requestPUThttp://localhost:8080/api/{userGroupId}/componentHTTP/1.1
Request¶
Header:¶Authorization : Bearer {jwt.token}
Content-Type : application/json
Body:¶{
"enhanceId" : 1,
"name": "ROLE_ADMIN",
"description": "Administrator role",
"icon": null,
"components": [
{
"enhanceId" : 1,
"permissions": [
"READ",
"DELETE",
"CREATE",
"UPDATE"
]
},
{
"enhanceId":2,
"permissions": [
"READ",
"CREATE"
]
}
]
}
Response¶
Success:
Header:¶201 Created
Error:
Body:¶{
"timestamp" : "2018-05-24T12:44:26.295+0000",
"status" : 204,
"error" : "",
"message" : "USERGROUP_NOT_CHANGED",
"path" : "/api/user/all"
}
For update User Group Icon you have to send following request:
# Http request for user group icon uploadPOSThttp://localhost:8080/api/storage/groupIconHTTP/1.1
Header:¶Authorization : Bearer {jwt.token}
Content-Type : multipart/form-data
Body: |
|
|---|---|
| Key | Value |
| file | { uploaded file } |
| userGroupId | { user group Id } |