Membership
Last updated
Was this helpful?
Last updated
Was this helpful?
The vault owner can manage access to their vault by creating and maintaining memberships.
New members can be assigned one of two roles:
Contributor: can publish new documents, assets, etc to the vault.
Viewer: can access the vault, view contents and download only.
invite(vaultId, email, role)
Invite user with an Akord account:
vaultId
(string
, required)
email
(string
, required) - invitee's email
role
(, required) - CONTRIBUTOR or VIEWER
options
(MembershipCreateOptions
, optional) - invitation email message, etc.
returns Promise<{ membershipId, transactionId }>
- Promise with new membership id & corresponding transaction id
inviteNewUser(vaultId, email, role)
Invite user without an Akord account:
vaultId
(string
, required)
email
(string
, required) - invitee's email
options
(MembershipCreateOptions
, optional) - invitation email message, etc.
returns Promise<{ transactionId }>
- Promise with new membership id & corresponding transaction id
accept(membershipId)
membershipId
(string
, required)
returns Promise<{ transactionId }>
- Promise with corresponding transaction id
confirm(membershipId)
membershipId
(string
, required)
returns Promise<{ transactionId }>
- Promise with corresponding transaction id
reject(membershipId)
Reject pending invitation:
membershipId
(string
, required)
returns Promise<{ transactionId }>
- Promise with corresponding transaction id
leave(membershipId)
Reject already accepted invitation:
membershipId
(string
, required)
returns Promise<{ transactionId }>
- Promise with corresponding transaction id
revoke(membershipId)
Revoke a membership, also update each valid membership with new rotated keys:
membershipId
(string
, required)
returns Promise<{ transactionId }>
- Promise with corresponding transaction id
changeRole(membershipId, role)
membershipId
(string
, required)
returns Promise<{ transactionId }>
- Promise with corresponding transaction id
inviteResend(membershipId)
Resend email invitation:
membershipId
(string
, required)
returns Promise<{ transactionId }>
- Promise with corresponding transaction id
get(membershipId, options)
membershipId
(string
, required)
returns Promise<Membership>
- Promise with the membership object
listAll(vaultId, options)
vaultId
(string
, required)
returns Promise<Array<Membership>>
- Promise with all memberships within given vault
list(vaultId, options)
vaultId
(string
, required)
returns Promise<{ items, nextToken }>
- Promise with paginated memberships within given vault
role
(, required) - CONTRIBUTOR or VIEWER
role
(, required) - CONTRIBUTOR or VIEWER
options
(, optional)
options
(, optional)
options
(, optional)