User

user_api.v1.User

type User

user_api.v1.User

FieldTypeDescription
uuidstringUnique identifier of the user for internal use.
first_namestringFirst name of the user.
last_namestringLast name of the user.
emailstringEmail address of the user.
roleRole enum
FieldNumberDescription
ROLE_UNSPECIFIED0Role of the user, either but not limited to Admin or User.Role Unspecified.
ROLE_USER1Role of the user, either but not limited to Admin or User.Role User.
ROLE_ADMIN2Role of the user, either but not limited to Admin or User.Role Admin.
avatarstringAvatar URL of the user.
phonestringPhone number of the user.
didsstring repeatedW3C Decentralized Identifiers (DIDs) associated to the user.
external_idsExternalIdsEntry repeatedExternal system identifiers associated to the user. Ex UserID from the user's financial institution.
metadataStructAdditional data about the user such as account, address, branch, routing info, etc.
accountstringAccount number of the user.
{
  "uuid": "UUID",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "role": 0,
  "avatar": "AVATAR_URL",
  "phone": "+1 555 555 5555",
  "dids": [
    "did:method-name:zDIDMultibase58Encoded",
    "did:method-name:zDIDMultibase58Encoded"
  ],
  "external_ids": [
    {
      "key": "KEY1",
      "value": "VALUE1"
    },
    {
      "key": "KEY2",
      "value": "VALUE2"
    }
  ],
  "metadata": {
    "fields": [
      {
        "key": "VALUE"
      }
    ]
  },
  "account": "15436675"
}