@kagamidigital/salt-sdk-mirror
    Preparing search index...

    Type Alias InviteCollaboratorParams

    The details of someone to invite into an existing organisation. The invitee receives an invitation (the collaborator is added with status "Invited") that can be accepted via Salt#acceptOrganisationInvitation.

    type InviteCollaboratorParams = {
        accessLevel?: 1 | 2 | 3 | AccessRole;
        address: string;
        name?: string;
        role: string;
    }
    Index

    Properties

    accessLevel? address name? role

    Properties

    accessLevel?: 1 | 2 | 3 | AccessRole

    The access level to grant, as a number or its named AccessRole. Defaults to 2 (Member).

    • 1 / 'owner'
    • 2 / 'member'
    • 3 / 'agent'
    address: string

    Ethereum address of the invitee.

    '0x1234567890123456789012345678901234567890'
    name?: string

    Display name of the invitee. Defaults to an empty string.

    'Bob'
    role: string

    The invitee's free-text role label.

    'CFO'

    Settings

    Member Visibility

    On This Page

    Properties