feat(iam): add more filtering options for ListAPIKeys (#2773)

Author: scaleway-bot

cmd/scw/testdata/test-all-usage-iam-api-key-list-usage.golden

@@ -7,11 +7,18 @@ USAGE:
 
 ARGS:
   [order-by=created_at_asc]                 Criteria for sorting results (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | expires_at_asc | expires_at_desc | access_key_asc | access_key_desc)
-  [application-id]                          ID of an application bearer
-  [user-id]                                 ID of a user bearer
   [editable]                                Filter out editable API keys or not
+  [expirable]                               Filter out expirable API keys or not
+  [access-key]                              Filter out by access key
+  [description]                             Filter out by description
+  [bearer-id]                               Filter out by bearer ID
+  [bearer-type]                             Filter out by type of bearer (unknown_bearer_type | user | application)
   organization-id=<retrieved from config>   ID of organization
 
+DEPRECATED ARGS:
+  [application-id]   ID of an application bearer
+  [user-id]          ID of a user bearer
+
 FLAGS:
   -h, --help   help for list
 

docs/commands/iam.md

@@ -137,9 +137,14 @@ scw iam api-key list [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | order-by | Default: `created_at_asc`<br />One of: `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc`, `expires_at_asc`, `expires_at_desc`, `access_key_asc`, `access_key_desc` | Criteria for sorting results |
-| application-id |  | ID of an application bearer |
-| user-id |  | ID of a user bearer |
+| ~~application-id~~ | Deprecated | ID of an application bearer |
+| ~~user-id~~ | Deprecated | ID of a user bearer |
 | editable |  | Filter out editable API keys or not |
+| expirable |  | Filter out expirable API keys or not |
+| access-key |  | Filter out by access key |
+| description |  | Filter out by description |
+| bearer-id |  | Filter out by bearer ID |
+| bearer-type | One of: `unknown_bearer_type`, `user`, `application` | Filter out by type of bearer |
 | organization-id | Required<br />Default: `<retrieved from config>` | ID of organization |
 
 

go.mod

@@ -18,7 +18,7 @@ require (
 	github.com/kubernetes-client/go-base v0.0.0-20190205182333-3d0e39759d98
 	github.com/mattn/go-colorable v0.1.13
 	github.com/mattn/go-isatty v0.0.17
-	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.13.0.20230207201808-d7c376325ea7
+	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.13.0.20230214124406-206d0c86a6ac
 	github.com/spf13/cobra v1.6.1
 	github.com/spf13/pflag v1.0.5
 	github.com/stretchr/testify v1.8.1

go.sum

@@ -70,8 +70,8 @@ github.com/pkg/term v1.1.0/go.mod h1:E25nymQcrSllhX42Ok8MRm1+hyBdHY0dCeiKZ9jpNGw
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.13.0.20230207201808-d7c376325ea7 h1:9oCbSGqqRkgpLqslbSEMatAY1U+ZLFls4kUQmHn4jJo=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.13.0.20230207201808-d7c376325ea7/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.13.0.20230214124406-206d0c86a6ac h1:sGWtu+QWecPOfbuOPHE4kVCNqG68mI0CazQaw98p9ew=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.13.0.20230214124406-206d0c86a6ac/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
 github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ=
 github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
 github.com/spf13/cobra v1.6.1 h1:o94oiPyS4KD1mPy2fmcYYHHfCxLqYjJOhGsCHFZtEzA=

internal/namespaces/iam/v1alpha1/iam_cli.go

@@ -1544,14 +1544,14 @@ func iamAPIKeyList() *core.Command {
 				Name:       "application-id",
 				Short:      `ID of an application bearer`,
 				Required:   false,
-				Deprecated: false,
+				Deprecated: true,
 				Positional: false,
 			},
 			{
 				Name:       "user-id",
 				Short:      `ID of a user bearer`,
 				Required:   false,
-				Deprecated: false,
+				Deprecated: true,
 				Positional: false,
 			},
 			{
@@ -1561,6 +1561,42 @@ func iamAPIKeyList() *core.Command {
 				Deprecated: false,
 				Positional: false,
 			},
+			{
+				Name:       "expirable",
+				Short:      `Filter out expirable API keys or not`,
+				Required:   false,
+				Deprecated: false,
+				Positional: false,
+			},
+			{
+				Name:       "access-key",
+				Short:      `Filter out by access key`,
+				Required:   false,
+				Deprecated: false,
+				Positional: false,
+			},
+			{
+				Name:       "description",
+				Short:      `Filter out by description`,
+				Required:   false,
+				Deprecated: false,
+				Positional: false,
+			},
+			{
+				Name:       "bearer-id",
+				Short:      `Filter out by bearer ID`,
+				Required:   false,
+				Deprecated: false,
+				Positional: false,
+			},
+			{
+				Name:       "bearer-type",
+				Short:      `Filter out by type of bearer`,
+				Required:   false,
+				Deprecated: false,
+				Positional: false,
+				EnumValues: []string{"unknown_bearer_type", "user", "application"},
+			},
 			{
 				Name:       "organization-id",
 				Short:      `ID of organization`,