Merge pull request #100 from dell/sso_user

adding sso user functionalities for 4.5

inttests/sso_user_test.go

@@ -0,0 +1,51 @@
+// Copyright © 2024 Dell Inc. or its subsidiaries. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//      http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package inttests
+
+import (
+	"testing"
+
+	types "github.com/dell/goscaleio/types/v1"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestCreateAndDeleteSSOUser(t *testing.T) {
+	details, err := C.CreateSSOUser(&types.SSOUserCreateParam{
+		UserName: "IntegrationTestSSOUser",
+		Role:     "Monitor",
+		Password: "Ssouser123!",
+		Type:     "Local",
+	})
+	assert.Nil(t, err)
+	assert.NotEmpty(t, details)
+
+	details, err = C.GetSSOUser(details.ID)
+	assert.Nil(t, err)
+	assert.NotEmpty(t, details)
+
+	details1, err := C.GetSSOUserByFilters("username", "IntegrationTestSSOUser")
+	assert.Nil(t, err)
+	assert.NotEmpty(t, details1)
+
+	details, err = C.ModifySSOUser(details.ID, &types.SSOUserModifyParam{
+		Role: "Technician",
+	})
+	assert.Nil(t, err)
+	assert.NotEmpty(t, details)
+
+	err = C.ResetSSOUserPassword(details.ID, &types.SSOUserModifyParam{Password: "Ssouser1234#"})
+	assert.Nil(t, err)
+
+	err = C.DeleteSSOUser(details.ID)
+	assert.Nil(t, err)
+}

sso_user.go

@@ -0,0 +1,86 @@
+// Copyright © 2024 Dell Inc. or its subsidiaries. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//      http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package goscaleio
+
+import (
+	"fmt"
+	"net/http"
+	"net/url"
+
+	types "github.com/dell/goscaleio/types/v1"
+)
+
+// GetSSOUser retrieves the details of an SSO user by their ID.
+func (c *Client) GetSSOUser(userID string) (*types.SSOUserDetails, error) {
+	path := fmt.Sprintf("/rest/v1/users/%s", userID)
+	user := &types.SSOUserDetails{}
+	err := c.getJSONWithRetry(http.MethodGet, path, nil, &user)
+
+	if err != nil {
+		return nil, err
+	}
+
+	return user, nil
+}
+
+// GetSSOUserByFilters retrieves the details of an SSO user by filter.
+func (c *Client) GetSSOUserByFilters(key string, value string) (*types.SSOUserList, error) {
+	encodedValue := url.QueryEscape(value)
+	path := `/rest/v1/users?filter=` + key + `%20eq%20%22` + encodedValue + `%22`
+	users := &types.SSOUserList{}
+	err := c.getJSONWithRetry(http.MethodGet, path, nil, &users)
+	if err != nil {
+		return nil, err
+	}
+	return users, nil
+}
+
+// CreateSSOUser creates a new SSO user with the given parameters.
+func (c *Client) CreateSSOUser(userParam *types.SSOUserCreateParam) (*types.SSOUserDetails, error) {
+	userResp := &types.SSOUserDetails{}
+	err := c.getJSONWithRetry(http.MethodPost, "/rest/v1/users", userParam, &userResp)
+	if err != nil {
+		return nil, err
+	}
+	return userResp, nil
+}
+
+// ModifySSOUser modifies the details of an SSO user by their ID.
+func (c *Client) ModifySSOUser(userID string, userParam *types.SSOUserModifyParam) (*types.SSOUserDetails, error) {
+	path := fmt.Sprintf("/rest/v1/users/%s", userID)
+	err := c.getJSONWithRetry(http.MethodPatch, path, userParam, nil)
+	if err != nil {
+		return nil, err
+	}
+	return c.GetSSOUser(userID)
+}
+
+// ResetSSOUserPassword resets the password of an SSO user by their ID.
+func (c *Client) ResetSSOUserPassword(userID string, userParam *types.SSOUserModifyParam) error {
+	path := fmt.Sprintf("/rest/v1/users/%s/reset-password", userID)
+	err := c.getJSONWithRetry(http.MethodPost, path, userParam, nil)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+// DeleteSSOUser deletes an SSO user by their ID.
+func (c *Client) DeleteSSOUser(userID string) error {
+	path := fmt.Sprintf("/rest/v1/users/%s", userID)
+	err := c.getJSONWithRetry(http.MethodDelete, path, nil, nil)
+	if err != nil {
+		return err
+	}
+	return nil
+}