Skip to main content
PATCH
/
manage
/
credential
/
{credential_id}
Update Credential From Model
curl --request PATCH \
  --url https://cloud.onyx.app/api/manage/credential/{credential_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "credential_json": {},
  "admin_public": true,
  "source": "ingestion_api",
  "name": "<string>",
  "curator_public": false,
  "groups": [
    123
  ],
  "is_user_file": false
}
'
{
  "credential_json": {},
  "admin_public": true,
  "source": "ingestion_api",
  "id": 123,
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "time_created": "2023-11-07T05:31:56Z",
  "time_updated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "curator_public": false,
  "groups": [
    123
  ],
  "is_user_file": false,
  "user_email": "<string>"
}

Authorizations

​
Authorization
string
header
required

Authorization header with Bearer token

Path Parameters

​
credential_id
integer
required

Body

application/json
​
credential_json
Credential Json · object
required
​
admin_public
boolean
required
​
source
enum<string>
required
Available options:
ingestion_api,
slack,
web,
google_drive,
gmail,
requesttracker,
github,
gitbook,
gitlab,
guru,
bookstack,
outline,
confluence,
jira,
slab,
productboard,
file,
coda,
notion,
zulip,
linear,
hubspot,
document360,
gong,
google_sites,
zendesk,
loopio,
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,
mock_connector,
user_file
​
name
string | null
​
curator_public
boolean
default:false
​
groups
integer[]
​
is_user_file
boolean
default:false

Response

Successful Response

​
credential_json
Credential Json · object
required
​
admin_public
boolean
required
​
source
enum<string>
required
Available options:
ingestion_api,
slack,
web,
google_drive,
gmail,
requesttracker,
github,
gitbook,
gitlab,
guru,
bookstack,
outline,
confluence,
jira,
slab,
productboard,
file,
coda,
notion,
zulip,
linear,
hubspot,
document360,
gong,
google_sites,
zendesk,
loopio,
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,
mock_connector,
user_file
​
id
integer
required
​
user_id
string<uuid> | null
required
​
time_created
string<date-time>
required
​
time_updated
string<date-time>
required
​
name
string | null
​
curator_public
boolean
default:false
​
groups
integer[]
​
is_user_file
boolean
default:false
​
user_email
string | null