Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_AuthenticationProtocol
string ls_AuthenticationProtocolVariant
string ls_AuthenticationStatus
string ls_ExternalCredential
string ls_PrincipalName
string ls_PrincipalType
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("externalCredential","")
loo_QueryParams.UpdateString("principalName","")
loo_QueryParams.UpdateString("principalType","")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Resp = loo_Http.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/named-credentials/credential",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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
ls_AuthenticationProtocol = loo_JResp.StringOf("authenticationProtocol")
ls_AuthenticationProtocolVariant = loo_JResp.StringOf("authenticationProtocolVariant")
ls_AuthenticationStatus = loo_JResp.StringOf("authenticationStatus")
ls_ExternalCredential = loo_JResp.StringOf("externalCredential")
ls_PrincipalName = loo_JResp.StringOf("principalName")
ls_PrincipalType = loo_JResp.StringOf("principalType")
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
