Verta UACService API

openapi: 3.2.0
info:
  title: deployment/APISync.proto AuthzService UAC Service API
  version: version not set
servers:
- url: /v1
tags:
- name: UACService
paths:
  /uac/addDevKey:
    post:
      summary: adds new user developer key
      operationId: UACService_addDevKey
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uacUserInfo'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      tags:
      - UACService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vertauacEmpty'
        required: true
  /uac/addDevKeyForUser:
    post:
      summary: adds new user developer key
      operationId: UACService_addDevKeyForUser
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uacUserInfo'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      tags:
      - UACService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/uacChangeDevKeyForUser'
        required: true
  /uac/createUser:
    post:
      summary: For now, any user can create a new user
      operationId: UACService_createUser
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uacCreateUserResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      tags:
      - UACService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/uacCreateUser'
        required: true
  /uac/deletePrimaryDevKey:
    delete:
      summary: deletes primary developer key
      operationId: UACService_deletePrimaryDevKey
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uacUserInfo'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      tags:
      - UACService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vertauacEmpty'
        required: true
  /uac/deletePrimaryDevKeyForUser:
    delete:
      summary: deletes primary developer key
      operationId: UACService_deletePrimaryDevKeyForUser
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uacUserInfo'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      tags:
      - UACService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/uacChangeDevKeyForUser'
        required: true
  /uac/deleteSecondaryDevKey:
    delete:
      summary: deletes secondary developer key
      operationId: UACService_deleteSecondaryDevKey
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uacUserInfo'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      tags:
      - UACService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vertauacEmpty'
        required: true
  /uac/deleteSecondaryDevKeyForUser:
    delete:
      summary: deletes primary developer key
      operationId: UACService_deleteSecondaryDevKeyForUser
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uacUserInfo'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      tags:
      - UACService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/uacChangeDevKeyForUser'
        required: true
  /uac/deleteUser:
    post:
      summary: Only current user can delete themselves
      operationId: UACService_deleteUser
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uacDeleteUserResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      tags:
      - UACService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/uacDeleteUser'
        required: true
  /uac/getCurrentUser:
    get:
      summary: Get the current user information verifying JWT token
      operationId: UACService_getCurrentUser
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uacUserInfo'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      tags:
      - UACService
  /uac/getUser:
    get:
      summary: Get the current user information verifying JWT token
      operationId: UACService_getUser
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uacUserInfo'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      parameters:
      - name: user_id
        in: query
        required: false
        schema:
          type: string
      - name: email
        in: query
        required: false
        schema:
          type: string
      - name: username
        in: query
        required: false
        schema:
          type: string
      tags:
      - UACService
  /uac/getUsers:
    post:
      operationId: UACService_getUsers
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uacGetUsersResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      tags:
      - UACService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/uacGetUsers'
        required: true
  /uac/getUsersFuzzy:
    post:
      operationId: UACService_getUsersFuzzy
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uacGetUsersFuzzyResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      tags:
      - UACService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/uacGetUsersFuzzy'
        required: true
  /uac/updateUser:
    post:
      summary: Only current user can update themselves
      operationId: UACService_updateUser
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uacUpdateUserResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      tags:
      - UACService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/uacUpdateUser'
        required: true
components:
  schemas:
    uacCreateUser:
      type: object
      properties:
        info:
          $ref: '#/components/schemas/uacUserInfo'
        password:
          type: string
    uacVertaUserInfo:
      type: object
      properties:
        individual_user:
          type: boolean
        username:
          type: string
        refresh_timestamp:
          type: string
          format: uint64
        last_login_timestamp:
          type: string
          format: uint64
        user_id:
          type: string
        publicProfile:
          $ref: '#/components/schemas/uacFlagEnum'
        workspace_id:
          type: string
        default_workspace_id:
          type: string
          format: uint64
          title: 'Workspace that the user has selected as their default. Initializes to the user''s personal workspace

            When the user is added to their _first_ org, the default workspace automatically switches to that if it was the default value

            This should be empty if the user is not the current user'
        description:
          type: string
    uacDeleteUserResponse:
      type: object
      properties:
        status:
          type: boolean
    uacGetUsersFuzzyResponse:
      type: object
      properties:
        user_infos:
          type: array
          items:
            $ref: '#/components/schemas/uacUserInfo'
        total_records:
          type: string
          format: int64
    uacGetUsers:
      type: object
      properties:
        user_ids:
          type: array
          items:
            type: string
        emails:
          type: array
          items:
            type: string
        usernames:
          type: array
          items:
            type: string
        pagination:
          $ref: '#/components/schemas/commonPagination'
    commonPagination:
      type: object
      properties:
        page_number:
          type: integer
          format: int32
        page_limit:
          type: integer
          format: int32
      title: For pagination
    uacUpdateUserResponse:
      type: object
      properties:
        info:
          $ref: '#/components/schemas/uacUserInfo'
    uacDeleteUser:
      type: object
      properties:
        user_id:
          type: string
    uacCreateUserResponse:
      type: object
      properties:
        info:
          $ref: '#/components/schemas/uacUserInfo'
    uacGetUsersFuzzy:
      type: object
      properties:
        email:
          type: string
        username:
          type: string
        pagination:
          $ref: '#/components/schemas/commonPagination'
    runtimeError:
      type: object
      properties:
        error:
          type: string
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/protobufAny'
    vertauacEmpty:
      type: object
    uacUpdateUser:
      type: object
      properties:
        info:
          $ref: '#/components/schemas/uacUserInfo'
        password:
          type: string
        default_workspace_id:
          type: string
          format: uint64
    uacFlagEnum:
      type: string
      enum:
      - UNDEFINED
      - 'TRUE'
      - 'FALSE'
      default: UNDEFINED
    uacChangeDevKeyForUser:
      type: object
      properties:
        user_id:
          type: string
    uacUserInfo:
      type: object
      properties:
        user_id:
          type: string
        full_name:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        email:
          type: string
        id_service_provider:
          $ref: '#/components/schemas/IdServiceProviderEnumIdServiceProvider'
        roles:
          type: array
          items:
            type: string
        image_url:
          type: string
        dev_key:
          type: string
        verta_info:
          $ref: '#/components/schemas/uacVertaUserInfo'
        secondary_dev_key:
          type: string
        disabled:
          type: boolean
        job_title:
          type: string
        company:
          type: string
        created_at:
          type: string
          format: uint64
    IdServiceProviderEnumIdServiceProvider:
      type: string
      enum:
      - UNKNOWN
      - GITHUB
      - BITBUCKET
      - GOOGLE
      - VERTA
      - SAML
      - AD_OAUTH2
      - LDAP
      - OKTA_SCIM
      - AD_SCIM
      - SCIM
      default: UNKNOWN
    protobufAny:
      type: object
      properties:
        type_url:
          type: string
          description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
        value:
          type: string
          format: byte
          description: Must be a valid serialized protocol buffer of the above specified type.
      description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"
    uacGetUsersResponse:
      type: object
      properties:
        user_infos:
          type: array
          items:
            $ref: '#/components/schemas/uacUserInfo'
        total_records:
          type: string
          format: int64