Class: NexaasID::Resources::SignUp

Inherits:

Base

• Object
• Base
• NexaasID::Resources::SignUp

Defined in:

lib/nexaas_id/resources/sign_up.rb

Overview

A wrapper to Nexaas ID’s sign up API

API

Documentation:

Examples:

Inviting a new user to Nexaas ID (on behalf of an existing user):

client = NexaasID::Client::Identity.new(credentials)
client.sign_up.create('john.doe@gmail.com')

Inviting a new user to Nexaas ID (on behalf of an application):

client = NexaasID::Client::Application.new
client.sign_up.create('john.doe@gmail.com')

See Also:

• Client::Identity#initialize
• Client::Application#initialize

Instance Attribute Summary

Attributes inherited from Base

#configuration

Instance Method Summary

• #create(email) ⇒ NexaasID::Entities::SignUp

  Invites an user to Nexaas ID, by creating a new sign up.

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from NexaasID::Resources::Base

Instance Method Details

#create(email) ⇒ NexaasID::Entities::SignUp

Invites an user to Nexaas ID, by creating a new sign up.

API

Method: POST /api/v1/sign_up

Documentation:

Parameters:

• email (String) —

  The new user’s email.

Returns:

• (NexaasID::Entities::SignUp) —

  the new sign up; it contains the invited user’s id.

# File 'lib/nexaas_id/resources/sign_up.rb', line 27

def create(email)
  respond_with_entity(api.post('/api/v1/sign_up', body: MultiJson.dump({ invited: email })))
end