Invite a user

POST/auth/admin/invite

Sends an invitation to a user through the Auth admin API.

Parameters

emailstring: The email address to invite.
attributes?object: Application-defined attributes for the invited user.
options.redirectTo?string: Redirect destination used by the invitation.

Returns

userPublicUser

1import { Jupiter } from '@jupiter-cloud/sdk'2 3const teamApiSecret = process.env.JUPITER_TEAM_API_SECRET!4 5const client = new Jupiter(6  'https://api.jupitercloud.co',7  'project-id',8  teamApiSecret9)10 11const result = await client.auth.adminInviteUser(12  'user@example.com',13  { organization: 'Jupiter' },14  { redirectTo: 'https://app.example.com/accept-invite' }15)16 17if (result.error) {18  throw result.error19}20 21console.log(result)

Response

200

1{2  "data": {3    "user": {4      "id": "00000000-0000-4000-8000-000000000000",5      "project_id": "00000000-0000-4000-8000-000000000001",6      "email": "user@example.com",7      "email_verified": true,8      "phone_verified": false,9      "is_anonymous": false,10      "created_at": "2026-01-01T00:00:00.000Z",11      "updated_at": "2026-01-01T00:00:00.000Z"12    }13  },14  "error": null15}