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

# Rename the current Organization

> Send the ETag from `GET /api/v1/organization` in `If-Match`. A missing header returns 428, and 412 means the Organization changed since that read: read it again and retry.

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



## OpenAPI

````yaml /api/openapi.json patch /api/v1/organization
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:
    patch:
      tags:
        - Organization
      summary: Rename the current Organization
      description: >-
        Send the ETag from `GET /api/v1/organization` in `If-Match`. A missing
        header returns 428, and 412 means the Organization changed since that
        read: read it again and retry.


        Requires the GV.APIOwner application role, or a higher role (Owner >
        Contributor > Reader).
      operationId: update_organization
      parameters:
        - description: >-
            Exact strong ETag from the current resource. Weak validators,
            wildcards, and tag lists are rejected.
          in: header
          name: If-Match
          required: true
          schema:
            maxLength: 1024
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1OrganizationUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Organization'
          description: Organization updated.
          headers:
            ETag:
              schema:
                type: string
        '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.
        '412':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: If-Match did not match the resource's current strong ETag.
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The request is syntactically valid but semantically invalid.
        '428':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The exact current ETag is required in If-Match.
        '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:
    V1OrganizationUpdate:
      additionalProperties: false
      properties:
        name:
          description: >-
            New name. Leading and trailing spaces are trimmed, and control
            characters are rejected.
          maxLength: 255
          minLength: 1
          title: Name
          type: string
      required:
        - name
      title: V1OrganizationUpdate
      type: object
    V1Organization:
      additionalProperties: false
      properties:
        createdAt:
          title: Createdat
          type: string
        identityConnection:
          $ref: '#/components/schemas/V1IdentityConnection'
          description: >-
            The Microsoft Entra directory connected to this Organization. Each
            directory connects to one Organization.
        lifecycleStatus:
          description: >-
            `active` is the normal state. `read_only` means no trial or paid
            subscription is in effect, so creating Table Pairs and preparing
            Runs return 402.
          enum:
            - active
            - read_only
            - cancelled
            - purged
          title: Lifecyclestatus
          type: string
        name:
          title: Name
          type: string
        organizationUuid:
          format: uuid
          title: Organizationuuid
          type: string
        revision:
          description: >-
            Version of the Organization's settings; a rename increases it. The
            ETag response header is built from it: send that ETag, not this
            number, in `If-Match`.
          minimum: 1
          title: Revision
          type: integer
        updatedAt:
          title: Updatedat
          type: string
      required:
        - organizationUuid
        - revision
        - name
        - lifecycleStatus
        - identityConnection
        - createdAt
        - updatedAt
      title: V1Organization
      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
    V1IdentityConnection:
      additionalProperties: false
      properties:
        directoryTenantId:
          description: >-
            Microsoft Entra tenant ID of the directory. Tokens from this
            directory reach this Organization.
          format: uuid
          title: Directorytenantid
          type: string
        identityConnectionUuid:
          format: uuid
          title: Identityconnectionuuid
          type: string
        issuer:
          description: >-
            Token issuer for the directory:
            `https://login.microsoftonline.com/{directoryTenantId}/v2.0`.
          title: Issuer
          type: string
        status:
          const: verified
          description: >-
            Always `verified`: a signed-in account from the directory proved it
            when the Organization was activated.
          title: Status
          type: string
        verifiedAt:
          description: When the directory was verified.
          title: Verifiedat
          type: string
      required:
        - identityConnectionUuid
        - directoryTenantId
        - issuer
        - status
        - verifiedAt
      title: V1IdentityConnection
      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.