Jobs Account Audit

PreviousConfiguration Trigger NextManage Vulnerabilities

get

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

GET /ux/nccm/jobs-account-audit/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "creationtime": "text",
  "agent_id": "text",
  "connection_status": "text",
  "failure_message": "text",
  "organization": "text",
  "job_id": "text",
  "ci_id": "text",
  "job_iteration_id": "text",
  "ipaddress": "text",
  "device_account": "text",
  "dpassword": "text",
  "denable_password": "text",
  "connection_protocol": "text",
  "error": "text",
  "task_owner": "text",
  "client_ip": "text",
  "job_type": "text",
  "job_name": "text",
  "process_name": "text",
  "connection_for": "text",
  "last_update_time": "2025-06-07T14:54:24.264Z",
  "config_type": "text",
  "uofw": "text"
}

delete

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

delete

DELETE /ux/nccm/jobs-account-audit/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

Get the options for the jobs Account Audit

get

This endpoint is used to get the default options for jobs Account Audit

Authorizations

Responses

200Success

application/json

get

GET /ux/nccm/jobs-account-audit/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "creationtime": "text",
  "agent_id": "text",
  "connection_status": "text",
  "failure_message": "text",
  "organization": "text",
  "job_id": "text",
  "ci_id": "text",
  "job_iteration_id": "text",
  "ipaddress": "text",
  "device_account": "text",
  "dpassword": "text",
  "denable_password": "text",
  "connection_protocol": "text",
  "error": "text",
  "task_owner": "text",
  "client_ip": "text",
  "job_type": "text",
  "job_name": "text",
  "process_name": "text",
  "connection_for": "text",
  "last_update_time": "2025-06-07T14:54:24.264Z",
  "config_type": "text",
  "uofw": "text"
}

Gets a list of aaa_audit list

get

This endpoint is used to fetch all the aaa_audit data in the current organization

Authorizations

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

get

GET /ux/nccm/jobs-account-audit/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "creationtime": "text",
    "agent_id": "text",
    "connection_status": "text",
    "failure_message": "text",
    "organization": "text",
    "job_id": "text",
    "ci_id": "text",
    "job_iteration_id": "text",
    "ipaddress": "text",
    "device_account": "text",
    "dpassword": "text",
    "denable_password": "text",
    "connection_protocol": "text",
    "error": "text",
    "task_owner": "text",
    "client_ip": "text",
    "job_type": "text",
    "job_name": "text",
    "process_name": "text",
    "connection_for": "text",
    "last_update_time": "2025-06-07T14:54:24.264Z",
    "config_type": "text",
    "uofw": "text"
  }
]

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

creationtimestringRead-onlyRequired

agent_idstringRead-onlyRequired

connection_statusstringRead-onlyRequired

failure_messagestringRead-onlyRequired

organizationstring · max: 25Required

job_idstringOptional

ci_idstringOptional

job_iteration_idstringOptional

ipaddressstring · max: 225Optional

device_accountstring · max: 225Optional

dpasswordstring · max: 225Optional

denable_passwordstring · max: 225Optional

connection_protocolstring · max: 25Optional

errorstring · max: 2000Optional

task_ownerstring · max: 225Optional

client_ipstring · max: 225Optional

job_typestring · max: 225Optional

job_namestring · max: 225Optional

process_namestring · max: 225Optional

connection_forstring · max: 225Optional

last_update_timestring · date-timeOptional

config_typestring · max: 225Optional

uofwstring · max: 225Optional

Responses

201Success

application/json

post

POST /ux/nccm/jobs-account-audit/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 414

{
  "organization": "text",
  "job_id": "text",
  "ci_id": "text",
  "job_iteration_id": "text",
  "ipaddress": "text",
  "device_account": "text",
  "dpassword": "text",
  "denable_password": "text",
  "connection_protocol": "text",
  "error": "text",
  "task_owner": "text",
  "client_ip": "text",
  "job_type": "text",
  "job_name": "text",
  "process_name": "text",
  "connection_for": "text",
  "last_update_time": "2025-06-07T14:54:24.264Z",
  "config_type": "text",
  "uofw": "text"
}

201Success

{
  "id": "text",
  "creationtime": "text",
  "agent_id": "text",
  "connection_status": "text",
  "failure_message": "text",
  "organization": "text",
  "job_id": "text",
  "ci_id": "text",
  "job_iteration_id": "text",
  "ipaddress": "text",
  "device_account": "text",
  "dpassword": "text",
  "denable_password": "text",
  "connection_protocol": "text",
  "error": "text",
  "task_owner": "text",
  "client_ip": "text",
  "job_type": "text",
  "job_name": "text",
  "process_name": "text",
  "connection_for": "text",
  "last_update_time": "2025-06-07T14:54:24.264Z",
  "config_type": "text",
  "uofw": "text"
}

put

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

creationtimestringRead-onlyRequired

agent_idstringRead-onlyRequired

connection_statusstringRead-onlyRequired

failure_messagestringRead-onlyRequired

organizationstring · max: 25Required

job_idstringOptional

ci_idstringOptional

job_iteration_idstringOptional

ipaddressstring · max: 225Optional

device_accountstring · max: 225Optional

dpasswordstring · max: 225Optional

denable_passwordstring · max: 225Optional

connection_protocolstring · max: 25Optional

errorstring · max: 2000Optional

task_ownerstring · max: 225Optional

client_ipstring · max: 225Optional

job_typestring · max: 225Optional

job_namestring · max: 225Optional

process_namestring · max: 225Optional

connection_forstring · max: 225Optional

last_update_timestring · date-timeOptional

config_typestring · max: 225Optional

uofwstring · max: 225Optional

Responses

200Success

application/json

put

PUT /ux/nccm/jobs-account-audit/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 414

{
  "organization": "text",
  "job_id": "text",
  "ci_id": "text",
  "job_iteration_id": "text",
  "ipaddress": "text",
  "device_account": "text",
  "dpassword": "text",
  "denable_password": "text",
  "connection_protocol": "text",
  "error": "text",
  "task_owner": "text",
  "client_ip": "text",
  "job_type": "text",
  "job_name": "text",
  "process_name": "text",
  "connection_for": "text",
  "last_update_time": "2025-06-07T14:54:24.264Z",
  "config_type": "text",
  "uofw": "text"
}

200Success

{
  "id": "text",
  "creationtime": "text",
  "agent_id": "text",
  "connection_status": "text",
  "failure_message": "text",
  "organization": "text",
  "job_id": "text",
  "ci_id": "text",
  "job_iteration_id": "text",
  "ipaddress": "text",
  "device_account": "text",
  "dpassword": "text",
  "denable_password": "text",
  "connection_protocol": "text",
  "error": "text",
  "task_owner": "text",
  "client_ip": "text",
  "job_type": "text",
  "job_name": "text",
  "process_name": "text",
  "connection_for": "text",
  "last_update_time": "2025-06-07T14:54:24.264Z",
  "config_type": "text",
  "uofw": "text"
}