Invite users via API

List current invites

Before creating a new invite, check whether the user already has a pending one:

1
import { IcePanelClient } from "@icepanel/sdk";
2
3
async function main() {
4
    const client = new IcePanelClient({
5
        apiKey: "YOUR_API_KEY_HERE",
6
    });
7
    await client.organizations.users.invites.list("organizationId");
8
}
9
main();

This endpoint returns all invites, including used and revoked ones. An invite is still active if it has no usedAt or revokedAt field and its expiresAt is in the future.

Create an invite

Send an invite to a user by email. Set permission to control their access level (read, write, admin, or billing), and expiresAt to define how long the invite remains valid.

1
import { IcePanelClient } from "@icepanel/sdk";
2
3
async function main() {
4
    const client = new IcePanelClient({
5
        apiKey: "YOUR_API_KEY_HERE",
6
    });
7
    await client.organizations.users.invites.create("organizationId", {
8
        body: {
9
            email: "string",
10
            expiresAt: new Date("2024-01-15T09:30:00Z"),
11
            permission: "billing",
12
        },
13
    });
14
}
15
main();

Note that the createdBy field in the response will be "api-key" when created via API key, not a user ID. This is useful for auditing who or what triggered the invite.

The invited user will receive an email like this:

Note the invite id in the response if you want to revoke the invite in the next step.

Revoke an invite (optional)

If you need to cancel an invite before it is accepted, revoke it using the invite ID:

1
import { IcePanelClient } from "@icepanel/sdk";
2
3
async function main() {
4
    const client = new IcePanelClient({
5
        apiKey: "YOUR_API_KEY_HERE",
6
    });
7
    await client.organizations.users.invites.revoke("organizationId", "organizationUserInviteId");
8
}
9
main();

The response returns the updated invite object with revokedAt and revokedBy fields populated.