UpdateWorkspaceAuthentication PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(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::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "grafana")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://grafana.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"grafana.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
; 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
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"authenticationProviders[0]","string")
CkJsonObject::ckUpdateString(json,"samlConfiguration.allowedOrganizations[0]","string")
CkJsonObject::ckUpdateString(json,"samlConfiguration.assertionAttributes.email","string")
CkJsonObject::ckUpdateString(json,"samlConfiguration.assertionAttributes.groups","string")
CkJsonObject::ckUpdateString(json,"samlConfiguration.assertionAttributes.login","string")
CkJsonObject::ckUpdateString(json,"samlConfiguration.assertionAttributes.name","string")
CkJsonObject::ckUpdateString(json,"samlConfiguration.assertionAttributes.org","string")
CkJsonObject::ckUpdateString(json,"samlConfiguration.assertionAttributes.role","string")
CkJsonObject::ckUpdateString(json,"samlConfiguration.idpMetadata.url","string")
CkJsonObject::ckUpdateString(json,"samlConfiguration.idpMetadata.xml","string")
CkJsonObject::ckUpdateInt(json,"samlConfiguration.loginValidityDuration",123)
CkJsonObject::ckUpdateString(json,"samlConfiguration.roleValues.admin[0]","string")
CkJsonObject::ckUpdateString(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::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","UpdateWorkspaceAuthentication")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/workspaces/{workspaceId}/authentication",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(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
strVal.s
SsoClientId.s = CkJsonObject::ckStringOf(jResp,"authentication.awsSso.ssoClientId")
v_Email.s = CkJsonObject::ckStringOf(jResp,"authentication.saml.configuration.assertionAttributes.email")
Groups.s = CkJsonObject::ckStringOf(jResp,"authentication.saml.configuration.assertionAttributes.groups")
Login.s = CkJsonObject::ckStringOf(jResp,"authentication.saml.configuration.assertionAttributes.login")
Name.s = CkJsonObject::ckStringOf(jResp,"authentication.saml.configuration.assertionAttributes.name")
Org.s = CkJsonObject::ckStringOf(jResp,"authentication.saml.configuration.assertionAttributes.org")
Role.s = CkJsonObject::ckStringOf(jResp,"authentication.saml.configuration.assertionAttributes.role")
v_Url.s = CkJsonObject::ckStringOf(jResp,"authentication.saml.configuration.idpMetadata.url")
v_Xml.s = CkJsonObject::ckStringOf(jResp,"authentication.saml.configuration.idpMetadata.xml")
LoginValidityDuration.i = CkJsonObject::ckIntOf(jResp,"authentication.saml.configuration.loginValidityDuration")
Status.s = CkJsonObject::ckStringOf(jResp,"authentication.saml.status")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"authentication.providers")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"authentication.providers[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"authentication.saml.configuration.allowedOrganizations")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"authentication.saml.configuration.allowedOrganizations[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"authentication.saml.configuration.roleValues.admin")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"authentication.saml.configuration.roleValues.admin[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"authentication.saml.configuration.roleValues.editor")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"authentication.saml.configuration.roleValues.editor[i]")
i = i + 1
Wend
; 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"
; }
; }
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
