Chilkat Online Tools

UpdateWorkspaceAuthentication TCL Example

AWS Managed Grafana

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set rest [new_CkRest]

set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "AWS_SECRET_KEY"

# Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
CkAuthAws_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "grafana"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://grafana.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "grafana.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
    puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    exit
}

# The following code creates the JSON request body.
# The JSON created by this code is shown below.

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "authenticationProviders[0]" "string"
CkJsonObject_UpdateString $json "samlConfiguration.allowedOrganizations[0]" "string"
CkJsonObject_UpdateString $json "samlConfiguration.assertionAttributes.email" "string"
CkJsonObject_UpdateString $json "samlConfiguration.assertionAttributes.groups" "string"
CkJsonObject_UpdateString $json "samlConfiguration.assertionAttributes.login" "string"
CkJsonObject_UpdateString $json "samlConfiguration.assertionAttributes.name" "string"
CkJsonObject_UpdateString $json "samlConfiguration.assertionAttributes.org" "string"
CkJsonObject_UpdateString $json "samlConfiguration.assertionAttributes.role" "string"
CkJsonObject_UpdateString $json "samlConfiguration.idpMetadata.url" "string"
CkJsonObject_UpdateString $json "samlConfiguration.idpMetadata.xml" "string"
CkJsonObject_UpdateInt $json "samlConfiguration.loginValidityDuration" 123
CkJsonObject_UpdateString $json "samlConfiguration.roleValues.admin[0]" "string"
CkJsonObject_UpdateString $json "samlConfiguration.roleValues.editor[0]" "string"

# The JSON request body created by the above code:

# {
#   "authenticationProviders": [
#     "string"
#   ],
#   "samlConfiguration": {
#     "allowedOrganizations": [
#       "string"
#     ],
#     "assertionAttributes": {
#       "email": "string",
#       "groups": "string",
#       "login": "string",
#       "name": "string",
#       "org": "string",
#       "role": "string"
#     },
#     "idpMetadata": {
#       "url": "string",
#       "xml": "string"
#     },
#     "loginValidityDuration": number,
#     "roleValues": {
#       "admin": [
#         "string"
#       ],
#       "editor": [
#         "string"
#       ]
#     }
#   }
# }

CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "UpdateWorkspaceAuthentication"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/workspaces/{workspaceId}/authentication" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody

# The following code parses the JSON response.
# A sample JSON response is shown below the sample code.

# Use this online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

set SsoClientId [CkJsonObject_stringOf $jResp "authentication.awsSso.ssoClientId"]
set v_Email [CkJsonObject_stringOf $jResp "authentication.saml.configuration.assertionAttributes.email"]
set Groups [CkJsonObject_stringOf $jResp "authentication.saml.configuration.assertionAttributes.groups"]
set Login [CkJsonObject_stringOf $jResp "authentication.saml.configuration.assertionAttributes.login"]
set Name [CkJsonObject_stringOf $jResp "authentication.saml.configuration.assertionAttributes.name"]
set Org [CkJsonObject_stringOf $jResp "authentication.saml.configuration.assertionAttributes.org"]
set Role [CkJsonObject_stringOf $jResp "authentication.saml.configuration.assertionAttributes.role"]
set v_Url [CkJsonObject_stringOf $jResp "authentication.saml.configuration.idpMetadata.url"]
set v_Xml [CkJsonObject_stringOf $jResp "authentication.saml.configuration.idpMetadata.xml"]
set LoginValidityDuration [CkJsonObject_IntOf $jResp "authentication.saml.configuration.loginValidityDuration"]
set Status [CkJsonObject_stringOf $jResp "authentication.saml.status"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "authentication.providers"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "authentication.providers[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "authentication.saml.configuration.allowedOrganizations"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "authentication.saml.configuration.allowedOrganizations[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "authentication.saml.configuration.roleValues.admin"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "authentication.saml.configuration.roleValues.admin[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "authentication.saml.configuration.roleValues.editor"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "authentication.saml.configuration.roleValues.editor[i]"]
    set i [expr $i + 1]
}

# A sample JSON response body parsed by the above code:

# {
#   "authentication": {
#     "awsSso": {
#       "ssoClientId": "string"
#     },
#     "providers": [
#       "string"
#     ],
#     "saml": {
#       "configuration": {
#         "allowedOrganizations": [
#           "string"
#         ],
#         "assertionAttributes": {
#           "email": "string",
#           "groups": "string",
#           "login": "string",
#           "name": "string",
#           "org": "string",
#           "role": "string"
#         },
#         "idpMetadata": {
#           "url": "string",
#           "xml": "string"
#         },
#         "loginValidityDuration": number,
#         "roleValues": {
#           "admin": [
#             "string"
#           ],
#           "editor": [
#             "string"
#           ]
#         }
#       },
#       "status": "string"
#     }
#   }
# }

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp