Account

    Account


    Article summary


    title: Account

    version: 0.5.3
    layout: default
    sdk: core

    # Account Module

    Version 0.5.3

    OpenRPC

    This document was generated from an OpenRPC JSON-Schema, and is intended to provide a human readable overview and examples of the methods contained in the module.

    For the full schema, see the link below.

    Schema
    account.json

    Table of Contents

    Usage

    To use the Account module, you can import it into your project from the Firebolt SDK:

    import { Account } from '@firebolt-js/sdk'
    

    Overview

    A module for querying about the device account.

    Events

    Methods

    id

    Get the platform back-office account identifier

    function id(): Promise<string>
    

    Promise Resolution

    TypeDescription
    stringthe id

    Examples

    ##### Default Example

    JavaScript
    import { Account } from '@firebolt-js/sdk'
    
    Account.id()
        .then(id => {
            console.log(id)
        })
    

    Value of id

    "123"
    
    JSON-RPC

    ###### Request

    {
      "jsonrpc": "2.0",
      "id": 1,
      "method": "account.id",
      "params": {}
    }
    

    ###### Response

    {
      "jsonrpc": "2.0",
      "id": 1,
      "result": "123"
    }
    

    uid

    Gets a unique id for the current app & account

    function uid(): Promise<string>
    

    Promise Resolution

    TypeDescription
    stringa unique ID

    Examples

    ##### Getting the unique ID

    JavaScript
    import { Account } from '@firebolt-js/sdk'
    
    Account.uid()
        .then(uniqueId => {
            console.log(uniqueId)
        })
    

    Value of uniqueId

    "ee6723b8-7ab3-462c-8d93-dbf61227998e"
    
    JSON-RPC

    ###### Request

    {
      "jsonrpc": "2.0",
      "id": 1,
      "method": "account.uid",
      "params": {}
    }
    

    ###### Response

    {
      "jsonrpc": "2.0",
      "id": 1,
      "result": "ee6723b8-7ab3-462c-8d93-dbf61227998e"
    }
    


    Was this article helpful?

    What's Next