Community Roles
- Last UpdatedJan 20, 2023
- 2 minute read
Cluster APIs for getting community roles
List instanced Roles for a Community
Get community roles associated with a specific community
Request
GET /api/v1-preview/Communities/{communityId}/Roles
?query={query}&skip={skip}&count={count}
Parameters
string communityId
Community identifier
[optional] string query
(not supported) Search string identifier[optional] integer skip
Parameter representing the zero-based offset of the first object to retrieve. If unspecified, a default value of 0 is used.[optional] integer count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | Role[] | Set of community roles (type Role) associated with the community ( communityId) |
| 400 | ErrorResponse | Bad request |
| 401 | ErrorResponse | Unauthorized |
| 403 | ErrorResponse | Forbidden |
| 404 | ErrorResponse | Tenant not found |
| 500 | ErrorResponse | Internal server error |
Example response body
200 Response (Role[])
[
{
"Id": "string",
"Name": "string",
"Description": "string",
"RoleScope": 0,
"TenantId": "string",
"CommunityId": "string",
"RoleTypeId": "string"
}
]
Definitions
Role
Object for retrieving a role
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Id | string | false | true | Role identifier. Generated by the server upon creation. |
| Name | string | false | true | Role name. This cannot be empty. |
| Description | string | false | true | Role description |
| RoleScope | RoleScope | false | true | Role scope |
| TenantId | string | false | true | Tenant identifier, if this is a Tenant Role. Otherwise, set to null. |
| CommunityId | string | false | true | Community identifier, if this is a Community Role. Otherwise set to null. |
| RoleTypeId | string | false | true | Role type identifier for built-in roles |
{
"Id": "string",
"Name": "string",
"Description": "string",
"RoleScope": 0,
"TenantId": "string",
"CommunityId": "string",
"RoleTypeId": "string"
}
RoleScope
The object that represents the scope of a given role
Enumerated Values
| Property | Value |
|---|---|
| None | 0 |
| Tenant | 1 |
| Community | 2 |
| Cluster | 3 |
ErrorResponse
Object returned whenever there is an error
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| OperationId | string | true | false | Operation identifier of action that caused the error |
| Error | string | true | false | Error description |
| Reason | string | true | false | Reason for the error |
| Resolution | string | true | false | Resolution to resolve the error |
| DynamicProperties | object | false | true | Additional properties |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"DynamicProperties": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}