Skip to content

Commit 2b3b359

Browse files
docs(polykey): refine identity authentication and claim process details
Update the documentation to enhance clarity and accuracy in the identity authentication and claim sections. Include detailed command usage, provide examples for verifying authenticated identities, and adjust the descriptions to better explain the management of multiple identities across nodes and IdPs. Improve navigational instructions for gist verification and incorporate feedback on security and privacy considerations.
1 parent 16b7052 commit 2b3b359

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

docs/tutorials/polykey-cli/claiming-digital-identities.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,23 @@ This command begins the authentication process with GitHub. Follow the prompts i
3838
The code prompted by the browser will be displayed in your terminal as the user code.
3939
:::
4040

41+
### Lists all authenticated identities across all providers
42+
43+
`polykey identities authenticated` command will output the providerID and corresponding identityID of the authenticated IdP. This is a way to check that you completed the authentication process correctly.
44+
45+
#### Example Usage
46+
47+
```bash
48+
polykey identities authenticated
49+
```
50+
51+
##### Example Output
52+
53+
```bash
54+
providerId github.com
55+
identityId maverick
56+
```
57+
4158
### Technical Use of Permissions
4259

4360
During the authentication process, here's what Polykey requests access to and why:
@@ -86,26 +103,14 @@ _This image shows a demo example of the link to the gist that was created when c
86103

87104
### Primary Verification Method
88105

89-
Navigate directly to the provided gist link:
106+
Check your GH gists. Replace `my-github-username` with your actual gh username and navigate to the url.
90107

91108
```bash
92109
https://gist.github.com/my-github-username
93110
```
94111

95112
This gist contains the cryptographic link confirming that your Polykey identity is correctly linked to your GitHub profile. Viewing this gist ensures your claim was successful and publicly verifiable.
96113

97-
### Additional Verification Options
98-
99-
While navigating to the gist is sufficient for most users, Polykey also offers ways to internally verify the identity claim:
100-
101-
- **Polykey Gestalt List:** You can list all gestalts, including your own, to see the internal record of your claim.
102-
103-
```bash
104-
polykey identities list
105-
```
106-
107-
This command shows details about your claimed identities and connected nodes, providing an extra layer of verification.
108-
109114
## Understanding Gestalt Graphs
110115

111116
In Polykey, claiming identities creates a **gestalt graph**—a dynamic, interconnected network of your digital identities across various platforms. This graph facilitates the federated identity model, allowing for more robust and streamlined identity verification and management.
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
2-
# Discovering Other Users
1+
# Discovering Users' Nodes and Managing Access Permissions

0 commit comments

Comments
 (0)