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.

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

Update README.md #2

Merged
merged 2 commits into from
Jun 12, 2019
Merged

Update README.md #2

merged 2 commits into from
Jun 12, 2019

Conversation

dtf0
Copy link
Contributor

@dtf0 dtf0 commented Jun 3, 2019

  • Add info about OAuth fields after commit 4283733
  • Add new sections to example ~/.zdeskcfg showing authentication via password & OAuth-token
  • Change API token length to 40 chars to match length of tokens generated from Zendesk admin console

- Add info about OAuth fields after commit 4283733
- Add new sections to example `~/.zdeskcfg` showing authentication via password & OAuth-token
- Change API token length to 40 chars to match length of tokens generated from Zendesk admin console
@fprimex
Copy link
Owner

fprimex commented Jun 5, 2019

Hi! Thanks for the PR. This info does need to be added. I think I would like to see the examples split into their own example files rather than one "An example file", with each having the [zdesk] section and the settings being demonstrated. Then, if desired, put a 4th file example with a [zdesk] and, say, [acme] sections. Let me know what you think.

@dtf0
Copy link
Contributor Author

dtf0 commented Jun 6, 2019

Hey, thanks for the suggestions (and for adding the OAuth functionality in the first place). That all sounds good to me!

How about something like this? I've also changed acme to sandbox to hopefully keep it less confusing.

Example contents of ~/.zdeskcfg, separated by method of authentication:

[zdesk]
url = https://zdesk.zendesk.com
email = you@example.com
password = Z€Nd3$k
token = 0
[zdesk]
url = https://zdesk.zendesk.com
email = you@example.com
password = f4Pe8DBBK4K674Au7ffcp1j5t2mG7z4e1wvQE6CZ
token = 1

# note: the `token` field must be set to `1` for API auth
[zdesk]
url = https://zdesk.zendesk.com
oauth = 7c6cbb4eac23cd03cf5d9b67ad23993cfb55e2f9049799adac9ada2e69567959

# note: the `email` field may be omitted because the token also contains user
# identification
  • Add production and sandbox credentials under separate sections, call via the
    name of each [section] (e.g. zdeskcfg.get_config(section='sandbox'))
[zdesk]
url = https://zdesk.zendesk.com
oauth = d768ab1e418e2f2498e2c862843591972697603efb1cc806d2be62de60e857cd

[sandbox]
url = https://zdesk1865746743.zendesk.com
email = you@example.com
password = QCR6dWzbQ9z85D3kh6GWBHBNe6LbZk4n36eZ5x88
token = 1

@fprimex
Copy link
Owner

fprimex commented Jun 8, 2019

That looks perfect. Can you commit and push that into the PR? I'll merge it once it's in there.

- Separate methods of authentication to their own sections
- Add links to Zendesk help centre for each authentication method
@fprimex
Copy link
Owner

fprimex commented Jun 12, 2019

Thanks for the contribution!

@fprimex fprimex merged commit 3def554 into fprimex:master Jun 12, 2019
@dtf0 dtf0 deleted the dtf0-patch-0 branch July 7, 2019 14:33
@dtf0 dtf0 restored the dtf0-patch-0 branch July 7, 2019 15:30
@dtf0 dtf0 deleted the dtf0-patch-0 branch May 9, 2023 07:53
@dtf0 dtf0 restored the dtf0-patch-0 branch May 9, 2023 10:11
@dtf0 dtf0 deleted the dtf0-patch-0 branch May 9, 2023 21:42
@dtf0 dtf0 restored the dtf0-patch-0 branch May 9, 2023 22:11
@dtf0 dtf0 deleted the dtf0-patch-0 branch May 9, 2023 23:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants