Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Add whoami command docs #316

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ You would expect to see no error in your logs and the messages **Yes I am alive*

If that's the case, enter any of the following commands:
* `help`. Show available commands
* `whoami`. Show the user profile and the SDM Account details
* `show available resources [--filter expression]`. Show available resources - all or a filtered subset. Filters are optional.
Please refer to the following [doc](https://www.strongdm.com/docs/automation/getting-started/filters) for getting the list of available filters.
* `access to resource-name [--reason text] [--duration duration]`. Grant temporary access to a resource. Reason and Duration are optional.
Expand Down
4 changes: 3 additions & 1 deletion docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Frequently Asked Questions


## Can a user request and grant access to resources to themselves? (like in the gif)
Not really, what you see in the gif happens because the requester is the bot admin. The normal flow is actually what you’d expect: user x requests access, and users y or z (bot admins) approve.
You might want to take a look at the [ACCESS_CONFIGURATION](ACCESS_CONFIGURATION.md) - _specially the possible workflows_
Expand All @@ -23,3 +22,6 @@ Invite AccessBot to your private channel and add the scope `usergroups:read` to

## How can I get my AccessBot version?
Send the following direct message to the Bot: `plugin config AccessBot`

## How can I get my profile details?
Send the following direct message to the Bot: `whoami`. It'll show you the details of your Slack account and SDM Account.
4 changes: 3 additions & 1 deletion docs/TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ It's likely the `SDM_ACCESS_FORM_BOT_NICKNAME` is not set or has been set incorr

<details><Summary><code>"Sorry, cannot find your account!"</code></Summary>

The email field (or the field set in `SDM_EMAIL_SLACK_FIELD` *must* match exactly with an email that identifies a user in strongDM. Verify that there are no differences between the two.
The email field (or the field set in `SDM_EMAIL_SLACK_FIELD`) *must* match exactly with an email that identifies a user in strongDM. Verify that there are no differences between the two.

You can use the `whoami` command to see your profile details, including the status of your SDM Account.

</details>

Expand Down