Users

Users ⇐ APIClient

Use Fonoster Users, a capability of Fonoster, to create, update, get and delete Users. Users requires of a running Fonoster deployment.

Kind: global class
Extends: APIClient
See: module:core:APIClient

• Users ⇐ APIClient
  • new Users(options)
  • .listUsers(request) ⇒ Promise.<ListUsersResponse>
  • .createUser(request) ⇒ Promise.<CreateUserResponse>
  • .getUser(ref) ⇒ Promise.<GetUserResponse>
  • .updateUser(request) ⇒ Promise.<UpdateUserResponse>
  • .deleteUser(ref)
  • .createUserCredentials(request)

new Users(options)

Constructs a new Users object.

Param	Type	Description
options	ClientOptions	Options to indicate the objects endpoint

Example

const Fonoster = require("@fonoster/sdk")
const users = new Fonoster.Users()

const request = {
  email: "john.doe@email.com",
  name: "John Doe",
  secret: "s3cur3pass",
  avatar: "https://avatar.com/avt?userId=2124252"
}

users.createUser(request)
.then(result => {
  console.log(result)             // successful response
}).catch(e => console.error(e))   // an error occurred

users.listUsers(request) ⇒ Promise.<ListUsersResponse>

Return a list of Users.

Kind: instance method of Users

Param	Type	Description
request	ListUsersRequest	Request filters
request.email	string	Optional email filter

Example

projects.listUsers({ email: "john.doe@email.com" })
.then(result => {
  console.log(result)             // successful response
}).catch(e => console.error(e))   // an error occurred

users.createUser(request) ⇒ Promise.<CreateUserResponse>

Create a new Fonoster User.

Kind: instance method of Users

Param	Type	Description
request	CreateUserRequest	Request for the provision of a new User
request.email	string	User's email
request.name	string	User's full name
request.secret	string	Login password
request.avatar	string	Optional URL to User's avatar

Example

const request = {
  email: "john.doe@email.com",
  name: "John Doe",
  secret: "s3cur3pass",
  avatar: "https://avatar.com/avt?userId=2124252"
}

users.createUser(request)
.then(result => {
  console.log(result)             // successful response
}).catch(e => console.error(e))   // an error occurred

users.getUser(ref) ⇒ Promise.<GetUserResponse>

Retrives an User by reference.

Kind: instance method of Users
Returns: Promise.<GetUserResponse> - The User
Throws:

• if ref is null or User does not exist

Param	Type	Description
ref	string	Reference to User

Example

const ref = "507f1f77bcf86cd799439011";

users.getUser(ref)
.then(result => {
  console.log(result)             // returns the User payload
}).catch(e => console.error(e))   // an error occurred

users.updateUser(request) ⇒ Promise.<UpdateUserResponse>

Update a Fonoster User.

Kind: instance method of Users

Param	Type	Description
request	UpdateUserRequest	Request update of an User
request.ref	string	Required reference to the User
request.name	string	Optionally update the name
request.avatar	string	Optionally update the avatar
request.secret	string	Optionally update User's password

Example

const request = {
  name: "John Dee",
  secret: "s3cur3pass"
}

users.updateUser(request)
.then(result => {
  console.log(result)            // returns the UpdateUserResponse payload
}).catch(e => console.error(e))  // an error occurred

users.deleteUser(ref)

Delete an Fonoster User.

Kind: instance method of Users

Param	Type	Description
ref	string	User's reference

Example

const ref = "507f1f77bcf86cd799439011"

users.deleteUser(ref)
.then(() => {
  console.log("done")            // returns a reference of the User
}).catch(e => console.error(e))  // an error occurred

users.createUserCredentials(request)

Login using email and a password.

Kind: instance method of Users

Param	Type	Description
request	createUserCredentials	Request update of an User
request.email	string	Login username
request.secret	string	Login password

Example

const request = {
 email: "john.doe@email.com",
 secret: "s3cur3pass",
 expiration: "30d"
}

users.createUserCredentials(request)
.then(result => {
  console.log(result)            // returns an accessKeyId and accessKeySecret
}).catch(e => console.error(e))  // an error occurred