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

adds Authentication page content #48

Merged
merged 2 commits into from
Oct 18, 2024
Merged

adds Authentication page content #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56d34eb
adds Authentication page content
jeanmartin Oct 18, 2024
df48260
changes link about auth to the new API docs
jeanmartin Oct 18, 2024
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
14 changes: 13 additions & 1 deletion src/pages/docs/features/authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,16 @@ title: Authentication
description: Authenticating your users with Cirro.
---

TODO
To talk to the Cirro API you need to first register your app in the [Cirro developer portal](https://developers.cirro.io/).

Once you have registered your app, you will receive your **app ID**.
You then need to generate your apps **private key file** (PEM format).
The developer portal allows you to generate this file and download it.
The private key file is used to sign the JWT token that is sent with each API request.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would probably add code to generate the JWT token in ruby or any pseudo code, so this way there is no ambiguity for the user

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That code is already on the linked API documentation page. I wouldn't copy it here, since this is not a technical documentation.


It should go without saying that you should keep your private key file secure.
If you lose it, you will need to generate a new one in the developer portal and update your app to use the new key.
With the private key file and app ID, you have full access to all API functions for your app, including managing
Gigs, Users, and other app settings.

Read more about how to use the private key file and app ID in the [API authentication documentation](https://api-docs.cirro.io/docs/authentication).
2 changes: 2 additions & 0 deletions src/pages/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,6 @@ Please be aware that the Guides are still in development. If you find any issues

Latest changes to the Cirro Guides:

- Oct 18, 2024 - Added Authentication page.
- Oct 08, 2024 - Added AI Access page.
- May 16, 2023 - Setting up the Cirro Guides.
Loading