Users

$res = $client->users()->all();

AuthRocket::User.all realm_id: 'rl_0v1zTHXhtNgmDaXaDYSAqx'

var_dump($res->results);
  array(1) {
    [0]=>
    array(14) {
      ["id"]=> string(26) "usr_0v1zUpWdE4IiFc2w5ynShf"
      ["realm_id"]=> string(25) "rl_0v1zTHXhtNgmDaXaDYSAqx"
      ["username"]=> string(4) "dave"
      ["state"]=> string(6) "active"
      ["user_type"]=> string(5) "human"
      ["reference"]=> NULL
      ["name"]=> string(4) "dave"
      ["email"]=> string(16) "dave@example.com"
      ["email_verification"]=> string(4) "none"
      ["object"]=> string(4) "user"
      ["last_login_at"]=> NULL
      ["created_at"]=> float(1392447538.275)
      ["first_name"]=> NULL
      ["last_name"]=> NULL
    }
  }

[#<AuthRocket::User:0x3fde5fa18df8>
  id: "usr_0v1zUpWdE4IiFc2w5ynShf",
  attribs: {
    "realm_id"=>"rl_0v1zTHXhtNgmDaXaDYSAqx",
    "username"=>"dave",
    "state"=>"active",
    "user_type"=>"human",
    "reference"=>nil,
    "name"=>"dave",
    "email"=>"dave@example.com",
    "email_verification"=>"none",
    "object"=>"user",
    "last_login_at"=>nil,
    "created_at"=>1392447538.275,
    "first_name"=>nil,
    "last_name"=>nil
  },
  metadata: {
    "more_results"=>false
  }
]

$res = $client->users()->find('usr_0v1zUpWdE4IiFc2w5ynShf');
$res = $client->users()->find('dave');

AuthRocket::User.find 'usr_0v1zUpWdE4IiFc2w5ynShf'
AuthRocket::User.find 'dave'

var_dump($res->fields);
  array(17) {
    ["id"]=> string(26) "usr_0v1zUpWdE4IiFc2w5ynShf"
    ["realm_id"]=> string(25) "rl_0v1zTHXhtNgmDaXaDYSAqx"
    ["username"]=> string(4) "dave"
    ["state"]=> string(6) "active"
    ["user_type"]=> string(5) "human"
    ["reference"]=> NULL
    ["custom"]=> array(0) {}
    ["name"]=> string(4) "dave"
    ["email"]=> string(16) "dave@example.com"
    ["email_verification"]=> string(4) "none"
    ["object"]=> string(4) "user"
    ["last_login_at"]=> NULL
    ["created_at"]=> float(1392447538.275)
    ["first_name"]=> NULL
    ["last_name"]=> NULL
    ["membership_count"]=> int(0)
    ["credentials"]=> array(1) {
      [0]=>
      array(3) {
        ["id"]=> string(26) "crd_0v9SwrveWnzli5xpTBWepd"
        ["credential_type"]=> string(8) "password"
        ["object"]=> string(10) "credential"
      }
    }
  }

#<AuthRocket::User:0x3fde5fa18df8>
  id: "usr_0v1zUpWdE4IiFc2w5ynShf",
  attribs: {
    "realm_id"=>"rl_0v1zTHXhtNgmDaXaDYSAqx",
    "username"=>"dave",
    "state"=>"active",
    "user_type"=>"human",
    "reference"=>nil,
    "custom"=>{},
    "name"=>"dave",
    "email"=>"dave@example.com",
    "email_verification"=>"none",
    "object"=>"user",
    "last_login_at"=>nil,
    "created_at"=>1392447538.275,
    "first_name"=>nil,
    "last_name"=>nil,
    "membership_count"=>0,
    "credentials"=>[
      #<AuthRocket::Credential:0x3fc21aaf2a00>
        id: "crd_0v9SwrveWnzli5xpTBWepd",
        attribs: {
          "credential_type"=>"password",
          "object"=>"credential"
        }
    ]
  }

$res = $client->users()->create([
  "username" => "dave",
  "user_type" => "human"
]);

$res = $client->users()->create([
  "token" => "utk_abcdefg"
]);

user = AuthRocket::User.create(
  username: 'dave',
  user_type: 'human'
)

user = AuthRocket::User.create(
  token: 'utk_abcdefg'
)

On success, returns same object as Get a User.

On failure, returns an object with errors:

$res->hasErrors();
// => true
var_dump($res->errors);
  array(1) {
    [0]=> string(23) "Username can't be blank"
  }

On success, returns same object as Get a User.

On failure, returns an object without an id, but with errors:

# => #<AuthRocket::User:0x3fde5fa18df8> id: nil, ...
user.errors?
# => true
user.valid?
# => false
user.errors
# => ["Username can't be blank"]

$res = $client->users()->update('usr_0v1zUpWdE4IiFc2w5ynShf', [
  "first_name" => "Dave",
  "last_name" => "Smith"
]);

user=AuthRocket::User.find 'usr_0v1zUpWdE4IiFc2w5ynShf'
user.save first_name: 'Dave', last_name: 'Smith'

On success, returns same object as Get a User.

On failure, returns an object with errors:

$res->hasErrors();
// => true
var_dump($res->errors);
  array(1) {
    [0]=> string(23) "Username can't be blank"
  }

On success, returns same object as Get a User.

On failure, returns false:

# => false
user.errors
# => ["Username can't be blank"]

$res = $client->users()->updatePassword('usr_0v1zUpWdE4IiFc2w5ynShf', [
  "current_password" => "old_secret",
  "password" => "new_secret",
  "password_confirmation" => "new_secret"
]);

user=AuthRocket::User.find 'usr_0v1zUpWdE4IiFc2w5ynShf'
user.update_password(
  current_password: 'old_secret',
  password: 'new_secret',
  password_confirmation: 'new_secret'
)

On success, returns same object as Get a User.

On failure, returns an object with errors:

$res->hasErrors();
// => true
var_dump($res->errors);
  array(1) {
    [0]=> string(36) "Password confirmation does not match"
  }

On success, returns same object as Get a User.

On failure, returns false:

# => false
user.errors
# => ["Password confirmation does not match"]

$res = $client->users()->delete('usr_0v1zUpWdE4IiFc2w5ynShf');

user=AuthRocket::User.find 'usr_0v1zUpWdE4IiFc2w5ynShf'
user.delete

On success, returns an object with no errors.

On failure, returns an object with errors.

$res->hasErrors();
// => true or false

On success, returns original object.

On failure, returns false.

$res = $client->users()->authenticate('username_or_id', 'secret');

user=AuthRocket::User.authenticate 'username_or_id', 'secret'

On success, returns same object as Get a User plus a token attribute.

On failure, throws an exception.

On success, returns same object as Get a User plus a token attribute.

On failure, raises an exception.

$res = $client->users()->authenticateCode('username_or_id', [
  "token" => "kli_abcdefghij",
  "code" => "123456"
]);

user=AuthRocket::User.authenticate_code 'username_or_id', 'kli_abcdefghij', '123456'

On success, returns same object as Get a User plus a token attribute.

On failure, throws an exception.

On success, returns same object as Get a User plus a token attribute.

On failure, raises an exception.

$res = $client->users()->authenticateKey('secret_key');

user=AuthRocket::User.authenticate_key 'secret_key'

On success, returns same object as Get a User.

On failure, throws an exception.

On success, returns same object as Get a User.

On failure, raises an exception.

$res = $client->users()->requestEmailVerification('username_or_id', [
  "request" => ["ip" => "127.0.0.1" ]
]);

user=AuthRocket::User.find 'username_or_id'
user.request_email_verification request: {ip: '127.0.0.1'}

On success, returns partial user object with a token attribute.

On failure, returns an object with errors:

$res->hasErrors();
// => true
var_dump($res->errors);
  array(1) {
    [0]=> string(5) "Error"
  }

On success, returns user object with a token attribute.

On failure, returns false:

# => false
user.errors
# => ["Error"]

$res = $client->users()->verifyEmail('username_or_id', 'kv_5Jf0IRSiChW7M2HVqxXujL', [
  "request" => ["ip" => "127.0.0.1" ]
]);

user=AuthRocket::User.find username_or_id
user.verify_email token: 'kv_5Jf0IRSiChW7M2HVqxXujL', request: {ip: '127.0.0.1'}

On success, returns same object as Get a User.

On failure, returns an object with errors:

$res->hasErrors();
// => true
var_dump($res->errors);
  array(1) {
    [0]=> string(31) "Verification token already used"
  }

On success, returns same object as Get a User.

On failure, returns false:

# => false
user.errors
# => ["Verification token already used"]

$res = $client->users()->generatePasswordToken('username_or_id', [
  "request" => ["ip" => "127.0.0.1" ]
]);

user=AuthRocket::User.generate_password_token 'username_or_id', request: {ip: '127.0.0.1'}

On success, returns partial user object with a password_reset_token attribute.

On failure, throws an exception.

On success, returns user object with a password_reset_token attribute.

On failure, raises an exception.

$res = $client->users()->resetPasswordWithToken('username_or_id', [
  "token" => "kpw_5Jf0IRSiChW7M2HVqxXujL",
  "password" => "secret",
  "password_confirmation" => "secret",
  "request" => ["ip" => "127.0.0.1" ]
]);

user=AuthRocket::User.reset_password_with_token(username_or_id, token,
  'secret', 'secret', request: {ip: '127.0.0.1'})

On success, returns same object as Get a User.

On failure, throws an exception.

On success, returns same object as Get a User.

On failure, raises an exception.