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

# Create an Organization invitation

> Records a pending invitation for the address and revokes any earlier pending invitation for the same address. No email is sent: before expiresAt, the person signs in to General Validation with a matching account from the Organization's Microsoft Entra directory and accepts.

Requires the GV.APIOwner application role, or a higher role (Owner > Contributor > Reader).



## OpenAPI

````yaml /api/openapi.json post /api/v1/organization-invitations
openapi: 3.1.0
info:
  description: >-
    General Validation's API for Organization administration, Table Pair and
    Test authoring, Runs, and Result metadata. Microsoft Entra bearer tokens
    authorize every call.
  title: General Validation API
  version: 1.0.0
servers:
  - url: https://api.generalvalidation.com
security: []
tags:
  - description: >-
      Customer-owned Fabric references, immutable Runs, and safe Result
      summaries.
    name: Fabric
  - description: Organizations and verified membership.
    name: Organization
  - description: Subscriptions and entitlements.
    name: Billing
paths:
  /api/v1/organization-invitations:
    post:
      tags:
        - Organization
      summary: Create an Organization invitation
      description: >-
        Records a pending invitation for the address and revokes any earlier
        pending invitation for the same address. No email is sent: before
        expiresAt, the person signs in to General Validation with a matching
        account from the Organization's Microsoft Entra directory and accepts.


        Requires the GV.APIOwner application role, or a higher role (Owner >
        Contributor > Reader).
      operationId: create_organization_invitation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1OrganizationInvitationCreate'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1OrganizationInvitation'
          description: Invitation created.
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: A valid Microsoft Entra bearer token is required.
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The authenticated principal does not have the required role.
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The resource does not exist in this tenant.
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The operation conflicts with current resource or Azure state.
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The request is syntactically valid but semantically invalid.
        '429':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The bounded application request rate was exceeded.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                minimum: 1
                type: integer
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: A required dependency is temporarily unavailable.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                minimum: 1
                type: integer
      security:
        - entraApplication: []
components:
  schemas:
    V1OrganizationInvitationCreate:
      additionalProperties: false
      properties:
        email:
          description: >-
            Sign-in name or email of the person's account in the Organization's
            Microsoft Entra directory. Case does not matter.
          maxLength: 320
          minLength: 3
          title: Email
          type: string
        expiresAt:
          description: >-
            When the invitation stops being redeemable. Include a UTC offset,
            and choose a time between 5 minutes and 30 days from now, or the
            call returns 422.
          format: date-time
          title: Expiresat
          type: string
        role:
          description: Role the person gets on accepting.
          enum:
            - reader
            - contributor
            - owner
          title: Role
          type: string
      required:
        - email
        - role
        - expiresAt
      title: V1OrganizationInvitationCreate
      type: object
    V1OrganizationInvitation:
      additionalProperties: false
      properties:
        acceptedAt:
          anyOf:
            - type: string
            - type: 'null'
          title: Acceptedat
        createdAt:
          title: Createdat
          type: string
        email:
          description: Address the invitation is for, in lowercase.
          title: Email
          type: string
        expiresAt:
          description: After this time the invitation cannot be accepted.
          title: Expiresat
          type: string
        invitationUuid:
          format: uuid
          title: Invitationuuid
          type: string
        revokedAt:
          anyOf:
            - type: string
            - type: 'null'
          title: Revokedat
        role:
          description: Role the person gets on accepting.
          enum:
            - reader
            - contributor
            - owner
          title: Role
          type: string
        status:
          description: >-
            `pending` can still be accepted; `expired` reached expiresAt
            unaccepted. `revoked` means an Owner revoked it, a newer invitation
            replaced it, or the person accepted another invitation or was
            removed.
          enum:
            - pending
            - accepted
            - expired
            - revoked
          title: Status
          type: string
      required:
        - invitationUuid
        - email
        - role
        - status
        - expiresAt
        - acceptedAt
        - revokedAt
        - createdAt
      title: V1OrganizationInvitation
      type: object
    V1Problem:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable machine-readable error code, such as `precondition.failed`.
            Branch on this value.
          title: Code
          type: string
        detail:
          description: What went wrong in this request, written for a person.
          title: Detail
          type: string
        diagnostics:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          description: >-
            Extra details for some errors, such as `fieldErrors` for an invalid
            request or `requiredRole` for a denied one. Absent when there are
            none.
          title: Diagnostics
        instance:
          description: Path of the request that failed.
          title: Instance
          type: string
        requestId:
          description: >-
            This request's ID, also sent in the `X-Request-Id` response header.
            Quote it when you contact support. A request that sends an
            `X-Request-Id` of 1 to 64 letters, digits, or `_.:-` gets that value
            back.
          title: Requestid
          type: string
        status:
          description: The HTTP status code of this response.
          title: Status
          type: integer
        title:
          description: Short summary of the error code.
          title: Title
          type: string
        type:
          description: Link to the documentation page for this error code.
          title: Type
          type: string
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
      title: V1Problem
      type: object
  securitySchemes:
    entraApplication:
      bearerFormat: JWT
      description: >-
        Microsoft Entra application token issued by the caller's Organization
        tenant for this multitenant API. Request the .default scope and assign
        the application the required GV.APIReader, GV.APIContributor, or
        GV.APIOwner role.
      scheme: bearer
      type: http
      x-gv-app-roles:
        - GV.APIReader
        - GV.APIContributor
        - GV.APIOwner
      x-gv-audience: 78d5d8af-9dd6-49dd-b06c-38c3a3c707af
      x-gv-scope: api://78d5d8af-9dd6-49dd-b06c-38c3a3c707af/.default
      x-gv-token-url-template: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token

````

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