Chilkat Online Tools

DescribeWorkspaceAuthentication Ruby Example

AWS Managed Grafana

require 'chilkat'

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

rest = Chilkat::CkRest.new()

authAws = Chilkat::CkAuthAws.new()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_SecretKey("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.)
authAws.put_Region("us-west-2")
authAws.put_ServiceName("grafana")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)

# URL: https://grafana.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("grafana.us-west-2.amazonaws.com",443,true,true)
if (success != true)
    print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
    print rest.lastErrorText() + "\n";
    exit
end

rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","DescribeWorkspaceAuthentication")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET","/workspaces/{workspaceId}/authentication",sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()
print "response status code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 200)
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print sbResponseBody.getAsString() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(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

SsoClientId = jResp.stringOf("authentication.awsSso.ssoClientId")
v_Email = jResp.stringOf("authentication.saml.configuration.assertionAttributes.email")
Groups = jResp.stringOf("authentication.saml.configuration.assertionAttributes.groups")
Login = jResp.stringOf("authentication.saml.configuration.assertionAttributes.login")
Name = jResp.stringOf("authentication.saml.configuration.assertionAttributes.name")
Org = jResp.stringOf("authentication.saml.configuration.assertionAttributes.org")
Role = jResp.stringOf("authentication.saml.configuration.assertionAttributes.role")
v_Url = jResp.stringOf("authentication.saml.configuration.idpMetadata.url")
v_Xml = jResp.stringOf("authentication.saml.configuration.idpMetadata.xml")
LoginValidityDuration = jResp.IntOf("authentication.saml.configuration.loginValidityDuration")
Status = jResp.stringOf("authentication.saml.status")
i = 0
count_i = jResp.SizeOfArray("authentication.providers")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("authentication.providers[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("authentication.saml.configuration.allowedOrganizations")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("authentication.saml.configuration.allowedOrganizations[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("authentication.saml.configuration.roleValues.admin")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("authentication.saml.configuration.roleValues.admin[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("authentication.saml.configuration.roleValues.editor")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("authentication.saml.configuration.roleValues.editor[i]")
    i = i + 1
end

# 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"
#     }
#   }
# }