Main docs page Auth API Ordering API Menu API Venue API Inventory API Payment API Loyalty API Wallet 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

      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

      getSelf

      Get user information about himself.

      Authorizations:

      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

      user

      upsertAuthStrategy

      Upsert auth strategy

      path Parameters
      id
      required
      string <uuid>
      Example: 9cbe650a-1fb7-4b06-912b-cead8a013e8b
      Request Body schema: */*
      strategy
      required
      string [ 1 .. 32 ] characters [a-zA-Z0-9_.-]+
      id
      required
      string [ 1 .. 255 ] characters
      password
      string [ 10 .. 64 ] characters
      active
      boolean

      Responses

      byAuthStrategy

      Find by auth strategy

      query Parameters
      strategy
      required
      string [ 1 .. 32 ] characters [a-zA-Z0-9_.-]+
      Example: strategy=FB
      id
      required
      string [ 1 .. 255 ] characters
      Example: id=12345
      email
      required
      string [ 0 .. 255 ] characters
      Example: email=abc@domain.com

      Responses

      getUser

      Get single user data

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

      Responses

      upsertUser

      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
      string [ 8 .. 64 ] characters
      firstName
      string[\p{L}\p{N}_. -]+
      lastName
      string[\p{L}\p{N}_. -]+
      active
      boolean
      phone
      string [ 3 .. 32 ] characters [a-zA-Z0-9. ()-]+
      pushType
      string
      Enum: "ANDROID" "IOS" "WEB"
      pushId
      string [ 3 .. 256 ] characters
      Array of objects (UserRole) [ 0 .. 64 ] items
      Array of objects (AuthStrategyDto) [ 0 .. 16 ] items
      consents
      Array of strings [ 0 .. 16 ] items
      object

      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

      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
      string [ 8 .. 64 ] characters
      firstName
      string[\p{L}\p{N}_. -]+
      lastName
      string[\p{L}\p{N}_. -]+
      active
      boolean
      phone
      string [ 3 .. 32 ] characters [a-zA-Z0-9. ()-]+
      pushType
      string
      Enum: "ANDROID" "IOS" "WEB"
      pushId
      string [ 3 .. 256 ] characters
      Array of objects (UserRole) [ 0 .. 64 ] items
      Array of objects (AuthStrategyDto) [ 0 .. 16 ] items
      consents
      Array of strings [ 0 .. 16 ] items
      object

      Responses

      Request samples

      Content type
      application/json

      user