Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "masterLabel": "Sample External Credential",
-- "authenticationProtocol": "Custom",
-- "principals": [
-- {
-- "principalName": "SamplePrincipal",
-- "principalType": "NamedPrincipal",
-- "sequenceNumber": 1
-- }
-- ],
-- "customHeaders": [
-- {
-- "headerName": "SampleHeader",
-- "headerValue": "SampleHeaderValue",
-- "sequenceNumber": 1
-- }
-- ]
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'masterLabel', 'Sample External Credential'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'authenticationProtocol', 'Custom'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'principals[0].principalName', 'SamplePrincipal'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'principals[0].principalType', 'NamedPrincipal'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'principals[0].sequenceNumber', 1
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'customHeaders[0].headerName', 'SampleHeader'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'customHeaders[0].headerValue', 'SampleHeaderValue'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'customHeaders[0].sequenceNumber', 1
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @sbRequestBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME', @sbRequestBody, 'utf-8', 'application/json', 0, 0
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "authenticationProtocol": "Custom",
-- "authenticationStatus": "Unknown",
-- "customHeaders": [
-- {
-- "headerName": "SampleHeader",
-- "headerValue": "SampleHeaderValue",
-- "id": "0pu2o000000KymkAAC",
-- "sequenceNumber": 1
-- }
-- ],
-- "developerName": "SampleExternalCredential",
-- "id": "0pt2o000000CaU0AAK",
-- "masterLabel": "Sample External Credential",
-- "parameters": [
-- ],
-- "principals": [
-- {
-- "authenticationStatus": "Unknown",
-- "id": "0pu2o000000KymjAAC",
-- "parameters": [
-- ],
-- "principalAccess": [
-- ],
-- "principalName": "SamplePrincipal",
-- "principalType": "NamedPrincipal",
-- "sequenceNumber": 1
-- }
-- ],
-- "relatedNamedCredentials": [
-- {
-- "developerName": "SamplePrivate",
-- "id": "0XA2o000000XaAQGA0",
-- "masterLabel": "SamplePrivateLabel",
-- "url": "/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate"
-- }
-- ],
-- "url": "/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential"
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @headerName nvarchar(4000)
DECLARE @headerValue nvarchar(4000)
DECLARE @sequenceNumber int
DECLARE @principalName nvarchar(4000)
DECLARE @principalType nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @authenticationProtocol nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @authenticationProtocol OUT, 'authenticationProtocol'
DECLARE @authenticationStatus nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @authenticationStatus OUT, 'authenticationStatus'
DECLARE @developerName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @developerName OUT, 'developerName'
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @masterLabel nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @masterLabel OUT, 'masterLabel'
DECLARE @url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'url'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'customHeaders'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @headerName OUT, 'customHeaders[i].headerName'
EXEC sp_OAMethod @jResp, 'StringOf', @headerValue OUT, 'customHeaders[i].headerValue'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'customHeaders[i].id'
EXEC sp_OAMethod @jResp, 'IntOf', @sequenceNumber OUT, 'customHeaders[i].sequenceNumber'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'parameters'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'principals'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @authenticationStatus OUT, 'principals[i].authenticationStatus'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'principals[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @principalName OUT, 'principals[i].principalName'
EXEC sp_OAMethod @jResp, 'StringOf', @principalType OUT, 'principals[i].principalType'
EXEC sp_OAMethod @jResp, 'IntOf', @sequenceNumber OUT, 'principals[i].sequenceNumber'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'principals[i].parameters'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'principals[i].principalAccess'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'relatedNamedCredentials'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @developerName OUT, 'relatedNamedCredentials[i].developerName'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'relatedNamedCredentials[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @masterLabel OUT, 'relatedNamedCredentials[i].masterLabel'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'relatedNamedCredentials[i].url'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"masterLabel": "Sample External Credential",
"authenticationProtocol": "Custom",
"principals": [
{
"principalName": "SamplePrincipal",
"principalType": "NamedPrincipal",
"sequenceNumber": 1
}
],
"customHeaders": [
{
"headerName": "SampleHeader",
"headerValue": "SampleHeaderValue",
"sequenceNumber": 1
}
]
}'
https://domain.com/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME
Postman Collection Item JSON
{
"name": "Update External Credential",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"masterLabel\": \"Sample External Credential\",\n \"authenticationProtocol\": \"Custom\",\n \"principals\": [\n {\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"sequenceNumber\": 1\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"external-credentials",
":DEVELOPER_NAME"
],
"variable": [
{
"key": "DEVELOPER_NAME",
"value": ""
}
]
},
"description": "Update an external credential."
},
"response": [
{
"name": "Successful Update External Credential",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"masterLabel\": \"Sample External Credential\",\n \"authenticationProtocol\": \"Custom\",\n \"principals\": [\n {\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"sequenceNumber\": 1\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"external-credentials",
":DEVELOPER_NAME"
],
"variable": [
{
"key": "DEVELOPER_NAME",
"value": "SampleExternalCredential"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 16:55:19 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"authenticationProtocol\": \"Custom\",\n \"authenticationStatus\": \"Unknown\",\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"id\": \"0pu2o000000KymkAAC\",\n \"sequenceNumber\": 1\n }\n ],\n \"developerName\": \"SampleExternalCredential\",\n \"id\": \"0pt2o000000CaU0AAK\",\n \"masterLabel\": \"Sample External Credential\",\n \"parameters\": [],\n \"principals\": [\n {\n \"authenticationStatus\": \"Unknown\",\n \"id\": \"0pu2o000000KymjAAC\",\n \"parameters\": [],\n \"principalAccess\": [],\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"relatedNamedCredentials\": [\n {\n \"developerName\": \"SamplePrivate\",\n \"id\": \"0XA2o000000XaAQGA0\",\n \"masterLabel\": \"SamplePrivateLabel\",\n \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate\"\n }\n ],\n \"url\": \"/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential\"\n}"
}
]
}
