diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index 5233695cf1..0410ecda13 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -13,6 +13,7 @@ cryptokey customresources datapath Ddos +DIRECTORYID dfw dlq ekm diff --git a/providers/atlassian/config/config.go b/providers/atlassian/config/config.go index dd2fa79681..4756f07ce7 100644 --- a/providers/atlassian/config/config.go +++ b/providers/atlassian/config/config.go @@ -21,9 +21,28 @@ var Config = plugin.Provider{ }, Connectors: []plugin.Connector{ { - Name: "atlassian", - Use: "atlassian", - Short: "Atlassian", + Name: "atlassian", + Use: "atlassian", + Short: "Atlassian", + Long: `atlassian is designed for querying resources within Atlassian Cloud, including Jira, Confluence, and SCIM. + +Available Commands: + admin Specifies the Atlassian admin to interact with. + jira Specifies the Jira instance to interact with. + confluence Specifies the Confluence instance to interact with. + scim Specifies the SCIM instance to interact with. + +Examples: + cnquery shell atlassian admin --admin-token + cnquery shell atlassian jira --host --user --user-token + cnquery shell atlassian confluence --host --user --user-token + cnquery shell atlassian scim --scim-token + +If the ATLASSIAN_ADMIN_TOKEN environment variable is set, the admin-token flag is not required. If the ATLASSIAN_USER, +ATLASSIAN_HOST, and ATLASSIAN_USER_TOKEN environment variables are set, the user, host, and user-token flags are not required. + +For scim, you receive both the token and the directory-id from atlassian when you setup an identity provider. +`, MaxArgs: 2, Discovery: []string{}, Flags: []plugin.Flag{