DescribeCertificateAuthority 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, "acm-pca")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://acm-pca.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"acm-pca.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,"CertificateAuthorityArn","string")
; The JSON request body created by the above code:
; {
; "CertificateAuthorityArn": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","ACMPrivateCA.DescribeCertificateAuthority")
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","/",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
DirectoryNameCommonName.s
DirectoryNameCountry.s
DirectoryNameDistinguishedNameQualifier.s
DirectoryNameGenerationQualifier.s
DirectoryNameGivenName.s
DirectoryNameInitials.s
DirectoryNameLocality.s
DirectoryNameOrganization.s
DirectoryNameOrganizationalUnit.s
DirectoryNamePseudonym.s
DirectoryNameSerialNumber.s
DirectoryNameState.s
DirectoryNameSurname.s
DirectoryNameTitle.s
DnsName.s
NameAssigner.s
PartyName.s
IpAddress.s
TypeId.s
Value.s
RegisteredId.s
Rfc822Name.s
UniformResourceIdentifier.s
AccessMethodType.s
CustomObjectIdentifier.s
Arn.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.Arn")
CRLSign.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.CRLSign")
DataEncipherment.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.DataEncipherment")
DecipherOnly.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.DecipherOnly")
DigitalSignature.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.DigitalSignature")
EncipherOnly.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.EncipherOnly")
KeyAgreement.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.KeyAgreement")
KeyCertSign.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.KeyCertSign")
KeyEncipherment.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.KeyEncipherment")
NonRepudiation.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.NonRepudiation")
KeyAlgorithm.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.KeyAlgorithm")
SigningAlgorithm.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.SigningAlgorithm")
CommonName.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.Subject.CommonName")
Country.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.Subject.Country")
DistinguishedNameQualifier.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.Subject.DistinguishedNameQualifier")
GenerationQualifier.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.Subject.GenerationQualifier")
GivenName.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.Subject.GivenName")
Initials.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.Subject.Initials")
Locality.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.Subject.Locality")
Organization.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.Subject.Organization")
OrganizationalUnit.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.Subject.OrganizationalUnit")
Pseudonym.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.Subject.Pseudonym")
SerialNumber.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.Subject.SerialNumber")
State.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.Subject.State")
Surname.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.Subject.Surname")
Title.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.Subject.Title")
CreatedAt.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.CreatedAt")
FailureReason.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.FailureReason")
KeyStorageSecurityStandard.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.KeyStorageSecurityStandard")
LastStateChangeAt.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.LastStateChangeAt")
NotAfter.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.NotAfter")
NotBefore.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.NotBefore")
OwnerAccount.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.OwnerAccount")
RestorableUntil.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.RestorableUntil")
CustomCname.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.RevocationConfiguration.CrlConfiguration.CustomCname")
Enabled.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.RevocationConfiguration.CrlConfiguration.Enabled")
ExpirationInDays.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.RevocationConfiguration.CrlConfiguration.ExpirationInDays")
S3BucketName.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.RevocationConfiguration.CrlConfiguration.S3BucketName")
S3ObjectAcl.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.RevocationConfiguration.CrlConfiguration.S3ObjectAcl")
OcspConfigurationEnabled.i = CkJsonObject::ckIntOf(jResp,"CertificateAuthority.RevocationConfiguration.OcspConfiguration.Enabled")
OcspCustomCname.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.RevocationConfiguration.OcspConfiguration.OcspCustomCname")
Serial.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.Serial")
Status.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.Status")
v_Type.s = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.Type")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess")
While i < count_i
CkJsonObject::setCkI(jResp, i)
DirectoryNameCommonName = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.CommonName")
DirectoryNameCountry = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Country")
DirectoryNameDistinguishedNameQualifier = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.DistinguishedNameQualifier")
DirectoryNameGenerationQualifier = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.GenerationQualifier")
DirectoryNameGivenName = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.GivenName")
DirectoryNameInitials = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Initials")
DirectoryNameLocality = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Locality")
DirectoryNameOrganization = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Organization")
DirectoryNameOrganizationalUnit = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.OrganizationalUnit")
DirectoryNamePseudonym = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Pseudonym")
DirectoryNameSerialNumber = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.SerialNumber")
DirectoryNameState = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.State")
DirectoryNameSurname = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Surname")
DirectoryNameTitle = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Title")
DnsName = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DnsName")
NameAssigner = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.EdiPartyName.NameAssigner")
PartyName = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.EdiPartyName.PartyName")
IpAddress = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.IpAddress")
TypeId = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.OtherName.TypeId")
Value = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.OtherName.Value")
RegisteredId = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.RegisteredId")
Rfc822Name = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.Rfc822Name")
UniformResourceIdentifier = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.UniformResourceIdentifier")
AccessMethodType = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessMethod.AccessMethodType")
CustomObjectIdentifier = CkJsonObject::ckStringOf(jResp,"CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessMethod.CustomObjectIdentifier")
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "CertificateAuthority": {
; "Arn": "string",
; "CertificateAuthorityConfiguration": {
; "CsrExtensions": {
; "KeyUsage": {
; "CRLSign": boolean,
; "DataEncipherment": boolean,
; "DecipherOnly": boolean,
; "DigitalSignature": boolean,
; "EncipherOnly": boolean,
; "KeyAgreement": boolean,
; "KeyCertSign": boolean,
; "KeyEncipherment": boolean,
; "NonRepudiation": boolean
; },
; "SubjectInformationAccess": [
; {
; "AccessLocation": {
; "DirectoryName": {
; "CommonName": "string",
; "Country": "string",
; "DistinguishedNameQualifier": "string",
; "GenerationQualifier": "string",
; "GivenName": "string",
; "Initials": "string",
; "Locality": "string",
; "Organization": "string",
; "OrganizationalUnit": "string",
; "Pseudonym": "string",
; "SerialNumber": "string",
; "State": "string",
; "Surname": "string",
; "Title": "string"
; },
; "DnsName": "string",
; "EdiPartyName": {
; "NameAssigner": "string",
; "PartyName": "string"
; },
; "IpAddress": "string",
; "OtherName": {
; "TypeId": "string",
; "Value": "string"
; },
; "RegisteredId": "string",
; "Rfc822Name": "string",
; "UniformResourceIdentifier": "string"
; },
; "AccessMethod": {
; "AccessMethodType": "string",
; "CustomObjectIdentifier": "string"
; }
; }
; ]
; },
; "KeyAlgorithm": "string",
; "SigningAlgorithm": "string",
; "Subject": {
; "CommonName": "string",
; "Country": "string",
; "DistinguishedNameQualifier": "string",
; "GenerationQualifier": "string",
; "GivenName": "string",
; "Initials": "string",
; "Locality": "string",
; "Organization": "string",
; "OrganizationalUnit": "string",
; "Pseudonym": "string",
; "SerialNumber": "string",
; "State": "string",
; "Surname": "string",
; "Title": "string"
; }
; },
; "CreatedAt": number,
; "FailureReason": "string",
; "KeyStorageSecurityStandard": "string",
; "LastStateChangeAt": number,
; "NotAfter": number,
; "NotBefore": number,
; "OwnerAccount": "string",
; "RestorableUntil": number,
; "RevocationConfiguration": {
; "CrlConfiguration": {
; "CustomCname": "string",
; "Enabled": boolean,
; "ExpirationInDays": number,
; "S3BucketName": "string",
; "S3ObjectAcl": "string"
; },
; "OcspConfiguration": {
; "Enabled": boolean,
; "OcspCustomCname": "string"
; }
; },
; "Serial": "string",
; "Status": "string",
; "Type": "string"
; }
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
