Get all of the available roles that can be added to a user given a site_template that is added to the user
GET /users/site-template/availableRoles
Operation id: SiteTemplateService_ListAvailableRolesBySiteTemplate
Tags: SiteTemplateService
Parameters
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
pageSize | integer (int32) | No | Page size for the list of roles. Required: false, Default: 10 |
pageToken | string | No | Page token for the list of roles. Required: false |
siteTemplateId | string | No | Id of the site_template. Required: true |
sortField | string | No | Sort field valid values: displayName. Default: displayName, Required: false |
sortType | string | No | Sort Type for the results, Default: ASC, Required: false |
tenantId | string | No | TenantId of the site. Required: false (False as this can be inferred from the token) |
Security
- Authorization (apiKey)
- Bearer token
Responses
200 — A successful response.
Content type: application/json
default — An unexpected error response.
Content type: application/json
Response models
200 — A successful response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
availableRoles | array | No | |
nextPageToken | string | No |
{
"type": "object",
"properties": {
"availableRoles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tenantId": {
"type": "string"
},
"roleId": {
"type": "string"
},
"displayName": {
"type": "string"
},
"domain": {
"type": "string"
},
"scope": {
"type": "string"
}
}
}
},
"nextPageToken": {
"type": "string"
}
}
}
default — An unexpected error response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
code | integer (int32) | No | |
message | string | No | |
details | array | No |
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
}
}
}
}
}