Docs

OrganizationMembershipRequest

The OrganizationMembershipRequest object is the model that describes the request of a user to join an organization.

Properties

  • Name
    id
    Type
    string
    Description

    A unique identifier for this membership request.

  • Name
    organizationId
    Type
    string
    Description

    The organization ID of the organization this request is for.

  • Name
    status
    Type
    'pending' | 'accepted' | 'revoked'
    Description

    The status of the request.

  • Name
    publicUserData
    Type
    PublicUserData
    Description

    Public information about the user that this request belongs to.

  • Name
    createdAt
    Type
    Date
    Description

    The date and time the membership request was created.

  • Name
    updatedAt
    Type
    Date
    Description

    The date and time the membership request was updated.

Methods

accept()

Accepts the request of a user to join the organization the request refers to.

function accept(): Promise<OrganizationMembershipRequest>;

accept() returns

TypeDescription
Promise<OrganizationMembershipRequest>This method returns a Promise which resolves with an OrganizationMembershipRequest instance.

reject()

Rejects the request of a user to join the organization the request refers to.

function reject(): Promise<OrganizationMembershipRequest>;

reject() returns

TypeDescription
Promise<OrganizationMembershipRequest>This method returns a Promise which resolves with an OrganizationMembershipRequest instance.

Feedback

What did you think of this content?