Skip to content

feat: add default role support to RoleSet API #466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 4, 2025
Merged

feat: add default role support to RoleSet API #466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions role_set.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ type RoleSet struct {
Key string `json:"key"`
Description *string `json:"description"`
Roles []*RoleSetItem `json:"roles"`
DefaultRole *RoleSetItem `json:"default_role"`
// Type defines the type of role set. It can be either "initial" or "custom".
Type string `json:"type"`
CreatedAt int64 `json:"created_at"`
Expand Down
6 changes: 4 additions & 2 deletions roleset/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ type CreateParams struct {
// Type defines the type of role set. It can be either "initial" or "custom".
Type *string `json:"type,omitempty"`
// Roles are an array of role keys
Roles *[]string `json:"roles,omitempty"`
Roles *[]string `json:"roles,omitempty"`
DefaultRoleKey *string `json:"default_role_key,omitempty"`
}

// Create creates a new role set.
Expand Down Expand Up @@ -64,7 +65,8 @@ type UpdateParams struct {
// Type defines the type of role set. For update operations it can be only set to "initial".
// There's only one "initial" role set per organization, after updating this roleset to "initial"
// the other "initial" role sets will be updated to "custom".
Type *string `json:"type,omitempty"`
Type *string `json:"type,omitempty"`
DefaultRoleKey *string `json:"default_role_key,omitempty"`
}

// Update updates a role set.
Expand Down
39 changes: 22 additions & 17 deletions roleset/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,25 +24,29 @@ func TestRoleSetClient_Create(t *testing.T) {
config.HTTPClient = &http.Client{
Transport: &clerktest.RoundTripper{
T: t,
In: json.RawMessage(fmt.Sprintf(`{"name":"%s","key":"%s","description":"%s", "roles": ["org:member"], "type": "initial"}`, name, key, description)),
Out: json.RawMessage(fmt.Sprintf(`{"object":"role_set","id":"%s","name":"%s","key":"%s","description":"%s","roles":[],"created_at":1234567890,"updated_at":1234567890}`, roleSetID, name, key, description)),
In: json.RawMessage(fmt.Sprintf(`{"name":"%s","key":"%s","description":"%s", "roles": ["org:member"], "type": "initial", "default_role_key": "org:member"}`, name, key, description)),
Out: json.RawMessage(fmt.Sprintf(`{"object":"role_set","id":"%s","name":"%s","key":"%s","description":"%s","roles":[],"default_role":{"object":"role_set_item","id":"role_123","name":"Member","key":"org:member","description":"Default member role","created_at":1234567890,"updated_at":1234567890},"type":"initial","created_at":1234567890,"updated_at":1234567890}`, roleSetID, name, key, description)),
Method: http.MethodPost,
Path: "/v1/role_sets",
},
}
client := NewClient(config)
roleSet, err := client.Create(context.Background(), &CreateParams{
Name: clerk.String(name),
Key: clerk.String(key),
Description: clerk.String(description),
Roles: &[]string{"org:member"},
Type: clerk.String("initial"),
Name: clerk.String(name),
Key: clerk.String(key),
Description: clerk.String(description),
Roles: &[]string{"org:member"},
Type: clerk.String("initial"),
DefaultRoleKey: clerk.String("org:member"),
})
require.NoError(t, err)
assert.Equal(t, roleSetID, roleSet.ID)
assert.Equal(t, name, roleSet.Name)
assert.Equal(t, key, roleSet.Key)
assert.Equal(t, description, *roleSet.Description)
assert.NotNil(t, roleSet.DefaultRole)
assert.Equal(t, "org:member", roleSet.DefaultRole.Key)
assert.Equal(t, "Member", roleSet.DefaultRole.Name)
}

func TestRoleSetClient_Get(t *testing.T) {
Expand All @@ -53,7 +57,7 @@ func TestRoleSetClient_Get(t *testing.T) {
config.HTTPClient = &http.Client{
Transport: &clerktest.RoundTripper{
T: t,
Out: json.RawMessage(fmt.Sprintf(`{"object":"role_set","id":"%s","name":"Admin Role Set","key":"%s","description":"Roles for administrative users","roles":[],"created_at":1234567890,"updated_at":1234567890, "type": "initial"}`, roleSetID, roleSetKey)),
Out: json.RawMessage(fmt.Sprintf(`{"object":"role_set","id":"%s","name":"Admin Role Set","key":"%s","description":"Roles for administrative users","roles":[],"default_role":{"object":"role_set_item","id":"role_123","name":"Member","key":"org:member","description":"Default member role","created_at":1234567890,"updated_at":1234567890},"type":"initial","created_at":1234567890,"updated_at":1234567890}`, roleSetID, roleSetKey)),
Method: http.MethodGet,
Path: "/v1/role_sets/" + url.PathEscape(roleSetKey),
},
Expand All @@ -74,16 +78,17 @@ func TestRoleSetClient_Update(t *testing.T) {
config.HTTPClient = &http.Client{
Transport: &clerktest.RoundTripper{
T: t,
In: json.RawMessage(fmt.Sprintf(`{"name":"%s", "type": "initial"}`, newName)),
Out: json.RawMessage(fmt.Sprintf(`{"object":"role_set","id":"%s","name":"%s","key":"%s","description":"Roles for administrative users","roles":[],"created_at":1234567890,"updated_at":1234567891, "type": "initial"}`, roleSetID, newName, roleSetKey)),
In: json.RawMessage(fmt.Sprintf(`{"name":"%s", "type": "initial", "default_role_key": "org:admin"}`, newName)),
Out: json.RawMessage(fmt.Sprintf(`{"object":"role_set","id":"%s","name":"%s","key":"%s","description":"Roles for administrative users","roles":[],"default_role":{"object":"role_set_item","id":"role_456","name":"Admin","key":"org:admin","description":"Default admin role","created_at":1234567890,"updated_at":1234567890},"type":"initial","created_at":1234567890,"updated_at":1234567891}`, roleSetID, newName, roleSetKey)),
Method: http.MethodPatch,
Path: "/v1/role_sets/" + url.PathEscape(roleSetKey),
},
}
client := NewClient(config)
roleSet, err := client.Update(context.Background(), roleSetKey, &UpdateParams{
Name: clerk.String(newName),
Type: clerk.String("initial"),
Name: clerk.String(newName),
Type: clerk.String("initial"),
DefaultRoleKey: clerk.String("org:admin"),
})
require.NoError(t, err)
assert.Equal(t, roleSetID, roleSet.ID)
Expand Down Expand Up @@ -120,8 +125,8 @@ func TestRoleSetClient_List(t *testing.T) {
T: t,
Out: json.RawMessage(fmt.Sprintf(`{
"data": [
{"object":"role_set","id":"%s","name":"Admin Role Set","key":"admin-roles","description":"Admin roles","type": "initial","roles":[],"created_at":1234567890,"updated_at":1234567890},
{"object":"role_set","id":"%s","name":"User Role Set","key":"user-roles","description":"User roles","type": "custom","roles":[],"created_at":1234567890,"updated_at":1234567890}
{"object":"role_set","id":"%s","name":"Admin Role Set","key":"admin-roles","description":"Admin roles","type":"initial","roles":[],"default_role":{"object":"role_set_item","id":"role_123","name":"Member","key":"org:member","description":"Default member role","created_at":1234567890,"updated_at":1234567890},"created_at":1234567890,"updated_at":1234567890},
{"object":"role_set","id":"%s","name":"User Role Set","key":"user-roles","description":"User roles","type":"custom","roles":[],"default_role":{"object":"role_set_item","id":"role_456","name":"User","key":"org:user","description":"Default user role","created_at":1234567890,"updated_at":1234567890},"created_at":1234567890,"updated_at":1234567890}
],
"total_count": 2
}`, roleSet1ID, roleSet2ID)),
Expand All @@ -148,7 +153,7 @@ func TestRoleSetClient_AddRoles(t *testing.T) {
Transport: &clerktest.RoundTripper{
T: t,
In: json.RawMessage(`{"role_keys":["role:admin","role:manager"]}`),
Out: json.RawMessage(fmt.Sprintf(`{"object":"role_set","id":"%s","name":"Admin Role Set","type": "initial","key":"%s","description":"Admin roles","roles":[{"object":"role_set_item","id":"role_1","name":"Admin","key":"role:admin","description":"Admin role","created_at":1234567890,"updated_at":1234567890}],"created_at":1234567890,"updated_at":1234567891}`, roleSetID, roleSetKey)),
Out: json.RawMessage(fmt.Sprintf(`{"object":"role_set","id":"%s","name":"Admin Role Set","type":"initial","key":"%s","description":"Admin roles","roles":[{"object":"role_set_item","id":"role_1","name":"Admin","key":"role:admin","description":"Admin role","created_at":1234567890,"updated_at":1234567890}],"default_role":{"object":"role_set_item","id":"role_123","name":"Member","key":"org:member","description":"Default member role","created_at":1234567890,"updated_at":1234567890},"created_at":1234567890,"updated_at":1234567891}`, roleSetID, roleSetKey)),
Method: http.MethodPost,
Path: "/v1/role_sets/" + url.PathEscape(roleSetKey) + "/roles",
},
Expand All @@ -173,7 +178,7 @@ func TestRoleSetClient_RemoveRoles(t *testing.T) {
Transport: &clerktest.RoundTripper{
T: t,
In: json.RawMessage(`{"role_keys":["role:admin"]}`),
Out: json.RawMessage(fmt.Sprintf(`{"object":"role_set","id":"%s","name":"Admin Role Set","type": "initial","key":"%s","description":"Admin roles","roles":[],"created_at":1234567890,"updated_at":1234567891}`, roleSetID, roleSetKey)),
Out: json.RawMessage(fmt.Sprintf(`{"object":"role_set","id":"%s","name":"Admin Role Set","type":"initial","key":"%s","description":"Admin roles","roles":[],"default_role":{"object":"role_set_item","id":"role_123","name":"Member","key":"org:member","description":"Default member role","created_at":1234567890,"updated_at":1234567890},"created_at":1234567890,"updated_at":1234567891}`, roleSetID, roleSetKey)),
Method: http.MethodDelete,
Path: "/v1/role_sets/" + url.PathEscape(roleSetKey) + "/roles",
},
Expand Down Expand Up @@ -259,7 +264,7 @@ func TestRoleSetClient_ListWithQueryParams(t *testing.T) {
T: t,
Out: json.RawMessage(fmt.Sprintf(`{
"data": [
{"object":"role_set","id":"%s","name":"Admin Role Set","key":"admin-roles","description":"Admin roles","type": "initial","roles":[],"created_at":1234567890,"updated_at":1234567890}
{"object":"role_set","id":"%s","name":"Admin Role Set","key":"admin-roles","description":"Admin roles","type":"initial","roles":[],"default_role":{"object":"role_set_item","id":"role_123","name":"Member","key":"org:member","description":"Default member role","created_at":1234567890,"updated_at":1234567890},"created_at":1234567890,"updated_at":1234567890}
],
"total_count": 1
}`, roleSet1ID)),
Expand Down
Loading