openapi: 3.0.3
info:
  title: Baserow API spec Admin User source roles API
  version: 2.2.2
  description: 'For more information about our REST API, please visit [this page](https://baserow.io/docs/apis%2Frest-api).


    For more information about our deprecation policy, please visit [this page](https://baserow.io/docs/apis%2Fdeprecations).'
  contact:
    url: https://baserow.io/contact
  license:
    name: MIT
    url: https://github.com/baserow/baserow/blob/develop/LICENSE
tags:
- name: User source roles
paths:
  /api/application/{application_id}/user-sources/roles/:
    get:
      operationId: list_application_user_source_roles
      description: Lists all the roles of the application related to the provided parameter if the user has access to the related application's workspace. If the workspace is related to a template, then this endpoint will be publicly accessible.
      parameters:
      - in: path
        name: application_id
        schema:
          type: integer
        description: Returns only the roles of the application related to the provided Id.
        required: true
      tags:
      - User source roles
      security:
      - UserSource JWT: []
      - JWT: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_SourceUserSourceRoles'
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_APPLICATION_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
components:
  schemas:
    User_SourceUserSourceRoles:
      oneOf:
      - $ref: '#/components/schemas/LocalBaserowUserSourceUserSourceRoles'
      discriminator:
        propertyName: type
        mapping:
          local_baserow: '#/components/schemas/LocalBaserowUserSourceUserSourceRoles'
    LocalBaserowUserSourceUserSourceRoles:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        roles:
          type: array
          items:
            type: string
          readOnly: true
        table_id:
          type: integer
          nullable: true
          description: The id of the Baserow table we want the data for.
        email_field_id:
          type: integer
          nullable: true
          description: The id of the field to use as email for the user account.
        name_field_id:
          type: integer
          nullable: true
          description: The id of the field that contains the user name.
        role_field_id:
          type: integer
          nullable: true
          description: The id of the field that contains the user role.
      required:
      - id
      - roles
  securitySchemes:
    Database token:
      type: http
      scheme: bearer
      bearerFormat: Token your_token
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT your_token
    UserSource JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT your_token