Skip to content

Commit 3944748

Browse files
committed
"make generate-docs" -> docs
1 parent 4926c6d commit 3944748

File tree

6 files changed

+204
-0
lines changed

6 files changed

+204
-0
lines changed

docs/stackit_auth.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ stackit auth [flags]
3131

3232
* [stackit](./stackit.md) - Manage STACKIT resources using the command line
3333
* [stackit auth activate-service-account](./stackit_auth_activate-service-account.md) - Authenticates using a service account
34+
* [stackit auth api](./stackit_auth_api.md) - Manages authentication for the STACKIT Terraform Provider and SDK
3435
* [stackit auth get-access-token](./stackit_auth_get-access-token.md) - Prints a short-lived access token.
3536
* [stackit auth login](./stackit_auth_login.md) - Logs in to the STACKIT CLI
3637
* [stackit auth logout](./stackit_auth_logout.md) - Logs the user account out of the STACKIT CLI

docs/stackit_auth_api.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## stackit auth api
2+
3+
Manages authentication for the STACKIT Terraform Provider and SDK
4+
5+
### Synopsis
6+
7+
Manages authentication for the STACKIT Terraform Provider and SDK.
8+
9+
These commands allow you to authenticate with your personal STACKIT account
10+
and share the credentials with the STACKIT Terraform Provider and SDK.
11+
This provides an alternative to using service accounts for local development.
12+
13+
```
14+
stackit auth api [flags]
15+
```
16+
17+
### Options
18+
19+
```
20+
-h, --help Help for "stackit auth api"
21+
```
22+
23+
### Options inherited from parent commands
24+
25+
```
26+
-y, --assume-yes If set, skips all confirmation prompts
27+
--async If set, runs the command asynchronously
28+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
29+
-p, --project-id string Project ID
30+
--region string Target region for region-specific requests
31+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
32+
```
33+
34+
### SEE ALSO
35+
36+
* [stackit auth](./stackit_auth.md) - Authenticates the STACKIT CLI
37+
* [stackit auth api get-access-token](./stackit_auth_api_get-access-token.md) - Prints a short-lived access token for the STACKIT Terraform Provider and SDK
38+
* [stackit auth api login](./stackit_auth_api_login.md) - Logs in for the STACKIT Terraform Provider and SDK
39+
* [stackit auth api logout](./stackit_auth_api_logout.md) - Logs out from the STACKIT Terraform Provider and SDK
40+
* [stackit auth api status](./stackit_auth_api_status.md) - Shows authentication status for the STACKIT Terraform Provider and SDK
41+
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## stackit auth api get-access-token
2+
3+
Prints a short-lived access token for the STACKIT Terraform Provider and SDK
4+
5+
### Synopsis
6+
7+
Prints a short-lived access token for the STACKIT Terraform Provider and SDK which can be used e.g. for API calls.
8+
9+
```
10+
stackit auth api get-access-token [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Print a short-lived access token for the STACKIT Terraform Provider and SDK
17+
$ stackit auth api get-access-token
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit auth api get-access-token"
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
-y, --assume-yes If set, skips all confirmation prompts
30+
--async If set, runs the command asynchronously
31+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
32+
-p, --project-id string Project ID
33+
--region string Target region for region-specific requests
34+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
35+
```
36+
37+
### SEE ALSO
38+
39+
* [stackit auth api](./stackit_auth_api.md) - Manages authentication for the STACKIT Terraform Provider and SDK
40+

docs/stackit_auth_api_login.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## stackit auth api login
2+
3+
Logs in for the STACKIT Terraform Provider and SDK
4+
5+
### Synopsis
6+
7+
Logs in for the STACKIT Terraform Provider and SDK using a user account.
8+
The authentication is done via a web-based authorization flow, where the command will open a browser window in which you can login to your STACKIT account.
9+
The credentials are stored separately from the CLI authentication and will be used by the STACKIT Terraform Provider and SDK.
10+
11+
```
12+
stackit auth api login [flags]
13+
```
14+
15+
### Examples
16+
17+
```
18+
Login for the STACKIT Terraform Provider and SDK. This command will open a browser window where you can login to your STACKIT account
19+
$ stackit auth api login
20+
```
21+
22+
### Options
23+
24+
```
25+
-h, --help Help for "stackit auth api login"
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-y, --assume-yes If set, skips all confirmation prompts
32+
--async If set, runs the command asynchronously
33+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
34+
-p, --project-id string Project ID
35+
--region string Target region for region-specific requests
36+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
37+
```
38+
39+
### SEE ALSO
40+
41+
* [stackit auth api](./stackit_auth_api.md) - Manages authentication for the STACKIT Terraform Provider and SDK
42+

docs/stackit_auth_api_logout.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## stackit auth api logout
2+
3+
Logs out from the STACKIT Terraform Provider and SDK
4+
5+
### Synopsis
6+
7+
Logs out from the STACKIT Terraform Provider and SDK. This does not affect CLI authentication.
8+
9+
```
10+
stackit auth api logout [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Log out from the STACKIT Terraform Provider and SDK
17+
$ stackit auth api logout
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit auth api logout"
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
-y, --assume-yes If set, skips all confirmation prompts
30+
--async If set, runs the command asynchronously
31+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
32+
-p, --project-id string Project ID
33+
--region string Target region for region-specific requests
34+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
35+
```
36+
37+
### SEE ALSO
38+
39+
* [stackit auth api](./stackit_auth_api.md) - Manages authentication for the STACKIT Terraform Provider and SDK
40+

docs/stackit_auth_api_status.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## stackit auth api status
2+
3+
Shows authentication status for the STACKIT Terraform Provider and SDK
4+
5+
### Synopsis
6+
7+
Shows authentication status for the STACKIT Terraform Provider and SDK, including whether you are authenticated and with which account.
8+
9+
```
10+
stackit auth api status [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Show authentication status for the STACKIT Terraform Provider and SDK
17+
$ stackit auth api status
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit auth api status"
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
-y, --assume-yes If set, skips all confirmation prompts
30+
--async If set, runs the command asynchronously
31+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
32+
-p, --project-id string Project ID
33+
--region string Target region for region-specific requests
34+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
35+
```
36+
37+
### SEE ALSO
38+
39+
* [stackit auth api](./stackit_auth_api.md) - Manages authentication for the STACKIT Terraform Provider and SDK
40+

0 commit comments

Comments
 (0)