Update Credential From Model
This page uses Nexus's generated request and response schema. Requests still require the correct account, workspace, and resource permissions.
/manage/credential/{credential_id}curl --request PATCH 'https://school.narb.cc/api/manage/credential/{credential_id}' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"credential_json": {},
"admin_public": false,
"source": "ingestion_api"
}'This builds a request example. Fill in required query values, then replace path placeholders and YOUR_TOKEN in your own environment. Use a token for a user with access to this workspace. Responses and permissions depend on your account and deployment. Never paste a private token into documentation.
Download the Nexus OpenAPI schema ↗
Import the schema into your API client. It describes the backend source; enabled routes depend on your workspace.
Authentication and scope#
Send requests to the workspace that owns the resource. Authentication does not by itself grant a school membership, class assignment, or administrator permission. School endpoints apply their role and class checks on the server.
Use a credential issued for that workspace with only the permissions your integration needs. Keep it on your server. Do not place credentials in a public website or a shared skill.
Parameters#
| Name | Location | Required | Type |
|---|---|---|---|
credential_id | path | Yes | integer |
tenant_id | query | No | string or null |
The tenant_id parameter is part of the engine schema. It does not authorize a caller to another school. Use the workspace and permissions assigned to your account.
Request body#
Content type: application/json.
| Field | Type | Required | Details |
|---|---|---|---|
credential_json | object | Yes | See Request schema. |
admin_public | boolean | Yes | See Request schema. |
source | string | Yes | Allowed: "ingestion_api", "slack", "web", "google_drive", "gmail", "github", "gitbook", "gitlab", "guru", "bookstack", "outline", "confluence", "jira", "slab", "productboard", "file", "coda", "canvas", "notion", "zulip", "linear", "hubspot", "document360", "gong", "google_sites", "zendesk", "loopio", "box", "dropbox", "sharepoint", "teams", "salesforce", "discourse", "axero", "clickup", "mediawiki", "wikipedia", "asana", "s3", "r2", "google_cloud_storage", "oci_storage", "xenforo", "not_applicable", "discord", "freshdesk", "fireflies", "egnyte", "airtable", "highspot", "drupal_wiki", "imap", "bitbucket", "testrail", "braintrust", "lumapps", "mock_connector", "user_file", "craft_file". |
name | string or null | No | See Request schema. |
curator_public | boolean | No | Default: false. |
groups | array of integer | No | See Request schema. |
Request schema#
The schema includes field limits and required values. Referenced types are included in the downloadable OpenAPI file. Replace example identifiers with IDs from your workspace.
{
"properties": {
"credential_json": {
"additionalProperties": true,
"type": "object",
"title": "Credential Json"
},
"admin_public": {
"type": "boolean",
"title": "Admin Public"
},
"source": {
"$ref": "#/components/schemas/DocumentSource"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"curator_public": {
"type": "boolean",
"title": "Curator Public",
"default": false
},
"groups": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Groups"
}
},
"type": "object",
"required": [
"credential_json",
"admin_public",
"source"
],
"title": "CredentialBase"
}Responses#
200#
Successful Response
{
"anyOf": [
{
"$ref": "#/components/schemas/CredentialSnapshot"
},
{
"$ref": "#/components/schemas/StatusResponse_int_"
}
],
"title": "Response Update Credential From Model Manage Credential Credential Id Patch"
}422#
Validation Error
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}Access and error handling#
A signed-out or expired session needs authentication. A denied request can mean the account lacks permission, class membership, an approved model, or an available allowance. Do not retry a write blindly after a network failure; first check whether it was recorded.
Treat validation errors as a request problem. Use the returned field details to correct the request. Resource identifiers do not confer access.
Schema version#
Generated from Nexus backend source fe1c3a07c793029d3d87191a68f89e481afd6bc8. Check your deployed version before integrating. Schema coverage is not a live acceptance test.