Chilkat Online Tools

DescribeWorkspaceAuthentication Powershell Example

AWS Managed Grafana

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$rest = New-Object Chilkat.Rest

$authAws = New-Object Chilkat.AuthAws
$authAws.AccessKey = "AWS_ACCESS_KEY"
$authAws.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.Region = "us-west-2"
$authAws.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 -ne $true) {
    $("ConnectFailReason: " + $rest.ConnectFailReason)
    $($rest.LastErrorText)
    exit
}

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

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestNoBodySb("GET","/workspaces/{workspaceId}/authentication",$sbResponseBody)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$respStatusCode = $rest.ResponseStatusCode
$("response status code = " + $respStatusCode)
if ($respStatusCode -ne 200) {
    $("Response Header:")
    $($rest.ResponseHeader)
    $("Response Body:")
    $($sbResponseBody.GetAsString())
    exit
}

$jResp = New-Object Chilkat.JsonObject
$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 -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("authentication.providers[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("authentication.saml.configuration.allowedOrganizations")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("authentication.saml.configuration.allowedOrganizations[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("authentication.saml.configuration.roleValues.admin")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("authentication.saml.configuration.roleValues.admin[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("authentication.saml.configuration.roleValues.editor")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("authentication.saml.configuration.roleValues.editor[i]")
    $i = $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"
#     }
#   }
# }