Skip to content

Commit

Permalink
Add new information about the users (#670)
Browse files Browse the repository at this point in the history
  • Loading branch information
oscarpolanco authored and Pedro Rosario committed Jul 8, 2019
1 parent aae2f17 commit a9c35fa
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions docs/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,12 +165,23 @@ Lists are a _temporary_ solution until search functionality is discussed. It is

### Overview
```
/users
/users/:id
<!-- list users (GET) -->
/_users
<!-- create new user (POST) -->
/_users
<!-- get and update users (GET, PUT, DELETE) -->
/_users/:name
/_users/:id
```

Amphora adds the `users` route with the help of [amphora-auth](https://github.com/clay/amphora-auth) where all the user's endpoints are defined.

Each user has a `username` and `provider`, which determines how they authenticate over OAuth. Users can also have other data, including `name`, `imageUrl`, and `title`.

Check the [amphora-auth](https://github.com/clay/amphora-auth#amphora-auth-) to see all the config and variables that you need to set on your site.

## Schedule

```
Expand Down

0 comments on commit a9c35fa

Please sign in to comment.