Connected App
How to use Connected App 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 record 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
Prepare the required information: Provider Name.
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 Connected App from System Admin → Integrations & API Docs, or use ERP Search.
- Filter the list and open the relevant record. To add a record, use Add/New when your role provides that action.
- 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.
- Add the required child rows. Review each row’s identifiers, linked records and values, using the child-table field reference below.
- 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 |
|---|---|---|
Provider Nameprovider_name | Data Required | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
OpenID Configurationopenid_configuration | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Client Idclient_id | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Redirect URIredirect_uri | Data Optional · Read-only | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Scopesscopes | Table Optional | Add the relevant child rows and review required columns, quantities and references before saving. Linked record: OAuth Scope |
Authorization URIauthorization_uri | Small Text Optional | Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data. |
Token URItoken_uri | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Revocation URIrevocation_uri | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Userinfo URIuserinfo_uri | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Introspection URIintrospection_uri | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Query Parametersquery_parameters | Table Optional | Add the relevant child rows and review required columns, quantities and references before saving. Linked record: Query Parameters |
Child tables
Scopes — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
Scopescope | Data Optional | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Query Parameters — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
Keykey | Data Required | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Valuevalue | Data Required | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
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.