View Expired Org Invites Component

PropelAuth's View Expired Org Invites Component allows you to customize the UI around viewing expired invites to join an organization. Check out the documentation here for more information about organizations.

Organization Expired Invitations

Shadcn Installation

Install this component from our shadcn registry.

npx shadcn@latest add https://components.propelauth.com/r/view-expired-org-invites.json

Reference APIs

These are the APIs that are used by the above component. You can use these APIs directly in your own code.

fetchExpiredInvites

Fetches a paginated list of an org's expired invites.

Arguments

• Name orgId Type string Description: The ID of the org to fetch expired invites for.
• Name page_number Type number Description: The page number to return. Starts at 0.
• Name page_size Type number Description: The amount of results per page.
• Name email_search Type string Description: Filter by invite email.

Success Response

• Name expired_invites Type ExpiredOrgInvite[] Description: An array of expired invites for the provided org.

  • email string
  • role string
  • additional_roles string[]
  • expires_at_seconds number

• Name total_count Type number Description: The total amount of expired org invites.

• Name page_number Type number Description: The current page.

• Name page_size Type number Description: The maximum amount of results of the page.

• Name has_more_results Type boolean Description: Returns true if there are more results beyond the current page.

Response Functions

The response object has a handle function that you can use to handle the response. These functions can be async, and you can return values from them.

• Name success Description: Successful request.
• Name orgNotFound Description: The provided Org ID was not found.
• Name orgsNotEnabled Description: Organizations are not enabled for the project.
• Name unauthorized Description: The user is not logged in.
• Name unexpectedOrUnhandled Description: An unexpected error occurred.

Request

const { fetchExpiredInvites } = useAuthFrontendApis()

const response = await fetchExpiredInvites("1189c444-8a2d-4c41-8b4b-ae43ce79a492", {
    page_number: 0,
    page_size: 10,
    email_search: "Acme",
});
await response.handle({
    success: (data) => {
        setResponse(data);
    },
    orgNotFound(error) {
        console.error('Org not found', error);
    },
    orgsNotEnabled(error) {
        console.error('Org not enabled', error);
    },
    unexpectedOrUnhandled(error) {
        console.error('Unexpected or unhandled error', error);
    },
});

Successful Response

{
    "expired_invites": [
        {
            "email": "test@example.com",
            "role": "Admin",
            "additional_roles": [
                "Member"
            ],
            "expired_at_seconds": 1737217437
        }
    ],
    "total_count": 1,
    "page_number": 0,
    "page_size": 10,
    "has_more_results": false
}