Skip to content

Update README.md #74

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

Merged
andrew-propelauth merged 1 commit into from
Apr 2, 2025
Merged

Update README.md #74

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
28 changes: 17 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
# PropelAuth
<p align="center">
<a href="https://www.propelauth.com?ref=github" target="_blank" align="center">
<img src="https://www.propelauth.com/imgs/lockup.svg" width="200">
</a>
</p>

# PropelAuth Rust Library

Add authentication and authorization to your application.

This library is meant to be used with a [PropelAuth](https://www.propelauth.com/) account.
You can sign up and get started for free.

# Initialize
## Initialize

First, you'll need to initialize the library. You can either call `PropelAuth::init`
or `PropelAuth::fetch_and_init` (which will fetch any unspecified metadata).
Expand All @@ -17,7 +23,7 @@ let auth = PropelAuth::fetch_and_init(AuthOptions {
}).await.expect("Unable to initialize authentication");
```

# Usage / Protecting APIs
## Usage / Protecting APIs

- [Axum](#axum)
- [Actix](#actix)
Expand All @@ -40,7 +46,7 @@ let app = Router::new()
.layer(auth_layer); // <-- here
```

You can then take `User` in as an argument, which will look for an [access token](https://docs.propelauth.com/overview/access-token/) in the Authorization header.
You can then take `User` in as an argument, which will look for an [access token](https://docs.propelauth.com/guides-and-examples/guides/access-tokens) in the Authorization header.

```rust
// User will automatically return a 401 (Unauthorized) if a valid access token wasn't provided
Expand All @@ -49,7 +55,7 @@ async fn whoami(user: User) -> String {
}
```

You can also check which [organizations](https://docs.propelauth.com/overview/organizations/) the user is in, and which [roles and permissions](https://docs.propelauth.com/overview/rbac/) they have.
You can also check which [organizations](https://docs.propelauth.com/overview/organizations/) the user is in, and which [roles and permissions](https://docs.propelauth.com/overview/authorization/rbac) they have.

```rust
// If the user isn't in the provided organization, a 403 is returned
Expand Down Expand Up @@ -90,7 +96,7 @@ HttpServer::new(move || {
})
```

You can then take `User` in as an argument, which will look for an [access token](https://docs.propelauth.com/overview/access-token/) in the Authorization header.
You can then take `User` in as an argument, which will look for an [access token](https://docs.propelauth.com/guides-and-examples/guides/access-tokens) in the Authorization header.

```rust
// User will automatically return a 401 (Unauthorized) if a valid access token wasn't provided
Expand All @@ -100,7 +106,7 @@ async fn whoami(user: User) -> impl Responder {
}
```

You can also check which [organizations](https://docs.propelauth.com/overview/organizations/) the user is in, and which [roles and permissions](https://docs.propelauth.com/overview/rbac/) they have.
You can also check which [organizations](https://docs.propelauth.com/overview/organizations/) the user is in, and which [roles and permissions](https://docs.propelauth.com/overview/authorization/rbac) they have.

```rust
// If the user isn't in the provided organization, a 403 is returned
Expand Down Expand Up @@ -136,7 +142,7 @@ propelauth = { version >= "0.12.1", features = ["rustls"], default-features = fa

## Other

After initializing `auth`, you can verify [access tokens](https://docs.propelauth.com/overview/access-token/) by passing in the Authorization header (formatted `Bearer TOKEN`):
After initializing `auth`, you can verify [access tokens](https://docs.propelauth.com/guides-and-examples/guides/access-tokens) by passing in the Authorization header (formatted `Bearer TOKEN`):

```rust
let result = auth.verify().validate_authorization_header(&authorization_header);
Expand All @@ -145,7 +151,7 @@ match result {
Err(_) => { /* invalid access token, typically we return a 401 Unauthorized here */ }
}
```
You can also check which [organizations](https://docs.propelauth.com/overview/organizations/) the user is in, and which [roles and permissions](https://docs.propelauth.com/overview/rbac/) they have.
You can also check which [organizations](https://docs.propelauth.com/overview/organizations/) the user is in, and which [roles and permissions](https://docs.propelauth.com/overview/authorization/rbac) they have.

```rust
let org = auth.validate_org_membership(
Expand All @@ -163,7 +169,7 @@ let org = user.validate_org_membership(

And finally, you can make API calls directly from `auth.user()` and `auth.org()`

# Where do the access tokens come from?
## Where do the access tokens come from?

They come from your frontend.
You can read more about integrating your frontend [here](https://docs.propelauth.com/getting-started/frontend-integration/).
You can read more about integrating your frontend [here](https://docs.propelauth.com/getting-started/quickstart-fe).
Loading