Account

    Account


    Article summary


    title: Account

    version: 1.0.0
    layout: default
    sdk: core

    # Account Module

    Version Account 1.0.0

    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.

    Methods

    id

    Get the platform back-office account identifier

    To get the value of id call the method like this:

    function id(): Promise<string>
    

    Promise resolution:

    string
    

    Capabilities:

    RoleCapability
    usesxrn:firebolt:capability:account: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

    To get the value of uid call the method like this:

    function uid(): Promise<string>
    

    Promise resolution:

    string
    

    Capabilities:

    RoleCapability
    usesxrn:firebolt:capability:account:uid

    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