Retrieve all roles in the organization. Requires organization membership.
curl --request GET \
--url https://{deploymentHost}/organizations/{id}/roles
{
"status": 200,
"message": "",
"data": [
{
"id": "role_admin",
"name": "Admin",
"description": "Full administrative access to the organization",
"permissions": [
"organization:admin",
"organization:manage",
"organization:read"
],
"is_default": false,
"member_count": 2,
"created_at": "2024-01-01T00:00:00Z"
},
{
"id": "role_manager",
"name": "Manager",
"description": "Can manage organization members and settings",
"permissions": [
"organization:manage",
"organization:read"
],
"is_default": false,
"member_count": 5,
"created_at": "2024-01-01T00:00:00Z"
},
{
"id": "role_member",
"name": "Member",
"description": "Basic organization member access",
"permissions": [
"organization:read"
],
"is_default": true,
"member_count": 18,
"created_at": "2024-01-01T00:00:00Z"
}
],
"session": {
"signin_attempts": [],
"signins": [
{
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
],
"signup_attempts": [],
"active_signin": {
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
},
"errors": []
}
Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.
Organization ID
Roles retrieved successfully
The response is of type object
.
curl --request GET \
--url https://{deploymentHost}/organizations/{id}/roles
{
"status": 200,
"message": "",
"data": [
{
"id": "role_admin",
"name": "Admin",
"description": "Full administrative access to the organization",
"permissions": [
"organization:admin",
"organization:manage",
"organization:read"
],
"is_default": false,
"member_count": 2,
"created_at": "2024-01-01T00:00:00Z"
},
{
"id": "role_manager",
"name": "Manager",
"description": "Can manage organization members and settings",
"permissions": [
"organization:manage",
"organization:read"
],
"is_default": false,
"member_count": 5,
"created_at": "2024-01-01T00:00:00Z"
},
{
"id": "role_member",
"name": "Member",
"description": "Basic organization member access",
"permissions": [
"organization:read"
],
"is_default": true,
"member_count": 18,
"created_at": "2024-01-01T00:00:00Z"
}
],
"session": {
"signin_attempts": [],
"signins": [
{
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
],
"signup_attempts": [],
"active_signin": {
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
},
"errors": []
}