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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'externalCredential', ''
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'principalName', ''
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'principalType', ''
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/services/data/v{{version}}/named-credentials/credential', @queryParams
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 @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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 @queryParams
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",
-- "authenticationProtocolVariant": "NoAuthentication",
-- "authenticationStatus": "Configured",
-- "credentials": {},
-- "externalCredential": "Test",
-- "principalName": "Test",
-- "principalType": "NamedPrincipal"
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @authenticationProtocol nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @authenticationProtocol OUT, 'authenticationProtocol'
DECLARE @authenticationProtocolVariant nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @authenticationProtocolVariant OUT, 'authenticationProtocolVariant'
DECLARE @authenticationStatus nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @authenticationStatus OUT, 'authenticationStatus'
DECLARE @externalCredential nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @externalCredential OUT, 'externalCredential'
DECLARE @principalName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @principalName OUT, 'principalName'
DECLARE @principalType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @principalType OUT, 'principalType'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -G -d "externalCredential="
-d "principalName="
-d "principalType="
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/named-credentials/credential
Postman Collection Item JSON
{
"name": "Get Credential",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential?externalCredential=&principalName=&principalType=",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"credential"
],
"query": [
{
"key": "externalCredential",
"value": "",
"description": "Fully qualified developer name of the external credential."
},
{
"key": "principalName",
"value": "",
"description": "Name of the external credential named principal."
},
{
"key": "principalType",
"value": "",
"description": "Type of credential principal. Values are:\n* AwsStsPrincipal\n* NamedPrincipal\n* PerUserPrincipal"
}
]
},
"description": "Get a credential."
},
"response": [
{
"name": "Successful Get Credential",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential?externalCredential=Test&principalName=Test&principalType=NamedPrincipal",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"credential"
],
"query": [
{
"key": "externalCredential",
"value": "Test",
"description": "Fully qualified developer name of the external credential."
},
{
"key": "principalName",
"value": "Test",
"description": "Name of the external credential named principal."
},
{
"key": "principalType",
"value": "NamedPrincipal",
"description": "Type of credential principal. Values are:\n* AwsStsPrincipal\n* NamedPrincipal\n* PerUserPrincipal"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 22 Nov 2023 12:01:04 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": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"authenticationProtocol\": \"Custom\",\n \"authenticationProtocolVariant\": \"NoAuthentication\",\n \"authenticationStatus\": \"Configured\",\n \"credentials\": {},\n \"externalCredential\": \"Test\",\n \"principalName\": \"Test\",\n \"principalType\": \"NamedPrincipal\"\n}"
}
]
}
