Accounts - Stratumn

Organization

Documentation
API
Type
Example

In Stratumn, an organization represents the top level of the account hierarchy. It encompasses users, teams, and its own workflows.

name

string

required

The name of the organization, acts as an identifier to not regenerate the organization if it already exists.

description

string

required

The description of the organization.

domainName

string

The domain name of the organization.

avatar

string or Promise<{default: string}>

The URL of the organization’s avatar, or a promise that resolves to an object with a default property containing the URL.

includeSuperUser

boolean

Whether to include the Stratumn admin user in the organization.

users

Record<string, IUserDef>

required

A map of users which belongs to the organization, can an be empty if the organization’s owners manage the users in Account UI.

teams

Record<string, ITeamDef>

required

A map of teams which belongs to the organization, can an be empty if teams are added as members of a groups.

encryptionKey

IKeyDef

The optional encryption key of the organization.

signingKey

IKeyDef

The optional signing key of the organization.

Typescript

type IOrganizationDef = {
  /* Manage organization's metadata */
  name: string;
  description: string;
  domainName?: string;
  avatar?: string | Promise<{default: string;}>;
  /* Manage organization's users */
  includeSuperUser?: boolean;
  users: Record<string, IUserDef>; // IUserDef is defined in the User section
  /* Manage organization's teams */
  teams: Record<string, ITeamDef>; // ITeamDef is defined in the Team section
  /* Manage organization's keys */
  encryptionKey?: IKeyDef;
  signingKey?: IKeyDef;
}

/** A key pair definition */
type IKeyDef = {
    publicKey: string;
    privateKey: string;
}

Usage

export const pastaLaVistaOrganization = {
  name: 'Pasta La Vista',
  description: 'A super cool Italian restaurant',
  teams: {},
  users: {},
  avatar: `${__dirname}/files/logo.png`
} as const satisfies IOrganizationDef;

User

Documentation
API
Type
Example

A user is an individual with a Stratumn account. Users can be members or collaborators and may belong to multiple teams.
They are managed in Account UI by the organization’s owners.

string

required

The email of the user, acts as an identifier to not regenerate the user if it already exists.

password

string

required

The password of the user.

name

string

The name of the user.

firstName

string

The first name of the user.

lastName

string

The last name of the user.

avatar

string or Promise<{default: string}>

The URL of the user’s avatar, or a promise that resolves to an object with a default property containing the URL.

phone

string

The phone number of the user.

encryptionKey

IKeyDef

The optional encryption key of the user.

Typescript

type IUserDef = {
  /* Manage user's metadata */
  email: string;
  password: string;
  name?: string;
  firstName?: string;
  lastName?: string;
  avatar?: string | Promise<{default: string;}>;
  phone?: string;
  encryptionKey?: IKeyDef;
  signingKey?: IKeyDef;
}

/** A key pair definition */
type IKeyDef = {
    publicKey: string;
    privateKey: string;
}

Usage

export const johnDoeUser = {
  firstName: 'John',
  lastName: 'Doe',
  email: '[email protected]',
  password: 'myNotSoSecretPassword'
} as const satisfies IUserDef;

Users are typically not generated but are instead invited by the organization’s owners through the Account UI.
Users created within the configuration project are for demonstration purposes only.

Member

A member is an user who is part of the organization. Members have access to and can interact with the organization’s workflows. Additionally, members can hold the role of organization owner.
They are managed in Account UI by the organization’s owners.

Collaborator

A collaborator is an user who is not a part of the organization but can still interact with its workflows.
They are managed in Account UI by the organization’s owners.

Team

Documentation
API
Type
Example

A team is a group of users (members and collaborators), managed by the organization’s owners in Account UI.

organizationName

string

required

The name of the organization the team belongs to.

organizationId

string

The ID of the organization the team belongs to.

name

string

required

The name of the team, acts as an identifier to not regenerate the team if it already exists.

description

string

required

The description of the team.

avatar

string or Promise<{default: string}>

The URL of the team’s avatar, or a promise that resolves to an object with a default property containing the URL.

string

The email of the team.

includeSuperUser

boolean

Whether to include the Stratumn admin user in the team.

users

Record<string, IUserDef>

A map of users which belongs to the team, can an be empty if the organization’s owners manage the users in Account UI.

encryptionKey

IKeyDef

The optional encryption key of the team.

signingKey

IKeyDef

The optional signing key of the team.

Typescript

  type ITeamDef = {
    /* Manage team's metadata */
    organizationName: string;
    organizationId?: string;
    name: string;
    description: string;
    avatar?: string | Promise<{default: string;}>;
    email?: string;

    /* Manage team's users */
    users: Record<string, IUserDef>;
    includeSuperUser?: boolean;

    /* Manage team's keys */
    encryptionKey?: IKeyDef;
    signingKey?: IKeyDef;
  }

  /** A key pair definition */
  type IKeyDef = {
      publicKey: string;
      privateKey: string;
  }

Usage

  import { johnDoeUser } from './users';

  export const cooksTeam = {
    name: 'Cooks',
    description: 'The team of cooks',
    organizationName: "Pasta la Vista",
    users: {
      johnDoe: johnDoeUser
    },
    avatar: `${__dirname}/files/cooks-avatar.png`
  } as const satisfies ITeamDef;

Group

Documentation
API
Type
Example

A group is defined at the workflow level and consists of teams or individual users. It determines who can act on a workflow and specifies the actions they are allowed to perform. Typically, a group has a one-to-one relationship with a team.Groups are managed either within the configuration project itself or by Stratumn administrators in Trace UI.

label

string

required

The label of the group, acts as unique identifier to not regenerate the group if it already exists.

name

string

required

The readable name of the group, acts as an identifier to not regenerate the group if it already exists.

avatar

string or Promise<{default: string}>

The URL of the group’s avatar, or a promise that resolves to an object with a default property containing the URL.

members

MemberDef[]

The members of the group, can be teams, users or organizations.

actions

string[]

The actions that can be performed by the group.

Typescript

export type IGroupDef = {
  label: string;
  name: string;
  avatar?: string | Promise<{default: string;}>;
  members?: MemberDef[];
  actions?: string[];
}

export type MemberDef = {
    account: IAccount;
    role: Role;
}

Usage

import { cooksTeam } from './teams';

const cooksGroup = {
  label: 'cooks',
  name: 'Cooks',
  avatar: `${__dirname}/files/cooks-avatar.png`,
  members: [
    {
      account: cooksTeam,
      role: 'READER'
    }
  ],
  actions: [
    'prepareOrder',
    'comment'
  ]
} as const satisfies IGroupDef;

Each account type can be created directly within the configuration project in the account folder.

Workflow configuration

​Organization

​User

​Member

​Collaborator

​Team

​Group

Organization

User

Member

Collaborator

Team

Group