https://github.com/skoda091/cognitex
Library for managing user accounts through AWS Cognito service.
https://github.com/skoda091/cognitex
api-wrapper aws cognito elixir
Last synced: about 1 year ago
JSON representation
Library for managing user accounts through AWS Cognito service.
- Host: GitHub
- URL: https://github.com/skoda091/cognitex
- Owner: Skoda091
- License: mit
- Created: 2018-08-09T13:14:03.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-02-08T13:45:13.000Z (over 4 years ago)
- Last Synced: 2025-04-02T21:42:31.830Z (about 1 year ago)
- Topics: api-wrapper, aws, cognito, elixir
- Language: Elixir
- Homepage:
- Size: 15.6 KB
- Stars: 32
- Watchers: 1
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Cognitex
[](https://travis-ci.org/Skoda091/cognitex)
[](https://hex.pm/packages/cognitex)
A simple library to handle user management over [AWS Cognito service](https://aws.amazon.com/cognito/).
The following functionality is covered;
* User registration
* Confirm registration (with the confirmation code received from AWS, by email)
* User authentication
* Fetch user data by an access token
* Fetch user data by username
* Change user password
* Update user attributes
* Reset a forgotten password
Online documentation is available [here](https://hexdocs.pm/cognitex/0.1.0/api-reference.html).
## Installation
To use `cognitex` with your projects, edit your `mix.exs` file to add it as a dependency:
```elixir
def deps do
[
{:cognitex, "~> 0.1.0"}
]
end
```
## Configuration
An example config might look like this:
```elixir
config :aws,
key: "",
secret: "",
region: "",
client_id: "",
user_pool_id: ""
```
## Set up AWS Cognito with the correct configuration
First, we will set up a new AWS Cognito user pool with the correct configuration.
1. Visit your AWS console and go to the AWS Cognito service. Click on "Manage your User Pools" and click "Create a User Pool".
2. Specify a name for your pool and click "Review Defaults".
3. Optional: edit the password policy to remove some of the requirements. If you are just testing, using simple passwords will make it easier.
4. Click the "edit client" link. Specify a name for your app and be sure to *disable* the client secret and *enable* the `ADMIN_NO_SRP_AUTH` option.
5. Click "Create pool". Take note of the *Pool Id* at the top of the page and click on the apps page. Here, take note of the *App client id*.
## Usage
```elixir
iex> Cognitex.sign_up("john.smith@example.com", "Test123", name: "John", family_name: "Smith")
{:ok,
%{
"CodeDeliveryDetails" => %{
"AttributeName" => "email",
"DeliveryMedium" => "EMAIL",
"Destination" => "j***@e***.co"
},
"UserConfirmed" => false,
"UserSub" => "uuid"
}
}
iex> Cognitex.sign_up("john.smith@example.com", "Test123", name: "John", family_name: "Smith")
{:error,
%{
message: "An account with the given email already exists.",
status: "UsernameExistsException"
}
}
```
Full documentation is available [here](https://hexdocs.pm/cognitex/0.1.0/api-reference.html).
### References
* Official Cognito [API reference](http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html):
### Licensing, thanks
This library is released under the [MIT License](https://opensource.org/licenses/MIT).
It is based on:
* [cognito-phx](https://gitlab.com/azohra/cognito-phx/)
* [aws-elixir](https://github.com/aws-beam/aws-elixir)