Update Credential Sharing Endpoint
curl --request PUT \
--url https://cloud.onyx.app/api/manage/admin/credential/{credential_id}/sharing \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"admin_public": true,
"curator_public": false,
"groups": [
123
],
"name": "<string>"
}
'import requests
url = "https://cloud.onyx.app/api/manage/admin/credential/{credential_id}/sharing"
payload = {
"admin_public": True,
"curator_public": False,
"groups": [123],
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({admin_public: true, curator_public: false, groups: [123], name: '<string>'})
};
fetch('https://cloud.onyx.app/api/manage/admin/credential/{credential_id}/sharing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cloud.onyx.app/api/manage/admin/credential/{credential_id}/sharing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'admin_public' => true,
'curator_public' => false,
'groups' => [
123
],
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloud.onyx.app/api/manage/admin/credential/{credential_id}/sharing"
payload := strings.NewReader("{\n \"admin_public\": true,\n \"curator_public\": false,\n \"groups\": [\n 123\n ],\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://cloud.onyx.app/api/manage/admin/credential/{credential_id}/sharing")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"admin_public\": true,\n \"curator_public\": false,\n \"groups\": [\n 123\n ],\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.onyx.app/api/manage/admin/credential/{credential_id}/sharing")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"admin_public\": true,\n \"curator_public\": false,\n \"groups\": [\n 123\n ],\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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
],
"user_email": "<string>",
"user_personal_name": "<string>",
"is_owner": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Connectors & Credentials
Update Credential Sharing
Changes who may reuse a saved credential. Only its owner may do this, so
a credential with no owner keeps its sharing. name changes the name
when set.
PUT
/
manage
/
admin
/
credential
/
{credential_id}
/
sharing
Update Credential Sharing Endpoint
curl --request PUT \
--url https://cloud.onyx.app/api/manage/admin/credential/{credential_id}/sharing \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"admin_public": true,
"curator_public": false,
"groups": [
123
],
"name": "<string>"
}
'import requests
url = "https://cloud.onyx.app/api/manage/admin/credential/{credential_id}/sharing"
payload = {
"admin_public": True,
"curator_public": False,
"groups": [123],
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({admin_public: true, curator_public: false, groups: [123], name: '<string>'})
};
fetch('https://cloud.onyx.app/api/manage/admin/credential/{credential_id}/sharing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cloud.onyx.app/api/manage/admin/credential/{credential_id}/sharing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'admin_public' => true,
'curator_public' => false,
'groups' => [
123
],
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloud.onyx.app/api/manage/admin/credential/{credential_id}/sharing"
payload := strings.NewReader("{\n \"admin_public\": true,\n \"curator_public\": false,\n \"groups\": [\n 123\n ],\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://cloud.onyx.app/api/manage/admin/credential/{credential_id}/sharing")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"admin_public\": true,\n \"curator_public\": false,\n \"groups\": [\n 123\n ],\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.onyx.app/api/manage/admin/credential/{credential_id}/sharing")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"admin_public\": true,\n \"curator_public\": false,\n \"groups\": [\n 123\n ],\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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
],
"user_email": "<string>",
"user_personal_name": "<string>",
"is_owner": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Required permission: Manage Connectors & Document Sets (
manage:connectors), or Admin (admin).
A Group Manager can also call this, limited to the groups they manage.Authorizations
Authorization header with Bearer token
Path Parameters
Body
application/json
Who may reuse a credential: CredentialBase's sharing fields.
admin_public shares with every admin (global MANAGE_CONNECTORS).
groups (EE) shares with the users who hold Manage Connectors in one of
the groups: its managers, and members who hold the permission globally.
curator_public is kept for older clients and grants nothing.
Response
Successful Response
Available options:
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, onedrive, teams, outlook, salesforce, discourse, axero, clickup, mediawiki, wikipedia, asana, s3, r2, google_cloud_storage, oci_storage, xenforo, not_applicable, discord, freshdesk, fireflies, zoom, egnyte, airtable, highspot, drupal_wiki, imap, bitbucket, testrail, braintrust, lumapps, youtrack, mock_connector, user_file, craft_file Was this page helpful?