Skip to main content
const member = await airstore.members.create('ws_abc123', {
  email: '[email protected]',
  name: 'Jane Doe',
  role: 'admin',
})
Members are users with a role in a workspace. Roles determine what they can do when accessing the workspace through the dashboard or CLI.

create()

Add a member to a workspace.
const member = await airstore.members.create('ws_abc123', {
  email: '[email protected]',
  name: 'Jane Doe',
  role: 'member',
})
Parameters
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace external ID
emailstringYesMember’s email address
namestringYesDisplay name
role'admin' | 'member' | 'viewer'NomemberRole in the workspace
Returns Promise<Member>
FieldTypeDescription
external_idstringUnique member identifier
emailstringEmail address
namestringDisplay name
rolestringadmin, member, or viewer
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

Roles

RoleDescription
adminFull access: manage members, connections, smart folders, and tokens
memberCan use integrations and smart folders, but can’t manage workspace settings
viewerRead-only access to the filesystem

list()

List members in a workspace.
const members = await airstore.members.list('ws_abc123')

for (const m of members) {
  console.log(`${m.name} (${m.email}) -- ${m.role}`)
}
Parameters
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace external ID
Returns Promise<Member[]>

del()

Remove a member from a workspace.
await airstore.members.del('ws_abc123', 'mem_xyz789')
Parameters
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace external ID
memberIdstringYesMember external ID
Returns Promise<void>