Merge pull request #105 from onelogin/feature/update-role-api

Improve Roles API with context support and consistent parameters

Author: Subterrane

changelog.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [4.5.0]
+
+### Improved
+- Added context support for roles API methods:
+  - `CreateRoleWithContext`
+  - `GetRolesWithContext`
+  - `GetRoleByIDWithContext`
+  - `UpdateRoleWithContext`
+  - `DeleteRoleWithContext`
+- Improved `UpdateRole` function to use pointer parameter for consistency with other API methods
+- Removed unused queryParams parameter from DeleteRole function
+- Updated Role model documentation to match the actual structure
+
 ## [4.4.0]
 
 ### Added

docs/models.md

@@ -94,13 +94,15 @@ type Privilege struct {
 
 ## [Role](../pkg/onelogin/models/role.go)
 
-The `Role` model represents a role within the OneLogin platform. It contains information such as the role's name, description, and any associated privileges.
+The `Role` model represents a role within the OneLogin platform. It contains information such as the role's name and associated users, admins, and apps.
 
 ```go
 type Role struct {
-    ID   int64  `json:"id"`
-    Name string `json:"name"`
-    // ...
+	ID     *int32  `json:"id,omitempty"`
+	Name   *string `json:"name,omitempty"`
+	Admins []int32 `json:"admins,omitempty"`
+	Apps   []int32 `json:"apps,omitempty"`
+	Users  []int32 `json:"users,omitempty"`
 }
 ```
 

docs/usage_examples.md

@@ -52,13 +52,28 @@ func main() {
 		fmt.Println(err)
 	}
 
-	role, err := client.CreateRole(models.Role{
+	// Create a role
+	role, err := client.CreateRole(&models.Role{
 		Name: &name,
 	})
 	if err != nil {
 		fmt.Println(err)
 	}
-	fmt.Printf("%+v\n", role)
+	fmt.Printf("Created role: %+v\n", role)
+	
+	// Extract role ID for updates
+	roleResp, _ := role.(map[string]interface{})
+	roleID := int(roleResp["id"].(float64))
+	
+	// Update a role - the name field is optional for updates
+	updatedRole, err := client.UpdateRole(roleID, &models.Role{
+		// Add users to the role
+		Users: []int32{123456789},
+	})
+	if err != nil {
+		fmt.Println(err)
+	}
+	fmt.Printf("Updated role: %+v\n", updatedRole)
 }
 ```
 

pkg/onelogin/roles.go

@@ -1,6 +1,8 @@
 package onelogin
 
 import (
+	"context"
+
 	mod "github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin/models"
 	utl "github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin/utilities"
 )
@@ -10,60 +12,85 @@ var (
 )
 
 func (sdk *OneloginSDK) CreateRole(role *mod.Role) (interface{}, error) {
+	return sdk.CreateRoleWithContext(context.Background(), role)
+}
+
+// CreateRoleWithContext creates a role using the provided context
+func (sdk *OneloginSDK) CreateRoleWithContext(ctx context.Context, role *mod.Role) (interface{}, error) {
 	p, err := utl.BuildAPIPath(RolePath)
 	if err != nil {
 		return nil, err
 	}
-	resp, err := sdk.Client.Post(&p, role)
+	resp, err := sdk.Client.PostWithContext(ctx, &p, role)
 	if err != nil {
 		return nil, err
 	}
 	return utl.CheckHTTPResponse(resp)
 }
 
-// ListRoles
+// GetRoles retrieves a list of roles
 func (sdk *OneloginSDK) GetRoles(queryParams mod.Queryable) (interface{}, error) {
+	return sdk.GetRolesWithContext(context.Background(), queryParams)
+}
+
+// GetRolesWithContext retrieves a list of roles using the provided context
+func (sdk *OneloginSDK) GetRolesWithContext(ctx context.Context, queryParams mod.Queryable) (interface{}, error) {
 	p, err := utl.BuildAPIPath(RolePath)
 	if err != nil {
 		return nil, err
 	}
-	resp, err := sdk.Client.Get(&p, queryParams)
+	resp, err := sdk.Client.GetWithContext(ctx, &p, queryParams)
 	if err != nil {
 		return nil, err
 	}
 	return utl.CheckHTTPResponse(resp)
 }
 
 func (sdk *OneloginSDK) GetRoleByID(id int, queryParams mod.Queryable) (interface{}, error) {
+	return sdk.GetRoleByIDWithContext(context.Background(), id, queryParams)
+}
+
+// GetRoleByIDWithContext retrieves a role by ID using the provided context
+func (sdk *OneloginSDK) GetRoleByIDWithContext(ctx context.Context, id int, queryParams mod.Queryable) (interface{}, error) {
 	p, err := utl.BuildAPIPath(RolePath, id)
 	if err != nil {
 		return nil, err
 	}
-	resp, err := sdk.Client.Get(&p, queryParams)
+	resp, err := sdk.Client.GetWithContext(ctx, &p, queryParams)
 	if err != nil {
 		return nil, err
 	}
 	return utl.CheckHTTPResponse(resp)
 }
 
-func (sdk *OneloginSDK) UpdateRole(id int, role mod.Role, queryParams map[string]string) (interface{}, error) {
+func (sdk *OneloginSDK) UpdateRole(id int, role *mod.Role) (interface{}, error) {
+	return sdk.UpdateRoleWithContext(context.Background(), id, role)
+}
+
+// UpdateRoleWithContext updates a role using the provided context
+func (sdk *OneloginSDK) UpdateRoleWithContext(ctx context.Context, id int, role *mod.Role) (interface{}, error) {
 	p, err := utl.BuildAPIPath(RolePath, id)
 	if err != nil {
 		return nil, err
 	}
-	resp, err := sdk.Client.Put(&p, role)
+	resp, err := sdk.Client.PutWithContext(ctx, &p, role)
 	if err != nil {
 		return nil, err
 	}
 	return utl.CheckHTTPResponse(resp)
 }
 
-func (sdk *OneloginSDK) DeleteRole(id int, queryParams map[string]string) (interface{}, error) {
+func (sdk *OneloginSDK) DeleteRole(id int) (interface{}, error) {
+	return sdk.DeleteRoleWithContext(context.Background(), id)
+}
+
+// DeleteRoleWithContext deletes a role using the provided context
+func (sdk *OneloginSDK) DeleteRoleWithContext(ctx context.Context, id int) (interface{}, error) {
 	p, err := utl.BuildAPIPath(RolePath, id)
 	if err != nil {
 		return nil, err
 	}
-	resp, err := sdk.Client.Delete(&p)
+	resp, err := sdk.Client.DeleteWithContext(ctx, &p)
 	if err != nil {
 		return nil, err
 	}

pkg/onelogin/version.go

@@ -1,3 +1,3 @@
 package onelogin
 
-const Version = "4.4.0"
+const Version = "4.5.0"