List roles
/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/rolesAuthentication
- Bearer Token
AuthorizationJWT access token
Query Parameters
| Name | Required | Type | Description |
|---|---|---|---|
include_inactive | string | ||
type | string |
Code samples
curl -X GET "https://api.canopy.dev/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/roles?include_inactive=value&type=value" \
-H "Authorization: Bearer $CANOPY_TOKEN"const response = await fetch("https://api.canopy.dev/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/roles?include_inactive=value&type=value", {
method: "GET",
headers: {
"Authorization": "Bearer $CANOPY_TOKEN"
},
});
const data = await response.json();import requests
response = requests.get(
"https://api.canopy.dev/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/roles?include_inactive=value&type=value",
headers={
"Authorization": "Bearer $CANOPY_TOKEN"
},
)
data = response.json()package main
import (
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.canopy.dev/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/roles?include_inactive=value&type=value", nil)
req.Header.Set("Authorization", "Bearer $CANOPY_TOKEN")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
}Responses
200 Roles returned
{
"items": [
{
"id": "string",
"application_id": "string",
"name": "string",
"description": "string",
"is_system_role": false,
"system_key": "string",
"is_active": false,
"created_at": "2026-04-20T12:00:00.000Z",
"updated_at": "2026-04-20T12:00:00.000Z",
"version": 0,
"permission_count": 0
}
]
}application/json
items *RoleResponseDto[]
401 Invalid or expired token
403 This token is not authorized for this endpoint (wrong principal type — e.g., admin token on identity-only endpoint, or vice versa)