Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to clerkstage.dev

OrganizationMembershipRequest

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

Properties

NameTypeDescription
idstringA unique identifier for this membership request.
organizationIdstringThe organization ID of the organization this request is for.
status'pending' | 'accepted' | 'revoked'The status of the request.
publicUserDataPublicUserDataPublic information about the user that this request belongs to.
createdAtDateThe date and time the membership request was created.
updatedAtDateThe 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>;

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>;

Returns

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

What did you think of this content?

Clerk © 2023