Creates a new user role
post
/learn.rest/v1/learnCenters/{learnCenterId}/userRoles
Request
Supported Media Types
- application/json
Path Parameters
-
learnCenterId: number
Unique identifier of a LearnCenter.
User role object that needs to be created.
Root Schema : UserRoleRequest
Type:
Show Source
object
-
description(optional):
string
Example:
test
-
name:
string
Example:
admin role
-
permissions(optional):
array permissions
-
statusFlag(optional):
boolean
Default Value:
true
Example:true
Nested Schema : permissions
Type:
Show Source
array
Example:
[
"receiveComSystemMessages",
"attachFilesToMessages",
"emailCompletionCertificates",
"useForums",
"viewReviews",
"addGlobalLCCalendarEvents",
"insertNewReviews",
"viewLearnCenterPages",
"viewInsightReportingReports",
"sendComSystemMessages",
"viewCoursePages",
"useComSystemAddressBook",
"useChatRooms",
"useCommunicationTools",
"modifyReviews",
"printCompletionCertificates",
"viewCertificatesContent",
"viewContent"
]
Security
-
auth: basic
Type:
basic
Description:Basic Authentication
Response
Supported Media Types
- application/json
201 Response
A new user role is created.
Root Schema : UserRoleResponse
Type:
Show Source
object
-
description(optional):
string
Example:
test
-
id(optional):
number
Example:
234
-
links(optional):
array links
-
name(optional):
string
Example:
admin role
-
permissions(optional):
array permissions
-
statusFlag(optional):
boolean
Default Value:
true
Example:true
Nested Schema : permissions
Type:
Show Source
array
Example:
[
"receiveComSystemMessages",
"attachFilesToMessages",
"emailCompletionCertificates",
"useForums",
"viewReviews",
"addGlobalLCCalendarEvents",
"insertNewReviews",
"viewLearnCenterPages",
"viewInsightReportingReports",
"sendComSystemMessages",
"viewCoursePages",
"useComSystemAddressBook",
"useChatRooms",
"useCommunicationTools",
"modifyReviews",
"printCompletionCertificates",
"viewCertificatesContent",
"viewContent"
]
Nested Schema : UserRoleLink
Type:
Show Source
object
Example:
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/639"
}
400 Response
Request has incorrect syntax or does not contain a field that is required.
401 Response
404 Response
Resource not found.
422 Response
Request may contain validation errors.
500 Response
Internal server error.