Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit atlassian provider help #4452

Merged
merged 1 commit into from
Jul 30, 2024
Merged

Edit atlassian provider help #4452

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions providers/atlassian/config/config.go
View file
Open in desktop
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
Loading