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

# Add a user to an organization

> Add a single existing account user to an organization with a specified role.

**Payload Requirements**
- `user_id` and `role` are both required.
- If the user is already a member, their role is updated to the specified value (upsert).

**Role constraints**
- Users with an `annotator` account role can only be assigned the `annotator` organization role.
- Users with a non-annotator account role cannot be assigned the `annotator` organization role.

Requires organization admin.

**Valid example**
```json
{
  "user_id": "VXNlcjo0MjphQmNE",
  "role": "member"
}
```

**Invalid example** (annotator account user assigned non-annotator org role — returns 400)
```json
{
  "user_id": "VXNlcjo0MjphQmNE",
  "role": "admin"
}
```

<Warning>This endpoint is in alpha, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).</Warning>




## OpenAPI

````yaml https://api.arize.com/v2/spec.yaml post /v2/organizations/{org_id}/users
openapi: 3.0.3
info:
  title: Arize REST API
  version: 2.0.0
  description: |
    API specification for the backend data server. The API is hosted globally
    at https://api.arize.com/v2 or in your own environment.
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
  - description: Global
    url: https://api.arize.com
  - description: Regional
    url: https://api.{region}.arize.com
    variables:
      region:
        default: eu-west-1a
        enum:
          - eu-west-1a
          - ca-central-1a
  - description: Custom Host
    url: https://{host}
    variables:
      host:
        default: api.arize.com
security:
  - bearerAuth: []
tags:
  - name: AI Integrations
    description: |
      AI integrations configure access to external LLM providers (e.g. OpenAI,
      Azure OpenAI, AWS Bedrock, Vertex AI). Integrations can be scoped to the
      entire account, a specific organization, or a specific space.
  - name: Annotation Configs
    description: >
      Annotation configs allow you to define consistent annotation schemas that

      can be reused across your workspace, ensuring evaluations are structured
      and

      comparable over time.
  - name: Annotation Queues
    description: >
      Annotation queues help you organize and manage human evaluation workflows.

      Use queues to assign spans or examples to annotators for review and
      labeling.
  - name: API Keys
    description: >
      API keys are used to authenticate requests to the Arize API. List your
      keys

      to view metadata; the raw secret is never returned after creation.
  - name: Datasets
    description: |
      Datasets are structured, version-controlled example collections you use to
      run, evaluate, and track LLM experiments.
  - name: Evaluators
    description: >
      Evaluators are reusable evaluation configurations used to assess the
      quality

      of LLM outputs. They can be template-based (using LLM judges) or
      code-based.
  - name: Experiments
    description: >
      Experiments let you systematically test prompt/model changes using
      datasets,

      tasks, and evaluators.
  - name: Integrations
    description: >
      Integrations configure access to external LLM providers (e.g. OpenAI,

      Azure OpenAI, AWS Bedrock, Vertex AI), notifications services (e.g.
      PagerDuty, Slack), and

      your own agents. Integrations can be scoped to the entire account, a
      specific

      organization, or a specific space.
  - name: Organizations
    description: >
      Organizations are top-level containers within an Arize AX account for
      grouping spaces.
  - name: Projects
    description: |
      Projects represent LLM applications being monitored in Arize where you can
      observe traces and spans.
  - name: Prompts
    description: >
      Prompts are reusable, versioned templates for LLM interactions. Use
      prompts

      to standardize and manage how you interact with LLMs across your
      application.
  - name: Resource Restrictions
    description: |
      Endpoints for restricting and unrestricting resources (projects, models).
  - name: Role Bindings
    description: |
      Role bindings assign a role to a user on a resource. REST currently
      supports space- and project-scoped bindings.
  - name: Roles
    description: >
      Roles define sets of permissions that can be assigned to users within an

      account. Create custom roles to tailor access control to your team's
      needs.
  - name: Spaces
    description: >
      Spaces are containers within an organization for grouping related
      projects,

      datasets, and experiments, enabling collaboration or isolated
      experimentation

      with role-based access control.
  - name: Spans
    description: |
      Spans represent individual operations within a trace. A span captures the
      timing, status, and attributes of a single operation in your application.
  - name: Tasks
    description: |
      Tasks are configurable units of work that tie one or more evaluators to a
      data source (project or dataset). Use tasks to automate evaluation of LLM
      outputs, with support for continuous evaluation and backfill runs.
  - name: Users
    description: >
      Users represent members of an account. The Users endpoints allow creating,

      listing, updating (display name), and removing users from the account
      programmatically.
paths:
  /v2/organizations/{org_id}/users:
    post:
      tags:
        - Organizations
      summary: Add a user to an organization
      description: >
        Add a single existing account user to an organization with a specified
        role.


        **Payload Requirements**

        - `user_id` and `role` are both required.

        - If the user is already a member, their role is updated to the
        specified value (upsert).


        **Role constraints**

        - Users with an `annotator` account role can only be assigned the
        `annotator` organization role.

        - Users with a non-annotator account role cannot be assigned the
        `annotator` organization role.


        Requires organization admin.


        **Valid example**

        ```json

        {
          "user_id": "VXNlcjo0MjphQmNE",
          "role": "member"
        }

        ```


        **Invalid example** (annotator account user assigned non-annotator org
        role — returns 400)

        ```json

        {
          "user_id": "VXNlcjo0MjphQmNE",
          "role": "admin"
        }

        ```


        <Warning>This endpoint is in alpha, read more
        [here](https://arize.com/docs/ax/rest-reference#api-version-stages).</Warning>
      operationId: organizations_add_user
      parameters:
        - $ref: '#/components/parameters/OrgIdPathParam'
      requestBody:
        $ref: '#/components/requestBodies/AddOrganizationUserRequestBody'
      responses:
        '200':
          $ref: '#/components/responses/OrganizationUserAdded'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
components:
  parameters:
    OrgIdPathParam:
      name: org_id
      in: path
      description: The unique organization identifier (base64)
      required: true
      schema:
        $ref: '#/components/schemas/Id'
      example: T3JnYW5pemF0aW9uOjEyMzQ1
  requestBodies:
    AddOrganizationUserRequestBody:
      description: Body containing the user to add to the organization
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OrganizationMembershipInput'
          example:
            user_id: VXNlcjoxMjM0NQ==
            role:
              type: predefined
              name: member
  responses:
    OrganizationUserAdded:
      description: User successfully added to the organization
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OrganizationMembership'
          example:
            id: QWNjb3VudE9yZ2FuaXphdGlvbk1lbWJlcjox
            user_id: VXNlcjoxMjM0NQ==
            organization_id: QWNjb3VudE9yZ2FuaXphdGlvbjox
            role:
              type: predefined
              name: member
    BadRequest:
      description: Invalid request
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 400
            title: Invalid request parameters
            detail: The 'name' field is required and must be a non-empty string.
            instance: /resource
            type: https://arize.com/docs/ax/rest-reference/errors#invalid-request
    Unauthorized:
      description: Authentication is required
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 401
            title: Authentication required
            detail: You must be authenticated to access this resource.
            instance: /resource
            type: >-
              https://arize.com/docs/ax/rest-reference/errors#authentication-required
    Forbidden:
      description: Insufficient permissions to access this resource
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 403
            title: Access forbidden
            detail: You do not have permission to access this resource.
            instance: /resource/12345
            type: https://arize.com/docs/ax/rest-reference/errors#access-forbidden
    NotFound:
      description: Not found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 404
            title: Resource not found
            detail: The requested resource with ID '12345' was not found.
            instance: /resource/12345
            type: https://arize.com/docs/ax/rest-reference/errors#resource-not-found
    UnprocessableEntity:
      description: Unprocessable entity
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 422
            title: Unprocessable Entity
            detail: One or more fields failed validation.
            instance: /resource/12345
            type: >-
              https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity
    RateLimitExceeded:
      description: Rate limit exceeded
      headers:
        Retry-After:
          description: |
            When throttled (429), how long to wait before retrying. Value is
            either a delta-seconds integer.
          schema:
            type: integer
            minimum: 0
          example: 42
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 429
            title: Rate limit exceeded
            detail: >-
              You have exceeded the allowed number of requests. Please try again
              later.
            instance: /resource
            type: >-
              https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded
  schemas:
    Id:
      type: string
      description: A universally unique identifier (base64-encoded opaque string).
      example: RW50aXR5OjEyMzQ1
    OrganizationMembershipInput:
      type: object
      required:
        - user_id
        - role
      properties:
        user_id:
          allOf:
            - $ref: '#/components/schemas/Id'
          description: The unique identifier of the user to add
        role:
          $ref: '#/components/schemas/OrganizationRoleAssignment'
      additionalProperties: false
    OrganizationMembership:
      type: object
      required:
        - id
        - user_id
        - organization_id
        - role
      properties:
        id:
          allOf:
            - $ref: '#/components/schemas/Id'
          description: Unique identifier for the membership record
        user_id:
          allOf:
            - $ref: '#/components/schemas/Id'
          description: The unique identifier of the user
        organization_id:
          allOf:
            - $ref: '#/components/schemas/Id'
          description: The unique identifier of the organization
        role:
          $ref: '#/components/schemas/OrganizationRoleAssignment'
      additionalProperties: false
    Problem:
      type: object
      description: RFC 9457 Problem Details
      properties:
        title:
          type: string
          description: A short, human-readable summary of the problem type
        status:
          type: integer
          description: >-
            The HTTP status code generated by the origin server for this
            occurrence of the problem
        type:
          type: string
          format: uri-reference
          description: A URI reference that identifies the problem type
        detail:
          type: string
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem
        instance:
          type: string
          format: uri-reference
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem
      required:
        - title
        - status
      additionalProperties: false
    OrganizationRoleAssignment:
      oneOf:
        - $ref: '#/components/schemas/OrganizationPredefinedRoleAssignment'
        - $ref: '#/components/schemas/OrganizationCustomRoleAssignment'
      discriminator:
        propertyName: type
        mapping:
          predefined:
            $ref: '#/components/schemas/OrganizationPredefinedRoleAssignment'
          custom:
            $ref: '#/components/schemas/OrganizationCustomRoleAssignment'
      description: >
        A role assignment for an organization membership. Discriminated by
        `type`:

        - `predefined`: one of the predefined roles (`admin`, `member`,
        `read-only`, `annotator`)

        - `custom`: a custom RBAC role identified by its ID
    OrganizationPredefinedRoleAssignment:
      type: object
      description: A predefined organization role assignment.
      required:
        - type
        - name
      properties:
        type:
          allOf:
            - $ref: '#/components/schemas/OrganizationRoleAssignmentType'
          default: predefined
        name:
          $ref: '#/components/schemas/OrganizationRole'
      additionalProperties: false
    OrganizationCustomRoleAssignment:
      type: object
      description: A custom RBAC role assignment.
      required:
        - type
        - id
      properties:
        type:
          allOf:
            - $ref: '#/components/schemas/OrganizationRoleAssignmentType'
          default: custom
        id:
          allOf:
            - $ref: '#/components/schemas/Id'
          description: The unique identifier of the custom RBAC role.
        name:
          type: string
          readOnly: true
          description: |
            Human-readable name of the custom role.
            Returned in responses only; ignored on input.
      additionalProperties: false
    OrganizationRoleAssignmentType:
      type: string
      enum:
        - predefined
        - custom
    OrganizationRole:
      type: string
      enum:
        - admin
        - member
        - read-only
        - annotator
      description: |
        Organization-level role for the user.
        - `admin`: Full access to the organization and its resources.
        - `member`: Standard access to the organization.
        - `read-only`: Read-only access to the organization.
        - `annotator`: Limited access for annotation tasks only.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: <api-key>
      description: >
        Most Arize AI endpoints require authentication. For those endpoints that
        require authentication, include your API key in the request header using
        the format

        ``` Authorization: Bearer <api-key>

        ```

````