Skip to main content
Docs

The Backend OrganizationMembership object

The Backend OrganizationMembership object is similar to the OrganizationMembership object as it's the model around an organization membership entity and describes the relationship between users and organizations. However, the Backend OrganizationMembership object is different in that it's used in the Backend API and is not directly accessible from the Frontend API.

Properties

  • Name
    createdAt
    Type
    number
    Description

    The date when the membership was first created.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the membership.

  • Name
    organization
    Type
    Organization
    Description

    The organization that the user is a member of.

  • Name
    permissions
    Type
    string[]
    Description

    The permissions granted to the user in the organization.

  • Name
    privateMetadata
    Type
    OrganizationMembershipPrivateMetadata
    Description

    Metadata that can be read and set only from the Backend API.

  • Name
    publicMetadata
    Type
    OrganizationMembershipPublicMetadata
    Description

    Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.

  • Name
    publicUserData?
    Type
    null | OrganizationMembershipPublicUserData
    Description

    Public information about the user that this membership belongs to.

  • Name
    role
    Type
    string
    Description

    The role of the user.

  • Name
    updatedAt
    Type
    number
    Description

    The date when the membership was last updated.

OrganizationMembershipPublicUserData

  • Name
    firstName
    Type
    null | string
    Description

    The first name of the user.

  • Name
    hasImage
    Type
    boolean
    Description

    Whether the user has a profile picture.

  • Name
    identifier
    Type
    string
    Description

    The identifier of the user.

  • Name
    imageUrl
    Type
    string
    Description

    Holds the default avatar or user's uploaded profile image. Compatible with Clerk's Image Optimization.

  • Name
    lastName
    Type
    null | string
    Description

    The last name of the user.

  • Name
    userId
    Type
    string
    Description

    The ID of the user that this public data belongs to.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on