Mirakl Users API

openapi: 3.2.0
info:
  title: Mirakl Users API
  version: ''
  description: 'Operations tagged Users across 4 of this provider''s published API definitions: mirakl-mcm-seller-openapi.json, mirakl-mmp-front-openapi.yaml, mirakl-mmp-seller-openapi.json, mirakl-mms-seller-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- description: URL to be replaced by your Mirakl instance URL
  url: https://your-instance.mirakl.net
tags:
- name: Users
paths:
  /api/users/shops/roles:
    get:
      description: 'Call Frequency


        Recommended usage: On each user role view


        Maximum usage: On each user role view


        Read More


        More context'
      operationId: RO02
      parameters:
      - description: Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.
        explode: true
        in: query
        name: shop_id
        required: false
        schema:
          type: integer
          format: int64
        style: form
      responses:
        '200':
          content:
            application/json:
              examples:
                application/json-0:
                  summary: Example with business values (application/json)
                  value:
                    roles:
                    - code: GROUP_SHOP_ADMIN
                      description: Access to "Dashboard Statistics", access to the "Settings", "Information", and "User Management" menus, ability to call Shop API.
                    - code: GROUP_SHOP_ACCOUNTANCY
                      description: Access to "Statements" and "Transaction History".
                    - code: GROUP_SHOP_INVENTORY
                      description: Access to "Inventory" dashboard, management and messages, and "Mapping Configuration".
                    - code: GROUP_SHOP_SALES
                      description: Access to "Message", "Order" and "Revenue" dashboards, and "Order Management".
                    - code: GROUP_SHOP_SUPPORT
                      description: Access to "Message" and "Order" dashboards, ability to upload order documents and edit seller order references.
                application/json-auto:
                  summary: Complete example with value types (application/json)
                  value:
                    roles:
                    - code: string
                      description: string
              schema:
                type: object
                $ref: '#/components/schemas/RO02_Response_200'
          description: OK
      security:
      - Shop-API-Key:
        - ROLE_PARTNER_SHOP_USER_CREATE
        - ROLE_SHOP_ADMIN
      summary: RO02 - List shop roles
      tags:
      - Users
    servers:
    - description: URL to be replaced by your Mirakl instance URL
      url: https://your-instance.mirakl.net
components:
  schemas:
    RO02_Response_200:
      type: object
      properties:
        roles:
          type: array
          items:
            $ref: '#/components/schemas/RO02_Response_200_Roles'
    RO02_Response_200_Roles:
      type: object
      properties:
        code:
          type: string
        description:
          type: string
  securitySchemes:
    Shop-API-Key:
      in: header
      name: Authorization
      type: apiKey
      x-authorization: '{{SHOP_KEY}}'
    Front-Bearer-Token:
      bearerFormat: JWT
      scheme: bearer
      type: http
      x-authorization: '{{FRONT_BEARER_TOKEN}}'
    OAuth-2:
      description: For more information, see our [Authentication System documentation](https://help.mirakl.com/docs/customers/page/topics/Mirakl/partners_integration/authentication_system.htm)
      flows:
        authorizationCode:
          authorizationUrl: https://auth.mirakl.net/authorize
          refreshUrl: https://auth.mirakl.net/oauth/token
          scopes: {}
          tokenUrl: https://auth.mirakl.net/oauth/token
      type: oauth2
    shop_api_key:
      in: header
      name: Authorization
      type: apiKey
      x-authorization: '{{SHOP_KEY}}'
x-refined-from:
- mirakl-mcm-seller-openapi.json
- mirakl-mmp-front-openapi.yaml
- mirakl-mmp-seller-openapi.json
- mirakl-mms-seller-openapi.json
x-group-parameters: true