Aleph Alpha Workspaces API

openapi: 3.2.0
info:
  title: PhariaStudio Workspaces API
  version: 0.1.0
  description: A Workspace is a shared environment where users can collaborate on projects. Workspaces help in organizing and managing projects in large organizations efficiently.
servers:
- url: '{host}/v1/studio'
  variables:
    host:
      default: https://api.pharia.example.com
security:
- BearerAuth: []
tags:
- name: Workspaces
  description: A Workspace is a shared environment where users can collaborate on projects. Workspaces help in organizing and managing projects in large organizations efficiently.
paths:
  /workspaces/{workspace_id}/userlist:
    get:
      tags:
      - Workspaces
      summary: Get Workspace Userlist With Groups
      description: Get a list of all users of a Workspace by the `Workspace` identifier
      operationId: get_workspace_userlist_with_groups_workspaces__workspace_id__userlist_get
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          anyOf:
          - type: string
            format: uuid
          - const: default
            type: string
          title: Workspace Id
      - name: page
        in: query
        required: false
        schema:
          type: integer
          exclusiveMinimum: 0
          description: The page number to retrieve. Starts at 1.
          default: 1
          title: Page
        description: The page number to retrieve. Starts at 1.
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          exclusiveMinimum: 0
          description: The number of items per page.
          default: 25
          title: Size
        description: The number of items per page.
      - name: email_filter
        in: query
        required: false
        schema:
          type: string
          description: Return users whose email addresses contain the filter as a substring. Case insensitive. If not provided, all results are returned.
          examples:
          - foo
          default: ''
          title: Email Filter
        description: Return users whose email addresses contain the filter as a substring. Case insensitive. If not provided, all results are returned.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResponse_Union_User__Group__'
        '404':
          description: List of Workspace users not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    User:
      properties:
        type:
          type: string
          const: user
          title: Type
          default: user
        id:
          type: string
          title: Id
          description: The unique identifier of the user
          examples:
          - '123456789'
        user_name:
          type: string
          title: User Name
          description: The username of the user
          examples:
          - Chuck Norris
        created_at:
          type: string
          format: date-time
          title: Created At
          description: The UTC timestamp of the time the user has been created in ISO 8601 format.
          examples:
          - '2024-08-08T15:09:00Z'
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: The UTC timestamp of the time the user has been updated in ISO 8601 format.
          examples:
          - '2024-08-08T15:09:00Z'
        email:
          type: string
          title: Email
          description: The email of the user
          examples:
          - chuck@norris.com
        profile:
          $ref: '#/components/schemas/UserProfile'
          description: The profile of the user
      type: object
      required:
      - id
      - user_name
      - created_at
      - updated_at
      - email
      - profile
      title: User
    PagedResponse_Union_User__Group__:
      properties:
        total:
          type: integer
          title: Total
        page:
          type: integer
          title: Page
        size:
          type: integer
          title: Size
        num_pages:
          type: integer
          title: Num Pages
        items:
          items:
            anyOf:
            - $ref: '#/components/schemas/User'
            - $ref: '#/components/schemas/Group'
          type: array
          title: Items
          default: []
      type: object
      required:
      - total
      - page
      - size
      - num_pages
      title: PagedResponse[Union[User, Group]]
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Group:
      properties:
        type:
          type: string
          const: group
          title: Type
          default: group
        id:
          type: string
          title: Id
          description: The unique identifier of the group
          examples:
          - '123456789'
        display_name:
          type: string
          title: Display Name
          description: The display name of the group
          examples:
          - Kung Fu fighters
        created_at:
          type: string
          format: date-time
          title: Created At
          description: The UTC timestamp of the time the group has been created in ISO 8601 format.
          examples:
          - '2024-08-08T15:09:00Z'
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: The UTC timestamp of the time the group has been updated in ISO 8601 format.
          examples:
          - '2024-08-08T15:09:00Z'
      type: object
      required:
      - id
      - display_name
      - created_at
      - updated_at
      title: Group
    UserProfile:
      properties:
        given_name:
          type: string
          title: Given Name
          description: The given name of the profile
          examples:
          - Chuck
        last_name:
          type: string
          title: Last Name
          description: The last name of the profile
          examples:
          - Norris
      type: object
      required:
      - given_name
      - last_name
      title: UserProfile
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT