Main docs page Auth API Ordering API Menu API Venue API Inventory API

Auth API (1.0)

Download OpenAPI specification:Download

OrderingStack auth API

Authentication

oauth2

Security Scheme Type OAuth2
password OAuth Flow
Token URL: https://ordering.3e.pl/auth-oauth2/oauth/token
Scopes:

    oauth2-client

    Security Scheme Type OAuth2
    clientCredentials OAuth Flow
    Token URL: https://ordering.3e.pl/auth-oauth2/oauth/token
    Scopes:

      tenant

      getPublicTenantConfig

      Get tenant public config for front apps

      Authorizations:
      query Parameters
      filter
      string [ 0 .. 128 ] characters [\p{L}\p{N}_.-]+

      Responses

      updatePublicConfig

      Update tenant public properties

      Authorizations:
      Request Body schema: application/json

      default response

      Schema not provided

      Responses

      Request samples

      Content type
      application/json

      config

      {
      • "config1": "value",
      • "config2": "true"
      }

      getCatalogTenant

      Get tenant information. Internal endpoint only available to other services.

      Authorizations:
      path Parameters
      id
      required
      string <uuid>
      query Parameters
      filter
      string [ 0 .. 128 ] characters [\p{L}\p{N}_.-]+

      Responses

      catalog

      getPublicTenantConfig

      Get tenant public config for front apps

      Authorizations:
      query Parameters
      filter
      string [ 0 .. 128 ] characters [\p{L}\p{N}_.-]+

      Responses

      getCatalogTenant

      Get tenant information. Internal endpoint only available to other services.

      Authorizations:
      path Parameters
      id
      required
      string <uuid>
      query Parameters
      filter
      string [ 0 .. 128 ] characters [\p{L}\p{N}_.-]+

      Responses

      getCatalogUser

      Get user information. Internal endpoint only available to other services.

      Authorizations:
      path Parameters
      id
      required
      string <uuid>
      header Parameters
      x-tenant
      required
      string <uuid>

      Responses

      user

      getUserList

      Get paginated list of users. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

      Authorizations:
      query Parameters
      required
      object (UserFilter)

      Responses

      createUser

      Create new user

      Authorizations:
      Request Body schema: application/json

      default response

      login
      required
      string
      password
      required
      string [ 10 .. 64 ] characters
      firstName
      string[\p{L}\p{N}_.-]+
      lastName
      string[\p{L}\p{N}_.-]+
      active
      boolean
      Array of objects (UserRole)

      Responses

      Request samples

      Content type
      application/json

      user

      {
      • "id": "9cbe650a-1fb7-4b06-912b-cead8a013e8b",
      • "login": "testomir5@3e.pl",
      • "password": "password123",
      • "active": true,
      • "roles": [
        ],
      • "firstName": "Arnold",
      • "lastName": "Schwarzenegger"
      }

      getUser

      Get single user data

      Authorizations:
      path Parameters
      id
      required
      string <uuid>
      Example: 9cbe650a-1fb7-4b06-912b-cead8a013e8b

      Responses

      updateUser

      Update user data

      Authorizations:
      path Parameters
      id
      required
      string <uuid>
      Example: 9cbe650a-1fb7-4b06-912b-cead8a013e8b
      Request Body schema: application/json

      default response

      login
      required
      string
      password
      required
      string [ 10 .. 64 ] characters
      firstName
      string[\p{L}\p{N}_.-]+
      lastName
      string[\p{L}\p{N}_.-]+
      active
      boolean
      Array of objects (UserRole)

      Responses

      Request samples

      Content type
      application/json

      user

      {
      • "login": "testomir5@3e.pl",
      • "active": true,
      • "roles": [
        ],
      • "firstName": "Arnold",
      • "lastName": "Schwarzenegger"
      }

      deleteUser

      Delete user. Be careful as this is not reversible. If user has user management role he may delete every single user.

      Authorizations:
      path Parameters
      id
      required
      string <uuid>
      Example: 9cbe650a-1fb7-4b06-912b-cead8a013e8b

      Responses

      getCatalogUser

      Get user information. Internal endpoint only available to other services.

      Authorizations:
      path Parameters
      id
      required
      string <uuid>
      header Parameters
      x-tenant
      required
      string <uuid>

      Responses

      register

      confirm

      Confirm registration. Confirm registraton by providing token sent in e-mail.

      path Parameters
      uid
      required
      string <uuid>
      query Parameters
      tenant
      required
      string <uuid>
      redirect
      boolean
      Default: false
      token
      required
      string [ 16 .. 256 ] characters

      Responses

      register

      Initiate registration. Initiate registraton process by providing all required user detials (email as login).

      header Parameters
      x-tenant
      required
      string <uuid>
      Request Body schema: */*
      login
      required
      string
      password
      required
      string [ 8 .. 64 ] characters
      firstName
      required
      string [ 3 .. 256 ] characters [\p{L}\p{N}_.-]+
      lastName
      required
      string [ 3 .. 256 ] characters [\p{L}\p{N}_.-]+

      Responses