> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeyhive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.




## OpenAPI

````yaml https://raw.githubusercontent.com/honeyhiveai/honeyhive-openapi/main/control_plane_openapi.yaml post /v1/orgs/{org_id}/members
openapi: 3.1.0
info:
  title: HoneyHive Control Plane API
  description: >
    Manage HoneyHive control-plane resources: organizations with their roles,
    templates and

    members, workspaces with their templates and members, projects with their
    members and

    alerts, and read org usage.


    Authentication requires a fine-grained control-plane API key (values

    start with `hh_fgcp_`), sent as `Authorization: Bearer <api-key>`.

    Project API keys used with the Data Plane API will not work here. Create

    a key in the HoneyHive app under an organization's or workspace's

    **Settings → API Keys**, or see

    [Authorization](https://docs.honeyhive.ai/v2/control-plane-sdk-reference/typescript#authorization)

    for details.
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 1.19.0
servers:
  - url: https://api.cp.us.honeyhive.ai
security: []
tags:
  - name: Alerts
    description: >
      Define and manage alerts. Alerts evaluate event metrics on a schedule and
      trigger notifications when configured thresholds are crossed.
  - name: Org Members
    description: >
      List an organization's members, invite people to it, set a member's roles,
      and remove people from it and from everything in it. Available on
      self-hosted deployments that do not enable an SSO group scheme.
  - name: Org Templates
    description: >
      Read and replace an organization's templates manifest, which defines the
      metrics and charts that new projects start with. Each workspace gets its
      own copy when it is created, so a new version reaches an existing
      workspace's projects only where that workspace's manifest merges with the
      organization's.
  - name: Orgs
    description: >
      Read an organization's display name and the email domains whose users join
      it automatically when they sign in, and update its display name.
  - name: Project Members
    description: >
      List a project's members, invite people to it, set a member's roles, and
      remove people from it. Available on self-hosted deployments that do not
      enable an SSO group scheme.
  - name: Projects
    description: >
      Create and manage projects within a workspace. A project is the container
      for the events, datasets, evaluations, and alerts logged against it.
  - name: Roles
    description: >
      Read and replace an organization's roles manifest, which defines its roles
      and the permissions each one grants. Available on self-hosted deployments
      only.
  - name: Usage
    description: >
      Read an organization's usage: events and computed metrics per calendar
      month, and current user, workspace and project counts.
  - name: Virtual Dataplanes
    description: >
      Create and manage virtual data planes. A virtual data plane is a logical
      tenant boundary inside an organization, hosted on a physical cluster;
      several virtual data planes commonly share one cluster. Workspaces live
      inside a virtual data plane.
  - name: Workspace Members
    description: >
      List a workspace's members, invite people to it, set a member's roles, and
      remove people from it and from every project in it. Available on
      self-hosted deployments that do not enable an SSO group scheme.
  - name: Workspace Templates
    description: >
      Read and replace a workspace's templates manifest, which defines the
      metrics and charts that new projects in the workspace start with.
  - name: Workspaces
    description: >
      Read and manage workspaces. A workspace groups the projects belonging to
      one team or environment, and owns the API keys and AI provider secrets its
      projects share.
paths:
  /v1/orgs/{org_id}/members:
    post:
      tags:
        - Org Members
      summary: Invite someone to an organization
      description: >
        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.
      operationId: createOrgMember
      parameters:
        - in: path
          name: org_id
          required: true
          schema:
            type: string
          description: The unique identifier of the organization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostMemberRequest'
      responses:
        '200':
          description: >-
            Member invited, or returned unchanged for an address that already
            was one
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostMemberResponse'
        '400':
          description: Invalid request body
        '404':
          description: >-
            Organization not found, the caller may not invite people to it, or
            the deployment does not offer member management. The response does
            not say which.
      security:
        - ControlPlaneApiKey: []
components:
  schemas:
    PostMemberRequest:
      type: object
      properties:
        email:
          type: string
          maxLength: 254
          format: email
          description: >-
            The address to invite. It is stored lowercased, because sign-in
            matches addresses that way
      required:
        - email
      additionalProperties: false
    PostMemberResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          $ref: '#/components/schemas/Member'
      required:
        - success
        - data
      additionalProperties: false
    Member:
      type: object
      properties:
        user_id:
          type: string
          description: The member's user id, the same at every scope
        email:
          type: string
          description: The member's email address
        name:
          type:
            - string
            - 'null'
          description: >-
            The member's display name from their identity provider, when it sent
            one
        role_names:
          type: array
          items:
            type: string
          description: The member's roles at this scope
        state:
          type: string
          enum:
            - INVITED
            - ONBOARDED
          description: >-
            `INVITED` until the member first signs in, `ONBOARDED` after. An API
            key cannot remove an `ONBOARDED` member whose organization roles let
            them revoke API keys, or change those roles to ones that do not, so
            an admin role a key grants can be undone with a key only while the
            member is `INVITED`.
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: string
          description: When the member was added to this scope
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: string
            - type: 'null'
          description: When the member's membership of this scope last changed
      required:
        - user_id
        - email
        - name
        - role_names
        - state
        - created_at
        - updated_at
      additionalProperties: false
      description: One member of a scope
  securitySchemes:
    ControlPlaneApiKey:
      type: http
      scheme: bearer
      description: >-
        A fine-grained control-plane API key (values begin with `hh_fgcp_`).
        Project API keys used with the Data Plane API will not work here. Create
        one in the HoneyHive app under an organization's or workspace's
        **Settings → API Keys**.

````

## Related topics

- [Org Members](https://docs.honeyhive.ai/v2/cli-reference/ref/org-members.md)
- [Org Members Methods](https://docs.honeyhive.ai/v2/control-plane-sdk-reference/typescript/ref/org-members/index.md)
- [Invite someone to a workspace](https://docs.honeyhive.ai/v2/control-plane-api-reference-autogen/workspace-members/invite-someone-to-a-workspace.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.