Sanity Library Reference Docs
    Preparing search index...

    Interface ProjectMember

    A member row for workflow assignment controls.

    interface ProjectMember {
        displayName: string;
        email?: string;
        id: string;
        imageUrl?: string;
        isCurrentUser?: boolean;
        loginProvider?: string;
        membershipId?: string;
        roles: readonly MemberRole[];
    }
    Index

    Properties

    displayName email? id imageUrl? isCurrentUser? loginProvider? membershipId? roles

    Properties

    displayName: string

    The profile name, or Unknown user when the host could not resolve a profile.

    email?: string
    id: string

    The person's account-global sanityUserId when their profile resolves. If the host cannot resolve it, the row retains the project membership ID. The engine rejects unresolved project IDs in new user assignments.

    imageUrl?: string
    isCurrentUser?: boolean

    Whether this row is the person holding the token that loaded it.

    loginProvider?: string

    Which identity provider the person signs in with — display only. Sign-in context, not an identifier: two accounts can share a provider, so it narrows a name collision rather than resolving one.

    membershipId?: string

    The project membership ID, when it differs from id. Some stored actor stamps and user values carry this ID instead of id.

    roles: readonly MemberRole[]

    Roles held by the member in this project.

    Settings

    Member Visibility

    On This Page

    Properties