OAuth Client
Overview
Below is a business-focused explanation of the OAuth Client document in Dafater, written for non-technical users and process owners.
OAuth Client – Business Explanation
What the OAuth Client is used for in business operations
The OAuth Client document is used to safely connect Dafater with external business systems such as partner platforms, mobile apps, customer portals, payment services, or reporting tools.
It allows these external systems to access specific information or perform approved actions in Dafater without sharing user passwords.
In simple terms, the OAuth Client defines who can connect to Dafater, what they are allowed to do, and under what conditions.
Prerequisites and setup requirements
Before using the OAuth Client, the following should be in place:
- A clear business need to connect Dafater with an external system
- Approval from management or data owners on what data or actions can be shared
- Defined business roles or permissions that the external system should have
- Identification of the external party (vendor, partner, internal app, or service)
This document is usually set up by an authorized administrator after business approval.
Typical workflow and how it fits into business processes
A business team identifies the need to integrate Dafater with another system
(for example: customer portal, partner system, or analytics tool).Business rules are defined:
- What information can be accessed
- What actions are allowed (view, create, update, etc.)
- How long access should remain valid
An OAuth Client record is created to represent that external system.
The external system uses this approved connection to interact with Dafater according to the agreed business rules.
Access can be reviewed, adjusted, or revoked at any time if business needs change.
Key business scenarios where OAuth Client is essential
The OAuth Client is critical in scenarios such as:
- Customer portals accessing account or transaction information
- Mobile apps used by employees, agents, or customers
- Partner integrations, such as vendors or service providers
- Payment or financial services connecting securely with Dafater
- Reporting and analytics tools pulling business data automatically
In all these cases, the OAuth Client ensures controlled and accountable access.
Important considerations for users
- Only create an OAuth Client for trusted and approved systems
- Grant minimum required access to protect sensitive business data
- Review active OAuth Clients regularly to ensure they are still needed
- Disable or remove access immediately if a partnership ends
- Treat OAuth Client records as security-sensitive business documents
Business Value Summary
The OAuth Client enables Dafater to work smoothly with other systems while: - Protecting business data - Reducing manual work - Supporting digital channels and automation - Maintaining control and accountability
It is a foundational document for any organization using Dafater as part of a connected business ecosystem.
Basic Information
- Module: Integrations
- Document Type: Document
Fields
| Field Name | Label | Type | Required | Options | Description |
|---|---|---|---|---|---|
| client_id | App Client ID | Data | - | Unique identifier for the application accessing Dafater APIs | |
| app_name | App Name | Data | ✓ | - | Business-friendly name of the application registered in Dafater |
| user | User | Link | User | Dafater user owning and managing this OAuth application | |
| allowed_roles | Allowed Roles | Table MultiSelect | OAuth Client Role | Roles permitted to authorize access for this application | |
| client_secret | App Client Secret | Data | - | Confidential key used by the app to authenticate with Dafater | |
| skip_authorization | Skip Authorization | Check | - | Allow automatic authorization without user consent in Dafater | |
| scopes | Scopes | Text | ✓ | - | Permissions defining data and actions the application can access |
| redirect_uris | Redirect URIs | Text | - | Approved callback URLs where Dafater sends authorization responses | |
| defaultredirecturi | Default Redirect URI | Data | ✓ | - | Primary redirect URL used when none is specified |
| grant_type | Grant Type | Select | Authorization Code, Implicit | OAuth grant method the application uses for access tokens | |
| response_type | Response Type | Select | Code, Token | OAuth response format returned by Dafater during authorization |
Permissions
| Role | Read | Write | Create | Delete | Submit | Cancel |
|---|---|---|---|---|---|---|
| System Manager | ✓ | ✓ | ✓ | ✓ |
Related DocTypes
| DocType | Relationship | Module |
|---|---|---|
| OAuth Authorization Code | Linked from | Integrations |
| OAuth Bearer Token | Linked from | Integrations |
| User | Links to | Core |