NexCommand AINexCom Knowledge Base
Field reference

OAuth Client

How to use OAuth Client in Integrations & API Docs: access, working steps, fields, related records and troubleshooting.

System AdminUpdated 12 October 2026Configuration-aware guidance
Open OAuth Client ↗Module guide

Purpose and access

Use the API documentation at api.nexcommand.ai, obtain the required authorized credentials and use the deployment-specific service URLs. SaaS tenants and on-premises installations must retain their own endpoints and access boundaries.

This page is a record page in System Admin → Integrations & API Docs. Use the link above to open the configured destination; permissions are checked by the destination service.

ERP links open in a new tab. Sign in with your own account; record visibility, actions and approval authority follow your assigned permissions. Screens can differ by company and configuration.

Before you start

Prepare the required information: Default Redirect URI, App Name (Client Name), Scopes.

Confirm the company, party, dates, units and source references that apply. Select existing links carefully and check for an existing record before creating a duplicate.

Working steps

  1. Open OAuth Client from System Admin → Integrations & API Docs, or use ERP Search.
  2. Filter the list and open the relevant record. To add a record, use Add/New when your role provides that action.
  3. Complete the editable fields described below. Required fields and validation conditions must be satisfied; read-only values are set by the system or their source records.
  4. Add the required child rows. Review each row’s identifiers, linked records and values, using the child-table field reference below.
  5. Save the record and address validation messages. Reload and verify the saved values and relationships.
  6. Use any additional workflow actions only when the record and your role provide them. Saving this record does not automatically complete a related transaction or external action.

Field reference

These fields come from the installed ERP definition. Hidden fields and password inputs are omitted. Additional conditions, custom scripts and workflow rules can make a field required or read-only in a particular context.

FieldType / behaviorHow to use it
Client IDclient_idData
Optional · Read-only		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Allowed Rolesallowed_rolesTable MultiSelect
Optional		Select the permitted linked entries; the stored rows associate those records with this document.

Linked record: OAuth Client Role

Client Secretclient_secretData
Optional · Read-only		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Default Redirect URIdefault_redirect_uriData
Required		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Skip Authorizationskip_authorizationCheck
Optional		If checked, users will not see the Confirm Access dialog.
App Name (Client Name)app_nameData
Required		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
ScopesscopesText
Required		A list of resources which the Client App will have access to after the user allows it. e.g. project
Redirect URIsredirect_urisText
Optional		URIs for receiving authorization code once the user allows access, as well as failure responses. Typically a REST endpoint exposed by the Client App. e.g. http://hostname/api/method/frappe.integrations.oauth2_logins.login_via_facebook
Client URIclient_uriData
Optional		URL of a web page providing information about the client.
Software IDsoftware_idData
Optional		Unique ID assigned by the client developer used to identify the client software to be dynamically registered. Should remain same across multiple versions or updates of the software.
TOS URItos_uriData
Optional		URL that points to a human-readable terms of service document for the client. Should be shown to end-user before authorizing.
ContactscontactsSmall Text
Optional		New lines separated list of strings representing ways to contact people responsible for this client, typically email addresses.
Logo URIlogo_uriData
Optional		URL that references a logo for the client.
Software Versionsoftware_versionData
Optional		A version identifier string for the client software. The value of the should change on any update of the client software with the same Software ID.
Policy URIpolicy_uriData
Optional		URL that points to a human-readable policy document for the client. Should be shown to end-user before authorizing.
Grant Typegrant_typeSelect
Optional		Choose one of the configured list values. Status fields may be controlled by the record workflow.
Available choices
  • Authorization Code
  • Implicit
Token Endpoint Auth Methodtoken_endpoint_auth_methodSelect
Optional		Value of "None" implies a public client. In such a case Client Secret is not given to the client and token exchange makes use of PKCE.
Available choices
  • Client Secret Basic
  • Client Secret Post
  • None
Response Typeresponse_typeSelect
Optional		Choose one of the configured list values. Status fields may be controlled by the record workflow.
Available choices
  • Code
  • Token

Child tables

Allowed Roles — child-row fields
FieldType / behaviorHow to use it
RoleroleLink
Optional		Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship.

Linked record: Role

Troubleshooting

  • Not permitted: verify the account, role and source-document permission. Do not share an administrator login.
  • Missing record or address: inspect the relevant Link or Dynamic Link fields; a matching title alone does not establish a relationship.
  • Cannot save or change status: review required fields, read-only values, document status and the configured approval transition.
  • Unexpected report or portal result: review company/date filters, source-document submission and the approved party or Employee link.
Was this useful?