openapi: 3.0.1 info: title: Common User Service description: This service provides the means to manage users across Kallidus products version: v1 servers: - url: 'https://gateway.kallidusapi.com/suite-user-import' paths: /v{version}/health: get: summary: Health Check description: Check the health of the 'Suite user import service' operationId: get-health responses: '200': description: Service is running /v{version}/users: post: tags: - PostUsers summary: Imports users operationId: ImportUsers parameters: - name: version in: path required: true schema: type: string - name: Origin in: header description: The orginator of the request required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/User' responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/IActionResult' '400': description: Bad Request content: application/json: schema: type: array items: $ref: '#/components/schemas/Error' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResult' components: schemas: Error: type: object properties: code: $ref: '#/components/schemas/ErrorCode' internalCode: type: string nullable: true message: type: string nullable: true locationType: $ref: '#/components/schemas/ErrorLocationType' location: type: string nullable: true additionalProperties: false ErrorCode: enum: - AlreadyExists - NotValid - OutOfRangeMax - OutOfRangeMin - Required - InvalidState - ResourceHasMissingProperty - ResourceHasInvalidProperty - ResourceNotFound - InternalError type: string ErrorLocationType: enum: - Body - Header - Parameter - Resource type: string IActionResult: type: object additionalProperties: false UnauthorizedResult: type: object properties: statusCode: type: integer format: int32 additionalProperties: false User: type: object properties: firstName: type: string nullable: true lastName: type: string nullable: true userName: type: string nullable: true emailAddress: type: string nullable: true importKey: type: string nullable: true isEnabled: type: boolean nullable: true startDate: type: string format: date-time nullable: true leaveDate: type: string format: date-time nullable: true jobTitle: type: string nullable: true managerImportKey: type: string nullable: true lmsRole: type: string nullable: true customInformation: type: object additionalProperties: type: string nullable: true additionalProperties: false securitySchemes: apiKeyHeader: type: apiKey name: Ocp-Apim-Subscription-Key in: header apiKeyQuery: type: apiKey name: subscription-key in: query security: - apiKeyHeader: [] - apiKeyQuery: []