EJBCA CA

Payload


Name	Description
kubeCaSettingName `String`	Unique name to identify the KUBE CA setting configuration.
clusterPolicy `String`	Cluster policy to which the cluster is associated to
caAccount `String`	Account associated with the CA.
certificateProfile `String`	Type of certificate. Possible Values: Server, Client
casettingType `String`	Type of the CA setting type. Possible Values: CA Setting, CA Setting Cluster
groupName `String`	Name of group where certificate might be pushed to after creation.
certificateAuthority `String`	Name of the Certificate Authority being configured. Possible Value: EJBCA
ejbcaEndEntityProfile `String`	EJBCA profile name based on the configurations in the CA policy.
ejbcaIssuerCommonName `String`	EJBCA common name based on the configurations in the CA policy.
ejbcaCertificateProfileName `String`	EJBCA certificate profile name based on the configurations in the CA policy.
connectorName `String`	Name of the connector used for integration with EJBCA.
ejbcaEndEntityUsername `String`	The username of the end entity in EJBCA, used during certificate enrollment.
certPolicyName `String`	The name of the certificate policy associated with the enrollment process.

Response Structure

Status Code: 200 OK
Message: SUCCESS
Headers:
- Content-Type: application/json


Name	Description
response `String`	Successfully added policy.
message `String`	Success message or failure description in case of error.
appStatusCode `String`	Application specific status code for the response. Will be non-null for failure response.
tags	More info in case of failure response.

Sample Request/Response

Use case: Create a cluster policy template for EJBCA CA.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/kube-issuer-ca-template-add?gwsource=external

Sample Request

POST Content type: application/json Username: <> Password: <>
{
    "payload": {
        "kubeCaSettingName": "ejbca-12",
        "clusterPolicy": "cluster-policy",
        "caAccount": "EJBCA_Crypto_Mesh_CA",
        "certificateProfile": "Server",
        "casettingType": "CA Setting Cluster",
        "groupName": "Default",
        "certificateAuthority": "Ejbca",
        "ejbcaEndEntityProfile": "SMIME",
        "ejbcaIssuerCommonName": "AppViewX EJBCA Issuing CA",
        "ejbcaCertificateProfileName": "SMIME",
        "connectorName": "connectorname",
        "ejbcaEndEntityUsername": "End entity user name",
        "certPolicyName": "Default"
    }
}

Sample Response

{
    "response": {
        "messageType": "SUCCESS",
        "message": "Successfully added issuer ca template"
    },
    "message": "Successfully added issuer ca template",
    "appStatusCode": "success",
    "tags": null,
    "headers": null
}

Reference

Understanding the sample URL:

IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
- IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication
  The IP address will be included in the endpoint URL for an on-prem deployment.
- HostName: A human-readable label assigned to a device (host) on a network
  The hostname will be included in the endpoint URL for an on-prem deployment.
- TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify
  The tenant name will be included in the endpoint URL for a SaaS deployment.
GWPORT: AppViewX gateway port
A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.
Example: 31443
avxapi: Path parameter value (static) that is part of the endpoint's URL
Endpoint: Endpoint of the API, for example: execute-hook
gwsource: Source or origin of a gateway, for example: external.