Skip to content

Commit

Permalink
Edit atlassian provider help (#4452)
Browse files Browse the repository at this point in the history
  • Loading branch information
misterpantz authored Jul 30, 2024
1 parent 2897855 commit 7cee14b
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions providers/atlassian/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,24 @@ var Config = plugin.Provider{
Name: "atlassian",
Use: "atlassian",
Short: "an Atlassian Cloud Jira, Confluence or Bitbucket instance",
Long: `atlassian is designed for querying resources within Atlassian Cloud, including Jira, Confluence, and SCIM.
Long: `Use the atlassian provider to query 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.
admin Atlassian administrative instance
jira Jira instance
confluence Confluence instance
scim SCIM instance
Examples:
cnquery shell atlassian admin --admin-token <token>
cnquery shell atlassian jira --host <host> --user <user> --user-token <token>
cnquery shell atlassian confluence --host <host> --user <user> --user-token <token>
cnquery shell atlassian scim <directory-id> --scim-token <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.
If you set the ATLASSIAN_ADMIN_TOKEN environment, you can omit the admin-token flag. If you set the ATLASSIAN_USER,
ATLASSIAN_HOST, and ATLASSIAN_USER_TOKEN environment variables, you can omit the user, host, and user-token flags.
For SCIM, you receive both the token and the directory-id from Atlassian when you setup an identity provider.
For the SCIM token and the directory-id values: Atlassian provides these values when you set up an identity provider.
`,
MaxArgs: 2,
Discovery: []string{},
Expand All @@ -69,7 +69,7 @@ For SCIM, you receive both the token and the directory-id from Atlassian when yo
Long: "user-token",
Type: plugin.FlagType_String,
Default: "",
Desc: "Atlassian user API token (used for Jira / Confluence)",
Desc: "Atlassian user API token (used for Jira or Confluence)",
},
{
Long: "scim-token",
Expand Down

0 comments on commit 7cee14b

Please sign in to comment.