Create | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.organizations.users.invites.create("organizationId", {
        body: {
            email: "string",
            expiresAt: new Date("2024-01-15T09:30:00Z"),
            permission: "billing",
        },
    });
}
main();

{
  "organizationUserInvite": {
    "email": "string",
    "expiresAt": "2024-01-15T09:30:00Z",
    "permission": "billing",
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "id": "string",
    "organizationId": "string",
    "landscapePermissions": {},
    "revokedAt": "2024-01-15T09:30:00Z",
    "revokedBy": "user",
    "revokedById": "string",
    "usedAt": "2024-01-15T09:30:00Z",
    "usedByUserId": "string"
  }
}

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

organizationIdstringRequired

Request

This endpoint expects an object.

emailstringRequired

expiresAtdatetimeRequired

permissionenumRequired

Allowed values:

landscapePermissionsmap from strings to booleansOptional

Response

organizationUserInviteobject

Errors

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error