Skip to content

Commit 1de3089

Browse files
feat: add docs for github_user_ssh_signing_key
1 parent e9b624e commit 1de3089

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: "github"
3+
page_title: "GitHub: github_user_ssh_signing_key"
4+
description: |-
5+
Provides a GitHub user's SSH signing key resource.
6+
---
7+
8+
# github_user_ssh_signing_key
9+
10+
Provides a GitHub user's SSH signing key resource.
11+
12+
This resource allows you to add/remove SSH signing keys from your user account.
13+
14+
## Example Usage
15+
16+
```hcl
17+
resource "github_user_ssh_signing_key" "example" {
18+
title = "example title"
19+
key = file("~/.ssh/id_rsa.pub")
20+
}
21+
```
22+
23+
## Argument Reference
24+
25+
The following arguments are supported:
26+
27+
* `title` - (Required) A descriptive name for the new key. e.g. `Personal MacBook Air`
28+
* `key` - (Required) The public SSH signing key to add to your GitHub account.
29+
30+
## Attributes Reference
31+
32+
The following attributes are exported:
33+
34+
* `id` - The ID of the SSH signing key
35+
36+
## Import
37+
38+
SSH signing keys can be imported using their ID e.g.
39+
40+
```
41+
$ terraform import github_user_ssh_signing_key.example 1234567
42+
```

0 commit comments

Comments
 (0)