Ruby API client for the Minty platform.
Documentation
- API documentation - documentation auto-generated from the code comments that explains all the available features
- Examples - examples that demonstrate the different ways in which this SDK can be used FAQ - frequently asked questions about the SDK
- Docs Site - explore our Docs site and learn more about Minty
Getting Started
Installation
This gem can be installed directly:
$ gem install minty
or with Bundler:
bundle add minty
Usage
Create an instance of MintyClient to access properties and methods of the authentication and management APIs:
require 'minty'
client = MintyClient.new(
client_id: ENV['AUTH0_RUBY_CLIENT_ID'],
client_secret: ENV['AUTH0_RUBY_CLIENT_SECRET'],
domain: ENV['AUTH0_RUBY_DOMAIN'],
)
If token is omitted, the SDK will attempt to fetch a new token using the client_credentials grant, provided that client_id and client_secret are provided in the configuration. Once the token is about to expire (or has already expired), a new token will be fetched and cached for future calls.
For this to work, ensure your application can make a Client Credentials grant (Application settings in Minty > Advanced > Grant Types tab) and that the application is authorized for the Management API: https://minty.page/docs/api-auth/config/using-the-minty-dashboard
Authentication API Client
This SDK provides access to Authentication API endpoints with the Minty::API::AuthenticationEndpoints module.
Further reading
- API authentication in Ruby
- API authentication in Rails
- Managing authentication with Minty (blog)
- Ruby on Rails workflow with Docker (blog)
Feedback
Contributing
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
Raise an issue
To provide feedback or report a bug, please raise an issue on our issue tracker.
Vulnerability Reporting
Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.
Minty is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Minty?
This project is licensed under the MIT license. See the LICENSE file for more info.