Create

POST

https://api.icepanel.io/v1/organizations/:organizationId/users/invites

POST

/v1/organizations/:organizationId/users/invites

1 import { IcePanelClient } from "@icepanel/sdk";
2 
3 async function main() {
4     const client = new IcePanelClient({
5         environment: "https://api.icepanel.io/v1",
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();

Try it

200Successful

1 {
2   "organizationUserInvite": {
3     "email": "string",
4     "expiresAt": "2024-01-15T09:30:00Z",
5     "permission": "billing",
6     "createdAt": "2024-01-15T09:30:00Z",
7     "createdBy": "user",
8     "createdById": "string",
9     "id": "string",
10     "organizationId": "string",
11     "landscapePermissions": {},
12     "revokedAt": "2024-01-15T09:30:00Z",
13     "revokedBy": "user",
14     "revokedById": "string",
15     "usedAt": "2024-01-15T09:30:00Z",
16     "usedByUserId": "string"
17   }
18 }

Authentication

X-API-Keystring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

Request

This endpoint expects an object.

emailstringRequired

expiresAtdatetimeRequired

permissionenumRequired

Allowed values:

landscapePermissionsmap from strings to booleansOptional

Response

organizationUserInviteobject

Authentication

Path parameters

Request

Response

Errors