Managing OAuth Client Credentials

Managing OAuth Client Credentials

Overview

Xilnex Auth implements the OAuth 2.0 protocol to govern service-to-service authorization. Client credentials serve as the authentication identity for backend services, enabling them to authorize, or be authorized by, other services within the platform.

Each set of client credentials is scoped to a single service and must be associated with a Project. A Project acts as an organizational container and may hold multiple sets of client credentials.

Prerequisites

Before accessing the OAuth Client Configuration, ensure the appropriate role permission has been granted by your system administrator.

  1. Navigate to System Configuration.
  2. Go to User Roles & Permission.
  3. Select All Permissions.
  4. Locate the Developer tab.
  5. Enable "Allow to access Developer Configuration".

Create New OAuth Client

Step 1 — Create a Project
  1. Log in to the Xilnex Portal at portal.xilnex.com.
  2. Navigate to the Developer section.

  3. Select OAuth Clients under OAuth section.

  4. Click New to initiate a new Project.

  5. Complete the Project details and click Save.

FieldRequirementNotes
Project NameRequiredUsed as the display identifier for the credential group
DescriptionOptionalRecommended for documentation purposes
Created DateAuto-populatedDefaults to the current date; not editable

Step 2 — Add OAuth Client to the Project
  1. Once the Project is saved successfully, under the Project, select Add OAuth Client to create a client credential.

  2. Complete all required fields and click Save.

  3. Complete all required fields and click Save.
FieldDescription
Client NameA unique, descriptive name for this set of credentials  (between 5 to 50 characters)
Application TypeThe category of application consuming these credentials
App NameThe name of the consuming application  (between 5 to 50 characters)
App VersionThe version identifier of the consuming application
Client URIThe application's URI (if applicable)
ScopesThe permission scopes required by this client

Notes
Billing - Upon generation of a Client ID and Secret, the application fee will be charged immediately through my registered billing account.
One-Time Secret Visibility - The Client Secret will be displayed only once upon creation. I understand it cannot be retrieved again after this screen is closed. If lost, a new secret must be regenerated, which may affect existing integrations.
Confidentiality Responsibility - User is solely responsible for keeping the Client ID and Client Secret secure and confidential. Sharing or exposing these credentials to unauthorized parties is strictly prohibited.
Misuse Accountability - Any API activity conducted using these credentials is user's responsibility. Xilnex shall not be liable for unauthorized access resulting from credential mishandling.
Revocation Right - Xilnex reserves the right to revoke credentials that are found to be misused, compromised, or in violation of the platform's usage policy.

Edit Project Details

  1. From the OAuth Client project list, select the Project you wish to modify.
  2. Update the Project Name and/or Description as needed.
  3. Click Save to apply changes.

Delete A Project

  1. From the OAuth Client project list, select the Project you wish to modify.
  2. Select Delete.

  3. A confirmation will be prompt.

  4. Click Confirm to apply changes.
Info
A Project cannot be deleted while it has active Client Credentials. You must remove all associated Client Credentials before the Project itself can be deleted

Edit OAuth Client Details

  1. Select then Project Name then select the OAuth Client you wish to modify.
  2. Update the details as needed.
  3. Click Save to apply changes.

Delete OAuth Client 

  1. Select then Project Name then find the OAuth Client you wish to modify.
  2. Select More.

  3. A confirmation message will be shown.

  4. Enter the Client Name to confirm the action.
  5. Select Confirm Delete. A message will be shown upon success.


    • Recent Articles

    • Managing OAuth Client Credentials

      Overview Xilnex Auth implements the OAuth 2.0 protocol to govern service-to-service authorization. Client credentials serve as the authentication identity for backend services, enabling them to authorize, or be authorized by, other services within ...

    • Downloading Store Sample CSV Template File in Xilnex Portal

      Overview The Download Store Sample CSV Template File feature in Store Management Import and Log allows staff to download a sample template, containing all necessary fields and proper format for importing data into the system. Preparing imported files ...

    • Importing Store Details in Xilnex Portal

      Overview The Import Store Details in Xilnex Portal is a function that allows users to import store data in bulk using CSV files. Users have the option to import the store details either With updating the existing records or Without updating the ...

    • Centralized Secondary Screen Media

      Secondary Screen Guidelines Current Setup (Local Media) Currently, the secondary screen relies on a local folder to display media on the POS. Xilnex POS automatically creates a folder named "SecondaryMonitorMedia" on the desktop, or users can ...

    • LiveOrder Dynamic QR - Setup Guide

      What is Dynamic QR? Dynamic QR generates a unique, per-session QR code at point of order — typically printed when a table is opened. The customer scans it to place or continues an order tied to that specific table session. Unlike Static QR ...

    • Popular Articles

    • Basic - How to create a voucher-coupon

      Voucher and coupon definition Voucher can be generated in bulk and can be used once Coupon can only be created one at a time (reusable code) and can be use multiple times Pre-voucher / coupon setup There are 2 things need to be prepared before we can ...

    • Understanding DuitNow QR Payment in ClassicPOS

      Introduction This document introduces the DuitNow QR payment feature available in the Xilnex Retail POS, enabling merchants to accept payments conveniently through Malaysia's national QR payment standard. The integration of DuitNowQR simplifies the ...

    • Basic - How to change custom cost to another branch that don’t have custom cost

      Change custom cost to another branch that don’t have custom cost 1. Get the item list from the location with custom cost (Item Code, Name, Custom Cost) 2. Make sure the Show Location Price are selected 3. Export the item list in Excel 4. The file ...

    • Intermediate - How to Bill & Post to Sales from Transfer Note

      1.0 Purpose A bill is required from transfer note when an inventory transfer involves financial transactions, cost allocation, or compliance with tax and accounting regulations. It is used when stock is moved between outlets that operate as separate ...

    • Basic - How to enable E-Receipt Portal and QR Code Setup on Printing format in Xilnex

      Enable E-Receipt Portal Enable the E-receipt functionality Once Enabled, you will be getting the E-Receipt portal link Continue under Theme & Styling, enabled for the E-Invoice (LHDN) You can customize the look and feel of the E-Receipt portal ...