openapi: 3.0.1
info:
  title: Learn User Service
  description: This service provides the means to manage Learn-specific user data
  version: v1
servers:
  - url: 'https://gateway.kallidusapi.com/learn-user'
paths:
  '/users/{userId}':
    get:
      summary: Get Learn User
      description: Gets a Learn user by id - returning Learn-specific data only
      operationId: 5d8097dd890502a4ecce2f16
      parameters:
        - name: userId
          in: path
          description: identifier of the user
          required: true
          schema:
            type: string
      responses:
        '200':
          description: the requested user is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLearnUser'
        '400':
          description: an empty guid or blank username is supplied
        '401':
          description: the caller cannot be authenticated
        '404':
          description: the user cannot be found
    put:
      summary: Update Learn User
      description: Updates a Learn user - for Learn-specific data only
      operationId: 5d8097dd507453b81bb45687
      parameters:
        - name: userId
          in: path
          description: unique identifer of user to update
          required: true
          schema:
            type: string
      requestBody:
        description: User
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutLearnUser'
      responses:
        '200':
          description: the user is successfully updated and returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLearnUser'
        '400':
          description: the user passed in is missing or invalid
        '401':
          description: the caller cannot be authenticated
        '404':
          description: the user cannot be found
components:
  schemas:
    LearnGeneralSummary:
      type: object
      properties:
        Id:
          type: string
          format: guid
        Summary:
          type: string
    GetLearnUser:
      type: object
      properties:
        Id:
          type: string
          format: guid
        LmsRole:
          $ref: '#/components/schemas/LearnGeneralSummary'
        PrimaryGroup:
          $ref: '#/components/schemas/LearnGeneralSummary'
        Groups:
          type: array
          items:
            $ref: '#/components/schemas/LearnGeneralSummary'
        ApproverUser:
          $ref: '#/components/schemas/LearnGeneralSummary'
        TrainingLocation:
          type: string
        BrandId:
          type: string
      example:
        Id: string
        LmsRole:
          Id: string
          Summary: string
        PrimaryGroup:
          Id: string
          Summary: string
        Groups:
          - Id: string
            Summary: string
        ApproverUser:
          Id: string
          Summary: string
        TrainingLocation: string
        BrandId: string
    PutLearnUser:
      type: object
      properties:
        LmsRole:
          $ref: '#/components/schemas/LearnGeneralSummary'
        PrimaryGroup:
          $ref: '#/components/schemas/LearnGeneralSummary'
        Groups:
          type: array
          items:
            $ref: '#/components/schemas/LearnGeneralSummary'
        ApproverUser:
          $ref: '#/components/schemas/LearnGeneralSummary'
        TrainingLocation:
          type: string
        BrandId:
          type: string
      example:
        LmsRole:
          Id: 10000000-0000-0000-0000-000000000004
          Summary: Manager
        PrimaryGroup:
          Id: 9d9bd40c-1c0c-4d9e-a9a0-75674665ed4a
          Summary: Test Group
        Groups:
          - Id: 9d9bd40c-1c0c-4d9e-a9a0-75674665ed4a
            Summary: Test Group
          - Id: 10000000-0000-0000-0000-000000000001
            Summary: All users
        ApproverUser:
          Id: 31a82684-cbf4-40c8-a39f-4f044cec8a0c
          Summary: Kallidus Administrator
        TrainingLocation: Cirencester
        BrandId: bb6d8f80-1e4f-11e9-a562-fddd73162958
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
    apiKeyQuery:
      type: apiKey
      name: subscription-key
      in: query
security:
  - apiKeyHeader: []
  - apiKeyQuery: []