Erply Permissions API

openapi: 3.2.0
info:
  description: "\n\n## Overview\n\n\n\nThis application offers an API for managing assignments and tasks.\n\n\n\nGraphQL endpoint for the same API is [also available](/graph)\n\n\n\n<details><summary>Authentication</summary>\n\n\n\n> \n\n> Authenticate using your Erply credentials and get a sessionKey. This sessionKey and your Erply clientCode must be provided in the HTTP headers of every request. You do not have to authenticate against this API - valid Erply sessionKey-s from other sources are also acceptable. To authenticate using this API, use the `POST /api/v1/auth` endpoint.\n\n>\n\n</details>\n\n"
  title: assignments Assortment Permissions API
  contact: {}
  version: 2.36.5
tags:
- name: Permissions
paths:
  /v1/permissions:
    patch:
      security:
      - sk: []
      - cc: []
      - jwt: []
      description: 'Some entities support setting up permissions on the user level. They include product groups and categpries.

        Response is the userID of the updated user

        '
      tags:
      - Permissions
      summary: Set / Update a permission
      parameters:
      - description: 'values: ''product group'' or ''product category'''
        name: entity
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.Response'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/permissions.SetUserPermissionRequest'
        description: request
        required: true
  /v1/permissions/{userID}:
    get:
      security:
      - sk: []
      - cc: []
      - jwt: []
      tags:
      - Permissions
      summary: Get user permissions
      parameters:
      - description: user ID
        name: userID
        in: path
        schema:
          type: integer
        required: true
      - description: 'values: ''product group'' or ''product category'''
        name: entity
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            X-Total-Count:
              description: total number of records (ignores skip & take parameters)
              schema:
                type: uint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/permissions.UserPermission'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
components:
  schemas:
    responses.Response:
      type: object
      properties:
        id:
          type: integer
          example: 73
    responses.MessageResponse:
      type: object
      properties:
        message:
          type: string
          example: some message
    permissions.UserPermission:
      type: object
      properties:
        isCreateEnabled:
          type: boolean
        isDeleteEnabled:
          type: boolean
        isUpdateEnabled:
          type: boolean
        userID:
          type: integer
    permissions.SetUserPermissionRequest:
      type: object
      properties:
        isCreateEnabled:
          type: boolean
        isDeleteEnabled:
          type: boolean
        isUpdateEnabled:
          type: boolean
        userID:
          type: integer
  securitySchemes:
    AccessToken:
      type: apiKey
      name: accessToken
      in: header
    ErplyClientCode:
      type: apiKey
      name: clientCode
      in: header
    ErplyJWT:
      type: apiKey
      name: jwt
      in: header
    ErplySession:
      type: apiKey
      name: sessionKey
      in: header
    RequestKey:
      type: apiKey
      name: requestKey
      in: header