FusionAuth Ruby Client

    Ruby Client Library

    The Ruby client library allows you to integrate FusionAuth with your Ruby application.

    Source Code:

    Gem:

    To install the FusionAuth Ruby Gem package run: 

    
$ gem install fusionauth_client

    The following code assumes FusionAuth is running on http://localhost:9011 and uses an API key 6b87a398-39f2-4692-927b-13188a81a9a3, you will need to supply your own API key, and if you are not running FusionAuth locally, your host parameter may be different.

    Here is an example of using the register and the login methods to create a new User and Registration and then login the user. 

    
# Construct the FusionAuth Client with the following values:
#  - API Key: 6b87a398-39f2-4692-927b-13188a81a9a3
#  - Host: http://localhost:9011
client = FusionAuth::FusionAuthClient.new('6b87a398-39f2-4692-927b-13188a81a9a3', 'http://localhost:9011')

# Create a user + registration
id = SecureRandom.uuid
client.register(id, {
    :user => {
        :firstName => 'Ruby',
        :lastName => 'Client',
        :email => 'ruby.client.test@fusionauth.io',
        :password => 'password'
    },
    :registration => {
        :applicationId => application_id,
        :data => {
            :foo => 'bar'
        },
        :preferredLanguages => %w(en fr),
        :roles => %w(user)
    }
})

# Authenticate the user
response = client.login({
    :loginId => 'ruby.client.test@fusionauth.io',
    :password => 'password',
    :applicationId => application_id
})
user = response.user

    Usage Suggestions

    FusionAuth client libraries are a bit different than full featured SDKs that you might have encountered before. They are a thin wrapper around the REST API. Client libraries are typically used in two different ways.

    First, they can be used to access the FusionAuth APIs in a familiar format, leveraging language features like auto-completion. When used for this, they can be helpful to script FusionAuth configuration, automate common tasks, and create copies of existing applications, groups and more.

    To use the client libraries effectively in this way, it is helpful to review the source code of the client library and the API documentation, which contains the JSON structure. The API documentation is very thorough about the JSON objects it expects as part of the payload as well as what parameters are required when.

    Second, client libraries can exchange a token to let a user to log in via the Authorization Code Grant. This is a secondary use of these libraries. This process is best done by using a language specific OAuth library, which will work with FusionAuth. Here is a community curated list of such libraries.

    Client libraries do not currently provide higher level functionality such as token management. Here is an open issue detailing some requested higher level functionality. Please feel free to file an issue or upvote this one if you desire it.

    You can always directly call the REST API if the client library functionality doesn’t work for you. All the client libraries use the REST API.

    In general, the request object will either be string parameters or a complex object depending on the type of API call being made. Any request object will be mapped by the library to a JSON object required by the corresponding API method. Examining the API documents for the operations you’re trying to call will therefore be useful, especially if you are using language without static typing.

    The response object will typically contain:

    • a status corresponding to the HTTP status code returned by the API. It may also be -1 if no HTTP request was successfully made

    • a JSON success object if the call succeeded.

    • a JSON error object with an intelligible message if the status code is 4xx or 5xx.

    • an exception object if there was no HTTP request sent or there was no reasonable response from the server.

    Related Posts

    Example apps

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo