Type Alias Collaborator

An individual collaborator within the Organisation. This represents a human signer or API user - robos are handled separately.

type Collaborator = {
    accessLevel: 1 | 2 | 3;
    address: string;
    name?: string | null;
    role: string;
    status: "Active" | "Invited" | "Suspended" | "Inactive" | "Declined";
}

Index

Properties

accessLevel address name? role status

Properties

accessLevel

accessLevel: 1 | 2 | 3

The access level of the collaborator. 1: Owner 2: Member 3: Agent

Example

address

address: string

The public key of the collaborator

Example

'0x1234567890123456789012345678901234567890'

`Optional`name

name?: string | null

The collaborator's display name. Optional: a collaborator invited without one has no name stored, and the API returns null for them.

Example

'Alice'

role

role: string

The text description of the collaborator's role, set by the user that invited this collaborator.

Example

'DeFI Team Lead'

status

status: "Active" | "Invited" | "Suspended" | "Inactive" | "Declined"

The current status of the collaborator

Example

'Invited'

Type Alias Collaborator

Index

Properties

Properties

accessLevel

Example

address

Example

`Optional`name

Example

role

Example

status

Example

Settings

On This Page

Type Alias Collaborator

Index

Properties

Properties

accessLevel

Example

address

Example

Optionalname

Example

role

Example

status

Example

Settings

On This Page

`Optional`name