Skip to content

Commit a7378dd

Browse files
authored
docs(iam): revamp IAM (#2869)
1 parent 303152f commit a7378dd

File tree

40 files changed

+347
-347
lines changed

40 files changed

+347
-347
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Create an API key.
3+
Create an API key. You must specify the `application_id` or the `user_id` and the description. You can also specify the `default_project_id` which is the Project ID of your preferred Project, to use with Object Storage. The `access_key` and `secret_key` values are returned in the response. Note that he secret key is only showed once. Make sure that you copy and store both keys somewhere safe.
44

55
USAGE:
66
scw iam api-key create [arg=value ...]
77

88
ARGS:
9-
[application-id] ID of application principal
10-
[user-id] ID of user principal
9+
[application-id] ID of the application
10+
[user-id] ID of the user
1111
[expires-at] Expiration date of the API key
12-
[default-project-id] The default project ID to use with object storage
13-
[description] The description of the API key (max length is 200 chars)
12+
[default-project-id] The default Project ID to use with Object Storage
13+
[description] The description of the API key (max length is 200 characters)
1414

1515
FLAGS:
1616
-h, --help help for create

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Delete an API key.
3+
Delete an API key. Note that this action is irreversible and cannot be undone. Make sure you update any configurations using the API keys you delete.
44

55
USAGE:
66
scw iam api-key delete <access-key ...> [arg=value ...]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get an API key.
3+
Retrive information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation.
44

55
USAGE:
66
scw iam api-key get <access-key ...> [arg=value ...]

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List API keys.
3+
List API keys. By default, the API keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `editable`, `expired`, `access_key` and `bearer_id`.
44

55
USAGE:
66
scw iam api-key list [arg=value ...]
77

88
ARGS:
99
[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)
10-
[editable] Filter out editable API keys or not
11-
[expired] Filter out expired API keys or not
12-
[access-key] Filter out by access key
13-
[description] Filter out by description
14-
[bearer-id] Filter out by bearer ID
15-
[bearer-type] Filter out by type of bearer (unknown_bearer_type | user | application)
16-
organization-id=<retrieved from config> ID of organization
10+
[editable] Whether to filter out editable API keys or not
11+
[expired] Whether to filter out expired API keys or not
12+
[access-key] Filter by access key
13+
[description] Filter by description
14+
[bearer-id] Filter by bearer ID
15+
[bearer-type] Filter by type of bearer (unknown_bearer_type | user | application)
16+
organization-id=<retrieved from config> ID of Organization
1717

1818
DEPRECATED ARGS:
19-
[application-id] ID of an application bearer
20-
[user-id] ID of a user bearer
19+
[application-id] ID of application that bears the API key
20+
[user-id] ID of user that bears the API key
2121

2222
FLAGS:
2323
-h, --help help for list

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Update an API key.
3+
Update the parameters of an API key, including `default_project_id` and `description`.
44

55
USAGE:
66
scw iam api-key update <access-key ...> [arg=value ...]
77

88
ARGS:
99
access-key Access key to update
10-
[default-project-id] The new default project ID to set
10+
[default-project-id] The new default Project ID to set
1111
[description] The new description to update
1212

1313
FLAGS:

cmd/scw/testdata/test-all-usage-iam-application-create-usage.golden

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Create a new application.
3+
Create a new application. You must define the `name` parameter in the request.
44

55
USAGE:
66
scw iam application create [arg=value ...]
77

88
ARGS:
9-
name=<generated> Name of application to create (max length is 64 chars)
10-
[description] Description of application (max length is 200 chars)
9+
name=<generated> Name of the application to create (max length is 64 characters)
10+
[description] Description of the application (max length is 200 characters)
1111
[organization-id] Organization ID to use. If none is passed the default organization ID will be used
1212

1313
FLAGS:

cmd/scw/testdata/test-all-usage-iam-application-delete-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Delete an application.
3+
Delete an application. Note that this action is irreversible and will automatically delete the application's API keys. Policies attached to users and applications via this group will no longer apply.
44

55
USAGE:
66
scw iam application delete <application-id ...> [arg=value ...]
77

88
ARGS:
9-
application-id ID of application to delete
9+
application-id ID of the application to delete
1010

1111
FLAGS:
1212
-h, --help help for delete

cmd/scw/testdata/test-all-usage-iam-application-get-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get an existing application.
3+
Retrieve information about an application, specified by the `application_id` parameter. The application's full details, including `id`, `email`, `organization_id`, `status` and `two_factor_enabled` are returned in the response.
44

55
USAGE:
66
scw iam application get <application-id ...> [arg=value ...]
77

88
ARGS:
9-
application-id ID of application to find
9+
application-id ID of the application to find
1010

1111
FLAGS:
1212
-h, --help help for get

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List applications of an organization.
3+
List the applications of an Organization. By default, the applications listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `application_ids`.
44

55
USAGE:
66
scw iam application list [arg=value ...]
77

88
ARGS:
99
[order-by=created_at_asc] Criteria for sorting results (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | name_asc | name_desc)
10-
[name] Name of application to filter
11-
[editable] Filter out editable applications or not
12-
[application-ids.{index}] Filter out by a list of ID
13-
organization-id=<retrieved from config> ID of organization to filter
10+
[name] Name of the application to filter
11+
[editable] Whether to filter out editable applications or not
12+
[application-ids.{index}] Filter by list of IDs
13+
organization-id=<retrieved from config> ID of the Organization to filter
1414

1515
FLAGS:
1616
-h, --help help for list

cmd/scw/testdata/test-all-usage-iam-application-update-usage.golden

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Update an existing application.
3+
Update the parameters of an application, including `name` and `description`.
44

55
USAGE:
66
scw iam application update <application-id ...> [arg=value ...]
77

88
ARGS:
9-
application-id ID of application to update
10-
[name] New name of application (max length is 64 chars)
11-
[description] New description of application (max length is 200 chars)
9+
application-id ID of the application to update
10+
[name] New name for the application (max length is 64 chars)
11+
[description] New description for the application (max length is 200 chars)
1212

1313
FLAGS:
1414
-h, --help help for update

0 commit comments

Comments
 (0)