added -r to make it like kubectl get <COMMAND> -n

kenrickles · kenrickles · commit dd2016e41145 · 2023-11-19T00:32:55.000+08:00
diff --git a/README.md b/README.md
@@ -15,25 +15,31 @@
 - **Usage**: `create [user, realm, resource, role]`
 - **Description**: Creates various entities in Keycloak.
 - **Subcommands**:
-  - `create user`: Creates a new user.
+  - `create user`: Creates a new user in a specified realm.
+    - **Flags**: `-u, --username <username>`, `-p, --password <password>`, `-e, --email <email>`, `-r, --realm <realm>`
+    - **Example**: `./keycloak-api-cli create user -u john -p pass123 -e john@example.com -r myrealm`
   - `create realm`: Creates a new realm.
-- **Example**: `./keycloak-api-cli create user --config path/to/config.yaml`
+    - **Example**: `./keycloak-api-cli create realm --config path/to/config.yaml`
 
 ### 2. `delete`
 - **Usage**: `delete [user, realm, resource, role]`
 - **Description**: Deletes entities in Keycloak.
 - **Subcommands**:
-  - `delete user`: Deletes a user.
+  - `delete user`: Deletes a user from a specified realm.
+    - **Flags**: `-i, --userid <userID>`, `-u, --username <username>`, `-r, --realm <realm>`
+    - **Example**: `./keycloak-api-cli delete user -u john -r myrealm`
   - `delete realm`: Deletes a realm.
-- **Example**: `./keycloak-api-cli delete realm --config path/to/config.yaml`
+    - **Example**: `./keycloak-api-cli delete realm --config path/to/config.yaml`
 
 ### 3. `get`
 - **Usage**: `get [users, realms, resources, roles]`
 - **Description**: Retrieves information about entities in Keycloak.
 - **Subcommands**:
-  - `get users`: Lists all users in a realm.
+  - `get users`: Lists all users in a specified realm.
+    - **Flags**: `-r, --realm <realm>`
+    - **Example**: `./keycloak-api-cli get users -r myrealm --config path/to/config.yaml` 
   - `get realms`: Lists all realms.
-- **Example**: `./keycloak-api-cli get realms --config path/to/config.yaml`
+    - **Example**: `./keycloak-api-cli get realms --config path/to/config.yaml`
 
 ### 4. Root Command
 - **Usage**: `keycloak-api-cli`
diff --git a/cmd/create.go b/cmd/create.go
@@ -8,6 +8,7 @@ import (
 	"keycloak-api-cli/pkg/keycloak"
 
 	"github.com/spf13/cobra"
+    "github.com/spf13/viper"
 )
 
 
@@ -26,7 +27,7 @@ func CreateCommand(kcClient *keycloak.KeycloakClient) *cobra.Command {
 
 // Create Realm
 func CreateRealmCommand(kcClient *keycloak.KeycloakClient) *cobra.Command {
-    CreateRealmCommand := &cobra.Command{
+    realmCmd := &cobra.Command{
         Use:   "realm",
         Short: "Create a new Keycloak realm",
         Run: func(cmd *cobra.Command, args []string) {
@@ -40,8 +41,8 @@ func CreateRealmCommand(kcClient *keycloak.KeycloakClient) *cobra.Command {
             }
         },
     }
-    CreateRealmCommand.Flags().StringVarP(&realmName, "name", "n", "", "Name of the realm to create")
-    return CreateRealmCommand
+    realmCmd.Flags().StringVarP(&realmName, "name", "n", "", "Name of the realm to create")
+    return realmCmd
 }
 
 func askForRealmName() string {
@@ -54,30 +55,45 @@ func askForRealmName() string {
 
 // Create user
 func CreateUserCommand(kcClient *keycloak.KeycloakClient) *cobra.Command {
-    CreateUserCommand := &cobra.Command{
+    var (
+        username  string
+        password  string
+        email     string
+    )
+
+    createUserCmd := &cobra.Command{
         Use:   "user",
         Short: "Create a new Keycloak user",
         Run: func(cmd *cobra.Command, args []string) {
+            realm, _ := cmd.Flags().GetString("realm")
+            if realm == "" {
+                realm = viper.GetString("default_realm") // Fallback to default realm from config
+            }
             if username == "" {
                 username = askForUserName()
             }
-			if password == "" {
+            if password == "" {
                 password = askForUserPassword()
             }
-			if email == "" {
+            if email == "" {
                 email = askForUserEmail()
             }
-            if err := kcClient.CreateUser(username, password, email); err != nil {
-                fmt.Printf("Error creating user: %v\n", err)
+
+            // Ensure to pass the 'realm' along with other parameters
+            if err := kcClient.CreateUser(realm, username, password, email); err != nil {
+                fmt.Printf("Error creating user in realm %s: %v\n", realm, err)
             } else {
-                fmt.Println("username", username, "created successfully")
+                fmt.Println("User", username, "created successfully in realm", realm)
             }
         },
     }
-    CreateUserCommand.Flags().StringVarP(&realmName, "username", "u", "", "username of the user to create")
-	CreateUserCommand.Flags().StringVarP(&password, "password", "p", "", "Password for the user")
-	CreateUserCommand.Flags().StringVarP(&email, "email", "e", "", "Email address of the user")
-    return CreateUserCommand
+
+    createUserCmd.Flags().StringP("realm", "r", "", "Specify the realm to create a user in")
+    createUserCmd.Flags().StringVarP(&username, "username", "u", "", "Username of the user to create")
+    createUserCmd.Flags().StringVarP(&password, "password", "p", "", "Password for the user")
+    createUserCmd.Flags().StringVarP(&email, "email", "e", "", "Email address of the user")
+
+    return createUserCmd
 }
 
 func askForUserName() string {
diff --git a/cmd/delete.go b/cmd/delete.go
@@ -8,6 +8,7 @@ import (
 	"keycloak-api-cli/pkg/keycloak"
 
 	"github.com/spf13/cobra"
+    "github.com/spf13/viper"
 )
 
 
@@ -56,21 +57,27 @@ func DeleteRealmCommand(kcClient *keycloak.KeycloakClient) *cobra.Command {
 // Delete User
 func DeleteUserCommand(kcClient *keycloak.KeycloakClient) *cobra.Command {
     var (
+        realm    string
         userID   string
         username string
     )
 
-    DeleteUserCommand := &cobra.Command{
+    deleteUserCmd := &cobra.Command{
         Use:   "user",
         Short: "Delete a Keycloak user by username",
         Run: func(cmd *cobra.Command, args []string) {
+            // Check if the realm flag is set, else use the default realm
+            realm, _ := cmd.Flags().GetString("realm")
+            if realm == "" {
+                realm = viper.GetString("default_realm")
+            }
             if username == "" && userID == "" {
                 username = askForUserName()
             }
 
             if username != "" {
                 // Use username to retrieve userID
-                retrievedUserID, err := kcClient.GetUserIDByUsername(username)
+                retrievedUserID, err := kcClient.GetUserIDByUsername(realm, username)
                 if err != nil {
                     fmt.Printf("Error retrieving userID for username %s: %v\n", username, err)
                     return
@@ -88,14 +95,18 @@ func DeleteUserCommand(kcClient *keycloak.KeycloakClient) *cobra.Command {
                 return
             }
 
-            if err := kcClient.DeleteUser(userID); err != nil {
+            if err := kcClient.DeleteUser(realm, userID); err != nil {
                 fmt.Printf("Error deleting user: %v\n", err)
             } else {
-                fmt.Printf("User %s (userID: %s) deleted successfully\n", username, userID)
+                fmt.Printf("User %s (userID: %s) deleted successfully in realm %s\n", username, userID, realm)
             }
         },
     }
-    DeleteUserCommand.Flags().StringVarP(&userID, "userid", "i", "", "ID of the user to delete")
-    DeleteUserCommand.Flags().StringVarP(&username, "username", "u", "", "Username of the user to delete")
-    return DeleteUserCommand
+
+    deleteUserCmd.Flags().StringVarP(&realm, "realm", "r", "", "Specify the realm to delete the user")
+    deleteUserCmd.Flags().StringVarP(&userID, "userid", "i", "", "ID of the user to delete")
+    deleteUserCmd.Flags().StringVarP(&username, "username", "u", "", "Username of the user to delete")
+
+    return deleteUserCmd
 }
+
diff --git a/cmd/get.go b/cmd/get.go
@@ -5,6 +5,7 @@ import (
 	"keycloak-api-cli/pkg/keycloak"
 	
 	"github.com/spf13/cobra"
+    "github.com/spf13/viper"
 )
 
 
@@ -42,19 +43,34 @@ func GetRealmCommand(kcClient *keycloak.KeycloakClient) *cobra.Command {
 }
 
 func GetUsersCommand(kcClient *keycloak.KeycloakClient) *cobra.Command {
-    return &cobra.Command{
+    var realm string
+    usersCmd := &cobra.Command{
         Use:   "users",
         Short: "List all users",
         Long:  `List all users in the Keycloak instance.`,
         Run: func(cmd *cobra.Command, args []string) {
-            users, err := kcClient.ListUsers()
+            // Check if the realm flag is set, else use the default realm
+            realm, _ := cmd.Flags().GetString("realm")
+            if realm == "" {
+                realm = viper.GetString("default_realm")
+            }
+
+            // Use the specified or default realm for listing users
+            users, err := kcClient.ListUsers(realm) // Make sure ListUsers accepts a realm parameter
             if err != nil {
-                fmt.Printf("Error listing users: %v\n", err)
+                fmt.Printf("Error listing users in realm %s: %v\n", realm, err)
                 return
             }
+
+            // Iterate and print details of each user
             for _, user := range users {
-				fmt.Printf("Realm: %s, User Name: %s, User ID: %s\n",kcClient.RealmToEdit, user.Username, user.ID)
+                fmt.Printf("Realm: %s, User Name: %s, User ID: %s\n", realm, user.Username, user.ID)
             }
         },
     }
+
+    // Attach the realm flag to the command
+    usersCmd.Flags().StringVarP(&realm, "realm", "r", "", "Specify the realm to list users")
+
+    return usersCmd
 }
diff --git a/example-config.yaml b/example-config.yaml
@@ -4,4 +4,4 @@ client_secret:
 username: admin
 password: admin
 auth_realm: master
-realm_to_edit: master
+default_realm: master
diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -11,7 +11,7 @@ type KeycloakConfig struct {
     Username     string `mapstructure:"username"`
     Password     string `mapstructure:"password"`
     AuthRealm    string `mapstructure:"auth_realm"`
-    RealmToEdit  string `mapstructure:"realm_to_edit"`
+    DefaultRealm  string `mapstructure:"default_realm"`
 }
 
 // LoadConfig loads configuration from config.yaml
diff --git a/pkg/config/config_test.go b/pkg/config/config_test.go
@@ -45,8 +45,8 @@ func TestLoadConfig(t *testing.T) {
         ClientSecret: "secret",
         Username:     "user",
         Password:     "pass",
-        AuthRealm:        "realm-test",
-        RealmToEdit:  "realm-test",
+        AuthRealm:    "realm-test",
+        DefaultRealm:  "realm-test",
     }
 
     // Compare the result with the expected configuration
diff --git a/pkg/keycloak/client.go b/pkg/keycloak/client.go
@@ -18,7 +18,7 @@ type KeycloakClient struct {
     Client     *http.Client
     Token      string
     AuthRealm  string
-    RealmToEdit string
+    DefaultRealm string
 }
 
 // NewClient creates a new instance of KeycloakClient
@@ -29,7 +29,7 @@ func NewClient(cfg config.KeycloakConfig) *KeycloakClient {
             Timeout: time.Second * 30,
         },
         AuthRealm: cfg.AuthRealm,
-        RealmToEdit: cfg.RealmToEdit,
+        DefaultRealm: cfg.DefaultRealm,
     }
 }
 
diff --git a/pkg/keycloak/users.go b/pkg/keycloak/users.go
@@ -17,10 +17,10 @@ type User struct {
 }
 
 // CreateUser creates a new user in Keycloak
-func (kc *KeycloakClient) CreateUser(username, email, password string) error {
+func (kc *KeycloakClient) CreateUser(realm, username, email, password string) error {
     userDetails := struct {
-        Username   string `json:"username"`
-        Email      string `json:"email"`
+        Username    string `json:"username"`
+        Email       string `json:"email"`
         Credentials []struct {
             Type      string `json:"type"`
             Value     string `json:"value"`
@@ -35,13 +35,15 @@ func (kc *KeycloakClient) CreateUser(username, email, password string) error {
             Temporary bool   `json:"temporary"`
         }{
             {
-                Type:  "password",
-                Value: password,
+                Type:      "password",
+                Value:     password,
+                Temporary: false, // Set to true if you want the user to change password on first login
             },
         },
     }
 
-    url := fmt.Sprintf("%s/admin/realms/%s/users", kc.BaseURL, kc.RealmToEdit)
+    // Use the provided realm in the URL instead of the default realm
+    url := fmt.Sprintf("%s/admin/realms/%s/users", kc.BaseURL, realm)
 
     // Encode the user details as JSON for the request body
     jsonBody, err := json.Marshal(userDetails)
@@ -67,15 +69,17 @@ func (kc *KeycloakClient) CreateUser(username, email, password string) error {
     // Check for successful status code, typically 201 for creation
     if res.StatusCode != http.StatusCreated {
         errorResponse, _ := ioutil.ReadAll(res.Body)
-        return fmt.Errorf("failed to create user, received status code: %d, error message: %s", res.StatusCode, errorResponse)
+        return fmt.Errorf("failed to create user in realm %s, received status code: %d, error message: %s", realm, res.StatusCode, string(errorResponse))
     }
 
     return nil
 }
 
-// ListUsers lists all users in Keycloak
-func (kc *KeycloakClient) ListUsers() ([]User, error) {
-    url := fmt.Sprintf("%s/admin/realms/%s/users", kc.BaseURL, kc.RealmToEdit)
+
+func (kc *KeycloakClient) ListUsers(realm string) ([]User, error) {
+    // Use the provided realm in the URL instead of the default realm
+    url := fmt.Sprintf("%s/admin/realms/%s/users", kc.BaseURL, realm)
+
     req, err := http.NewRequest("GET", url, nil)
     if err != nil {
         return nil, err
@@ -97,8 +101,9 @@ func (kc *KeycloakClient) ListUsers() ([]User, error) {
     return users, nil
 }
 
-func (kc *KeycloakClient) DeleteUser(userID string) error {
-    url := fmt.Sprintf("%s/admin/realms/%s/users/%s", kc.BaseURL, kc.RealmToEdit, userID)
+
+func (kc *KeycloakClient) DeleteUser(realm, userID string) error {
+    url := fmt.Sprintf("%s/admin/realms/%s/users/%s", kc.BaseURL, realm, userID)
 
     req, err := http.NewRequest("DELETE", url, nil)
     if err != nil {
@@ -112,19 +117,19 @@ func (kc *KeycloakClient) DeleteUser(userID string) error {
     }
     defer res.Body.Close()
 
-    // Check for successful status code, typically 204 for successful deletion
     if res.StatusCode != http.StatusNoContent {
         errorResponse, _ := ioutil.ReadAll(res.Body)
-        return fmt.Errorf("failed to delete user, received status code: %d, error message: %s", res.StatusCode, errorResponse)
+        return fmt.Errorf("failed to delete user in realm %s, received status code: %d, error message: %s", realm, res.StatusCode, string(errorResponse))
     }
 
     return nil
 }
 
 
+
 // GetUserIDByUsername retrieves the userID based on the provided username
-func (kc *KeycloakClient) GetUserIDByUsername(username string) (string, error) {
-    url := fmt.Sprintf("%s/admin/realms/%s/users", kc.BaseURL, kc.RealmToEdit)
+func (kc *KeycloakClient) GetUserIDByUsername(realm, username string) (string, error) {
+    url := fmt.Sprintf("%s/admin/realms/%s/users", kc.BaseURL, realm)
 
     req, err := http.NewRequest("GET", url, nil)
     if err != nil {
@@ -140,23 +145,21 @@ func (kc *KeycloakClient) GetUserIDByUsername(username string) (string, error) {
 
     if res.StatusCode != http.StatusOK {
         errorResponse, _ := ioutil.ReadAll(res.Body)
-        return "", fmt.Errorf("failed to retrieve users, received status code: %d, error message: %s", res.StatusCode, errorResponse)
+        return "", fmt.Errorf("failed to retrieve users from realm %s, received status code: %d, error message: %s", realm, res.StatusCode, string(errorResponse))
     }
 
-    // Read the response body and parse it as an array of User objects
     var users []User
     err = json.NewDecoder(res.Body).Decode(&users)
     if err != nil {
         return "", err
     }
 
-    // Search for the user with the matching username
     for _, user := range users {
         if user.Username == username {
             return user.ID, nil
         }
     }
 
-    // If no matching user is found, return an error
-    return "", fmt.Errorf("user with username %s not found in %s realm", username, kc.RealmToEdit)
+    return "", fmt.Errorf("user with username %s not found in realm %s", username, realm)
 }
+

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ type KeycloakConfig struct {`
`11`	`11`	Username string `mapstructure:"username"`
`12`	`12`	Password string `mapstructure:"password"`
`13`	`13`	AuthRealm string `mapstructure:"auth_realm"`
`14`		- RealmToEdit string `mapstructure:"realm_to_edit"`
	`14`	+ DefaultRealm string `mapstructure:"default_realm"`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`// LoadConfig loads configuration from config.yaml`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ type KeycloakClient struct {`
`18`	`18`	`Client *http.Client`
`19`	`19`	`Token string`
`20`	`20`	`AuthRealm string`
`21`		`- RealmToEdit string`
	`21`	`+ DefaultRealm string`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`// NewClient creates a new instance of KeycloakClient`
`@@ -29,7 +29,7 @@ func NewClient(cfg config.KeycloakConfig) *KeycloakClient {`
`29`	`29`	`Timeout: time.Second * 30,`
`30`	`30`	`},`
`31`	`31`	`AuthRealm: cfg.AuthRealm,`
`32`		`- RealmToEdit: cfg.RealmToEdit,`
	`32`	`+ DefaultRealm: cfg.DefaultRealm,`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`