@sumup/sdk
    Preparing search index...

    Type Alias Membership

    Membership

    A membership associates a user with a resource, memberships is defined by user, resource, resource type, and associated roles.

    type Membership = {
        attributes?: SumUp.Memberships.Attributes;
        created_at: string;
        id: string;
        invite?: SumUp.Memberships.Invite;
        metadata?: SumUp.Memberships.Metadata;
        permissions: string[];
        resource: MembershipResource;
        resource_id: string;
        roles: string[];
        status: SumUp.Memberships.MembershipStatus;
        type: ResourceType;
        updated_at: string;
    }
    Index

    Properties

    attributes? created_at id invite? metadata? permissions resource resource_id roles status type updated_at

    Properties

    attributes?: SumUp.Memberships.Attributes
    created_at: string

    The timestamp of when the membership was created.

    id: string

    ID of the membership.

    invite?: SumUp.Memberships.Invite
    metadata?: SumUp.Memberships.Metadata
    permissions: string[]

    User's permissions.

    @deprecated: Permissions include only legacy permissions, please use roles instead. Member access is based on their roles within a given resource and the permissions these roles grant.

    resource: MembershipResource
    resource_id: string

    ID of the resource the membership is in.

    roles: string[]

    User's roles.

    status: SumUp.Memberships.MembershipStatus
    type: ResourceType
    updated_at: string

    The timestamp of when the membership was last updated.

    Settings

    Member Visibility

    On This Page

    Properties