Get Certificate Attributes

The API will fetch all the certificate attributes.

Request Structure

URL: /certificate/attribute

Type: GET

Table 1. Parameter
Name	Param Type	Description	Field Type	Constraints
`sessionId`	Header	Session Id received after login.	`String`	Required if `username` and `password` are not provided.
`username`	Header	AppViewX login username.	`String`	Required if `sessionId` is not provided.
`password`	Header	AppViewX login password.	`String`	Required if `sessionId` is not provided.
`Content-Type`	Header	Specifies the nature of the data in the payload.	`String`	Value of the param should be ‘`application/json`’.
`gwkey`	Query	Tenant Key. This is needed only in case of multi tenant installations and can be ignored in other type of installations.	`String`	NA
`gwsource`	Query	Source from which the request is triggered (E.g. external)	`String`	NA

Response Structure

202 Accepted returns string of type application/json with the following body params.

Table 2. Parameters
Name	Description	Field Type
`response`	Contains the response attributes.	`response`
`message`	Success message or failure description in case of error.	`String`
`appStatusCode`	Application specific status code for the response. Will be non-null for failure response.	`String`
`tags`	More info in case of failure response.	NA

Table 3. response
Name	Description	Field Type
	List of certificate attributes.	`Array of CertificateGenericField`

Status Codes

Table 4. Status Codes and Description
HTTP Status code	appStatusCode	Message	Possible remediation
202 Accepted	NA	Certificate attributes fetched successfully or No certificate attributes available.	NA
401 Unauthorized	AVX_GW_003	Authentication failed, reason - Invalid Credentials.	Ensure that valid `username` and `password` or valid `sessionId` is provided as header param.

Sample Request/Response

Sample Request

No payload for GET request

Sample Response

 {
 "response": [
 {
 "id": "approvercustomAttributecustomAttribute",
 "type": "text",
 "value": "cert approver",
 "values": null,
 "label": "approver",
 "searchKey": "approver",
 "errorCode": null,
 "mandatory": true,
 "validation": null,
 "divClasses": null,
 "classNames": null,
 "category": "certAttributes",
 "certificateAuthority": null,
 "regexValue": null,
 "helpInfo": null,
 "name": "approver",
 "mandatoryFor": null,
 "_id": "approver"
 }
 ],
 "message": "Certificate attributes fetched successfully",
 "appStatusCode": null,
 "tags": {},
 "headers": null
 }