Invite someone to an organization
Invite one email address to an organization, and return the member. The address is stored lowercased. An address with no HoneyHive user yet gets one, and the invitee receives an email. An email sent for a request made with an API key names the inviter as a HoneyHive teammate.
The new member has no roles, and is INVITED until they first sign in. Sign-in keeps any
roles set before then and adds the roles the organization’s roles manifest gives invited
members. To give them roles now, set their roles with the user_id this returns.
Inviting an address that is already a member returns that member unchanged, and sends no
email, so sending the same invite again is safe. The organization is identified by the
org_id path parameter alone. The x-hh-org-id header does not participate.
Available on self-hosted deployments that do not enable an SSO group scheme. Elsewhere this operation returns 404. An API key that carries a membership permission can carry no permission other than the roles and membership permissions, and is created on an organization.