Chilkat Tools

DescribeCertificateAuthority Ruby Example

AWS Private CA

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("acm-pca")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)

# URL: https://acm-pca.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("acm-pca.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

# 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 = Chilkat::CkJsonObject.new()
json.UpdateString("CertificateAuthorityArn","string")

# The JSON request body created by the above code:

# {
#   "CertificateAuthorityArn": "string"
# }

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/",sbRequestBody,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

Arn = jResp.stringOf("CertificateAuthority.Arn")
CRLSign = jResp.IntOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.CRLSign")
DataEncipherment = jResp.IntOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.DataEncipherment")
DecipherOnly = jResp.IntOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.DecipherOnly")
DigitalSignature = jResp.IntOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.DigitalSignature")
EncipherOnly = jResp.IntOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.EncipherOnly")
KeyAgreement = jResp.IntOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.KeyAgreement")
KeyCertSign = jResp.IntOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.KeyCertSign")
KeyEncipherment = jResp.IntOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.KeyEncipherment")
NonRepudiation = jResp.IntOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.KeyUsage.NonRepudiation")
KeyAlgorithm = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.KeyAlgorithm")
SigningAlgorithm = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.SigningAlgorithm")
CommonName = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.Subject.CommonName")
Country = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.Subject.Country")
DistinguishedNameQualifier = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.Subject.DistinguishedNameQualifier")
GenerationQualifier = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.Subject.GenerationQualifier")
GivenName = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.Subject.GivenName")
Initials = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.Subject.Initials")
Locality = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.Subject.Locality")
Organization = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.Subject.Organization")
OrganizationalUnit = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.Subject.OrganizationalUnit")
Pseudonym = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.Subject.Pseudonym")
SerialNumber = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.Subject.SerialNumber")
State = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.Subject.State")
Surname = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.Subject.Surname")
Title = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.Subject.Title")
CreatedAt = jResp.IntOf("CertificateAuthority.CreatedAt")
FailureReason = jResp.stringOf("CertificateAuthority.FailureReason")
KeyStorageSecurityStandard = jResp.stringOf("CertificateAuthority.KeyStorageSecurityStandard")
LastStateChangeAt = jResp.IntOf("CertificateAuthority.LastStateChangeAt")
NotAfter = jResp.IntOf("CertificateAuthority.NotAfter")
NotBefore = jResp.IntOf("CertificateAuthority.NotBefore")
OwnerAccount = jResp.stringOf("CertificateAuthority.OwnerAccount")
RestorableUntil = jResp.IntOf("CertificateAuthority.RestorableUntil")
CustomCname = jResp.stringOf("CertificateAuthority.RevocationConfiguration.CrlConfiguration.CustomCname")
Enabled = jResp.IntOf("CertificateAuthority.RevocationConfiguration.CrlConfiguration.Enabled")
ExpirationInDays = jResp.IntOf("CertificateAuthority.RevocationConfiguration.CrlConfiguration.ExpirationInDays")
S3BucketName = jResp.stringOf("CertificateAuthority.RevocationConfiguration.CrlConfiguration.S3BucketName")
S3ObjectAcl = jResp.stringOf("CertificateAuthority.RevocationConfiguration.CrlConfiguration.S3ObjectAcl")
OcspConfigurationEnabled = jResp.IntOf("CertificateAuthority.RevocationConfiguration.OcspConfiguration.Enabled")
OcspCustomCname = jResp.stringOf("CertificateAuthority.RevocationConfiguration.OcspConfiguration.OcspCustomCname")
Serial = jResp.stringOf("CertificateAuthority.Serial")
Status = jResp.stringOf("CertificateAuthority.Status")
v_Type = jResp.stringOf("CertificateAuthority.Type")
i = 0
count_i = jResp.SizeOfArray("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess")
while i < count_i
    jResp.put_I(i)
    DirectoryNameCommonName = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.CommonName")
    DirectoryNameCountry = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Country")
    DirectoryNameDistinguishedNameQualifier = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.DistinguishedNameQualifier")
    DirectoryNameGenerationQualifier = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.GenerationQualifier")
    DirectoryNameGivenName = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.GivenName")
    DirectoryNameInitials = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Initials")
    DirectoryNameLocality = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Locality")
    DirectoryNameOrganization = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Organization")
    DirectoryNameOrganizationalUnit = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.OrganizationalUnit")
    DirectoryNamePseudonym = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Pseudonym")
    DirectoryNameSerialNumber = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.SerialNumber")
    DirectoryNameState = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.State")
    DirectoryNameSurname = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Surname")
    DirectoryNameTitle = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DirectoryName.Title")
    DnsName = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.DnsName")
    NameAssigner = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.EdiPartyName.NameAssigner")
    PartyName = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.EdiPartyName.PartyName")
    IpAddress = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.IpAddress")
    TypeId = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.OtherName.TypeId")
    Value = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.OtherName.Value")
    RegisteredId = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.RegisteredId")
    Rfc822Name = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.Rfc822Name")
    UniformResourceIdentifier = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessLocation.UniformResourceIdentifier")
    AccessMethodType = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessMethod.AccessMethodType")
    CustomObjectIdentifier = jResp.stringOf("CertificateAuthority.CertificateAuthorityConfiguration.CsrExtensions.SubjectInformationAccess[i].AccessMethod.CustomObjectIdentifier")
    i = i + 1
end

# 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"
#   }
# }
Chilkat Online Tools

DescribeCertificateAuthority Ruby Example

AWS Private CA
