OAuth Settings
How to use OAuth Settings in Integrations & API Docs: access, working steps, fields, related records and troubleshooting.
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 settings page in System Admin → Integrations & API Docs. Use the link above to open the configured destination; permissions are checked by the destination service.
Before you start
Review the current settings or existing records and prepare the information needed for the change.
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
- Open OAuth Settings from System Admin → Integrations & API Docs, or use ERP Search.
- Review the existing configuration before editing.
- 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.
- Save the record and address validation messages. Reload and verify the saved values and relationships.
- 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.
| Field | Type / behavior | How to use it |
|---|---|---|
Show Auth Server Metadatashow_auth_server_metadata | Check Optional | Allows clients to fetch metadata from the /.well-known/oauth-authorization-server endpoint. Reference: RFC8414 |
Skip Authorizationskip_authorization | Check Optional | Allows skipping authorization if a user has active tokens. |
Enable Dynamic Client Registrationenable_dynamic_client_registration | Check Optional | Allows clients to register themselves without manual intervention. Registration creates a OAuth Client entry. Reference: RFC7591 |
Allowed Public Client Originsallowed_public_client_origins | Small Text Optional | New line separated list of allowed public client URLs (eg https://frappe.io ), or * to accept all. Public clients are restricted by default. |
Show Protected Resource Metadatashow_protected_resource_metadata | Check Optional | Allows clients to fetch metadata from the /.well-known/oauth-protected-resource endpoint. Reference: RFC9728 |
Show Social Login Key as Authorization Servershow_social_login_key_as_authorization_server | Check Optional | Allows enabled Social Login Key Base URL to be shown as authorization server. |
Resource Nameresource_name | Data Optional | Human-readable name intended for display to the end user. |
Resource Policy URIresource_policy_uri | Data Optional | URL of human-readable page with info on requirements about how the client can use the data. |
Resource Documentationresource_documentation | Data Optional | URL of a human-readable page with info that developers might need. |
Resource TOS URIresource_tos_uri | Data Optional | URL of human-readable page with info about the protected resource's terms of service. |
Scopes Supportedscopes_supported | Small Text Optional | New line separated list of scope values. |
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.