Skip to content

Accounts⚓︎

Path⚓︎

/v1/accounts

An administrator account is used to manage the network. It consists of a username and email address. The account is associated with a Customer and is assigned an account role that determines feature access and permissions.

 

Resource Attributes⚓︎

The attributes for the accounts resource are detailed below:

Attribute Type Required? Description
id Integer YES The account ID. Use this value to specify the account in requests.
username String YES The username, identical to the email address.
externalId String NO Allows you to set an alternate ID value for the account, used for searches.
emailAddress String YES The email address provided for the account, used to generate the username.

Example⚓︎

    {
      "id": 123271682,
      "username": "dasGrob@expeto.io",
      "externalId": null,
      "emailAddress": "dasGrob@expeto.io"
    }

 

Endpoints⚓︎

Request Examples⚓︎

Get the role of an account user:⚓︎

{baseUrl}/v1/accounts/<id>/role

Where <id> is the account ID associated with the user.

Get the permissions of a specific user:⚓︎

{baseUrl}/v1/accounts/<id>

Search for an account using username or email:⚓︎

{baseUrl}/v1/accounts/search/findByDeepSearch?searchString=<searchCriteria>

Where <searchCriteria> is the text string used to find the account.

Get your feature permissions and assigned role:⚓︎

{baseUrl}/v1/accounts/command/currentUser

Update Account Password⚓︎

To update the account password, make a POST request:

curl --request POST \
  --url http://localhost/v1/accounts/command/update