Associate Credential To Connector

NOTE(rkuo): internally discussed and the consensus is this endpoint and create_connector_with_mock_credential should be combined.

The intent of this endpoint is to handle connectors that actually need credentials.

PUT /manage/connector/{connector_id}/credential/{credential_id}

Associate Credential To Connector

cURL

curl --request PUT \
  --url https://cloud.onyx.app/api/manage/connector/{connector_id}/credential/{credential_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "auto_sync_options": {},
  "groups": [
    123
  ]
}
'

200

{
  "success": true,
  "message": "<string>",
  "data": 123
}

Authorizations

Authorization · string · header · required

Authorization header with Bearer token

Path Parameters

connector_id · integer · required

credential_id · integer · required

Body

application/json

access_type · enum<string> · required

Available options: public, private, sync

name · string | null

auto_sync_options · Auto Sync Options · object | null

groups · integer[]

Response

200

application/json

Successful Response

success · boolean · required

message · string | null

data · integer | null