View a Certificate Group

Before you Begin

The user should have the required ACF permissions to view the certificate group.

Request Structure


Endpoint:	/certificate/group
Type:	GET
Action:	certificate-group-view
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/certificate/group?groupName=<groupName>&gwsource=external` To understand the elements of the sample URL, click here.
Headers
Content-Type:	application/json

Table 1. Input Parameters
Name	Description
sessionId `Header`	(Mandatory) Session Id received after login. Type: String Constraint: Required if username and password are not provided.
username `Header`	(Mandatory) AppViewX login username. Type: String Constraint: Required if sessionId is not provided.
password `Header`	(Mandatory) AppViewX login password. Type: String Constraint: Required if sessionId is not provided.
Content-Type `Header`	(Mandatory) Specifies the nature of the data in the payload. Type: String Constraint: Value of the parameter should be ‘application/json’
groupName `Header`	(Mandatory) Name of the certificate group whose details have to be retrieved
gwsource `Query`	(Mandatory) Source from which the request is triggered. (E.g. external) Type: String

Response Structure

Response returns string of type application/json with the following body parameters:

Table 2. Parameters
Name	Description
response	Contains the response attributes Type: response
message	Success message or failure description in case of error. Type: String
appStatusCode	Application specific status code for the response. It is a non-null value for a failure response. Type: String
tags	Additional information in case of failure response.

Table 3. response
Name	Description
name	Name of the group who details have been retrieved Type: String
displayName	Display name configured for the group Type: String
description	Description of the certificate group Type: String
applicationID	Organization ID associated with the group Type: String
policyName	Certificate policy associated with the group Type: String
groupBusinessInfo	Details of the business unit associated with the group Type: groupBusinessInfo
groupLevelCertConfig	Configuration details for the certificates associated with this group Type: groupLevelCertConfig

Table 4. groupBusinessInfo
Name	Description
contactName	Contact of the associated business unit's contact person
firstName	First name of the associated business unit's contact person
lastName	Last name of the associated business unit's contact person
phoneNumber	Phone number of the associated business unit's contact person
lobName	Name of the business unit associated with the certificate group
costCenter	Code/label of the cost center associated with the certificate group
environmentName	Business unit environment associated with the certificate group
inventoryNumber	Inventory tracking number for the certificate group
email	Email address of the associated business unit's contact person

Table 5. groupLevelCertConfig
Name	Description
autoPushFlag	Indicates whether certificates assigned to this group will be automatically pushed to the target endpoint upon renewal/regeneration
groupOverrideFlag	Indicates if the group level settings for auto renewal/regeneration will override the certificate level settings
connectorStatusToSkip	Indicates if application connector cloning (after certificate renewal, regeneration, and resissue) is enabled
autoRenewConfig	Indicates the auto renewal-related configuration details for this certificate group Type: autoRenewConfig
autoRegenerateConfig	Indicates the auto regeneration-related configuration details for this certificate group Type: autoRegenerateConfig
parentGroup	Name of the parent certificate group under which the new certificate group is created
deleteRestricted	Indicates if this certificate group can be deleted
_id	Unique identifier assigned to the certificate group

Table 6. autoRenewConfig
Name	Description
renewBefore	For the certificates associated with this group, indicates how many days prior to a certificate's expiry the renewal process will start
autoRenewalFlag	Indicates if auto renewal is enabled for the certificates associated with this group
approvalRequiredFlag	Indicates if approval is required before certificate renewal is triggered

Table 7. autoRegenerateConfig
Name	Description
regenerateBefore	For the certificates associated with this group, indicates how many days prior to a certificate's expiry the regeneration process will start
autoRegenerateFlag	Indicates if auto regeneration is enabled for the certificates associated with this group
approvalRequiredFlag	Indicates if approval is required before certificate regeneration is triggered

Status codes


HTTP Code	appStatusCode	Response Message
202 Accepted	null	Deletion action has been triggered successfully
401 Unauthorized	AVX_GW_003	Authentication failed, reason - Invalid Credentials. Remediation: Ensure that valid username and password or a valid sessionId is provided as header parameters.
404 Not Found	NO_RECORDS_FOUND	No matching records found. Remediation: Check and ensure that the values provided for commonName / serialNumber / resourceId are correct.
400 Bad Request	INVALID_REQUEST	Please give valid common name and serial number or resourceId. Remediation: Provide a valid commonName and serialNumber or resourceId.
400 Bad Request	INVALID_REQUEST	Please provide a valid action. Remediation: Provide a valid action.
400 Bad Request	MANDATORY_FIELD_MISSING	Mandatory field is missing or invalid - action. Remediation: Ensure that the action field is available in the request payload.
404 Not Found	CERT-GRP-0003	Group information not available Remediation: Ensure that the group information provided in the request is correct. If the issue still persists, contact AppViewX support.
500 Internal server error	CERT-GRP-0005	Error occurred while fetching the certificate group. Remediation: Contact AppViewX support.

Sample Request/Response

Sample Request

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/certificate/group?groupName=MasterGroup1&gwsource=external

Sample Response

{
   "response": [
       "Private_CA_Certificates",
       "Public_CA_Certificates",
       "MasterGroup",
       "Certificate-Gateway",
       "Default",
       "MasterGroup11",
       "MasterGroup10"
   ],
   "message": "7 record(s) found",
   "appStatusCode": null,
   "tags": {},
   "headers": null
}

References

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.