This is the API-Cloud-Full section of the Aembit Documentation documentation, as Markdown. # Aembit Cloud API - Full Reference > Complete API reference including endpoints and schemas for Aembit Cloud API # Aembit Cloud API **Version:** v1 ## Base URL https\://{tenant}.aembit.io *** # Aembit Cloud API - API Endpoints **Version:** v1 **Base URL:** https\://{tenant}.aembit.io ## Access Condition ### GET /api/v1/access-conditions **Summary:** Get a page of Access Conditions **Description:** Retrieve a page of Aembit Access Conditions. **Operation ID:** get-access-conditions **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of Access Conditions * Content-Type: application/json * Schema: AccessConditionDTOAccessConditionListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/access-conditions?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### POST /api/v1/access-conditions **Summary:** Create an Access Condition **Description:** Create an Aembit Access Condition which can then be associated with an Access Policy. **Operation ID:** post-access-condition **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** AccessConditionDTO * Content-Type: application/json * Schema: AccessConditionDTO **Responses:** * **201**: Successfully created Access Condition * Content-Type: application/json * Schema: AccessConditionDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/access-conditions" ``` ### PUT /api/v1/access-conditions **Summary:** Update a single Access Condition **Description:** Update a specific Access Condition identified by its ID. **Operation ID:** put-access-condition **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** AccessConditionDTO * Content-Type: application/json * Schema: AccessConditionDTO **Responses:** * **200**: Successfully updated Access Condition * Content-Type: application/json * Schema: AccessConditionDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/access-conditions" ``` ### GET /api/v1/access-conditions/{id} **Summary:** Get the identified Access Condition **Description:** Get the Access Condition identified by its ID. **Operation ID:** get-access-condition **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Condition * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Access Condition * Content-Type: application/json * Schema: AccessConditionDTO * **204**: Access Condition Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/access-conditions/{id}" ``` ### DELETE /api/v1/access-conditions/{id} **Summary:** Delete a single Access Condition **Description:** Delete a specific Access Condition identified by its ID. **Operation ID:** delete-access-condition **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Condition * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **204**: Deleted the Access Condition * **400**: Bad Request * **401**: Not Authenticated * **404**: Not Found * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/access-conditions/{id}" ``` ### PATCH /api/v1/access-conditions/{id} **Summary:** Patch a single Access Condition **Description:** Patch a specific Access Condition identified by its ID. **Operation ID:** patch-access-condition **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Condition * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** AccessConditionPatchDTO * Content-Type: application/json * Schema: AccessConditionPatchDTO **Responses:** * **200**: Successfully updated Access Condition * Content-Type: application/json * Schema: AccessConditionDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/access-conditions/{id}" ``` ## Access Condition v2 ### GET /api/v2/access-conditions **Summary:** Get a page of Access Conditions **Description:** Retrieve a page of Aembit Access Conditions. **Operation ID:** get-access-conditions2 **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of Access Conditions * Content-Type: application/json * Schema: AccessConditionV2DTOAccessConditionListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v2/access-conditions?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### POST /api/v2/access-conditions **Summary:** Create an Access Condition **Description:** Create an Aembit Access Condition which can then be associated with an Access Policy. **Operation ID:** post-access-condition2 **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** AccessConditionV2DTO * Content-Type: application/json * Schema: AccessConditionV2DTO | CrowdStrikeAccessConditionDTO | WizAccessConditionDTO | GeoIPAccessConditionDTO | TimeAccessConditionDTO **Responses:** * **201**: Successfully created Access Condition * Content-Type: application/json * Schema: AccessConditionV2DTO | CrowdStrikeAccessConditionDTO | WizAccessConditionDTO | GeoIPAccessConditionDTO | TimeAccessConditionDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/access-conditions" ``` ### PUT /api/v2/access-conditions **Summary:** Update a single Access Condition **Description:** Update a specific Access Condition identified by its ID. **Operation ID:** put-access-condition2 **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** AccessConditionDTO * Content-Type: application/json * Schema: AccessConditionV2DTO | CrowdStrikeAccessConditionDTO | WizAccessConditionDTO | GeoIPAccessConditionDTO | TimeAccessConditionDTO **Responses:** * **200**: Successfully updated Access Condition * Content-Type: application/json * Schema: AccessConditionV2DTO | CrowdStrikeAccessConditionDTO | WizAccessConditionDTO | GeoIPAccessConditionDTO | TimeAccessConditionDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/access-conditions" ``` ### GET /api/v2/access-conditions/{id} **Summary:** Get the identified Access Condition **Description:** Get the Access Condition identified by its ID. **Operation ID:** get-access-condition2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Condition * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Access Condition * Content-Type: application/json * Schema: AccessConditionV2DTO | CrowdStrikeAccessConditionDTO | WizAccessConditionDTO | GeoIPAccessConditionDTO | TimeAccessConditionDTO * **204**: Access Condition Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v2/access-conditions/{id}" ``` ### DELETE /api/v2/access-conditions/{id} **Summary:** Delete a single Access Condition **Description:** Delete a specific Access Condition identified by its ID. **Operation ID:** delete-access-condition2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Condition * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **204**: Deleted the Access Condition * **400**: Bad Request * **401**: Not Authenticated * **404**: Not Found * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v2/access-conditions/{id}" ``` ### PATCH /api/v2/access-conditions/{id} **Summary:** Patch a single Access Condition **Description:** Patch a specific Access Condition identified by its ID. **Operation ID:** patch-access-condition2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Condition * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** AccessConditionPatchDTO * Content-Type: application/json * Schema: AccessConditionPatchDTO **Responses:** * **200**: Successfully updated Access Condition * Content-Type: application/json * Schema: AccessConditionV2DTO | CrowdStrikeAccessConditionDTO | WizAccessConditionDTO | GeoIPAccessConditionDTO | TimeAccessConditionDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/access-conditions/{id}" ``` ## Access Policy (Deprecated) ### GET /api/v1/access-policies/{id} **Summary:** Get the identified Access Policy **Description:** Get the Access Policy identified by its ID. **Operation ID:** get-access-policy **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Policy * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Access Policy * Content-Type: application/json * Schema: PolicyExternalDTO * **204**: Access Policy Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/access-policies/{id}" ``` ### DELETE /api/v1/access-policies/{id} **Summary:** Delete an Access Policy **Description:** Delete an Access Policy. **Operation ID:** delete-access-policy **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Policy * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **204**: Deleted the Access Policy * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/access-policies/{id}" ``` ### PATCH /api/v1/access-policies/{id} **Summary:** Patch an Access Policy **Description:** Patch an Access Policy. **Operation ID:** patch-access-policy **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Policy * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** PolicyPatchDTO * Content-Type: application/json * Schema: PolicyPatchDTO **Responses:** * **200**: Patched Access Policy * Content-Type: application/json * Schema: PolicyDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/access-policies/{id}" ``` ### GET /api/v1/access-policies/getByWorkloadIds/{clientWorkloadId}/{serverWorkloadId} **Summary:** Get the identified Access Policy **Description:** Get the Access Policy identified by a Client and Server Workload. **Operation ID:** get-access-policy-by-workloads **Parameters:** * **clientWorkloadId** (path) *(required)*: string (uuid) - ID of Client Workload * **serverWorkloadId** (path) *(required)*: string (uuid) - ID of Server Workload * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Access Policy * Content-Type: application/json * Schema: PolicyExternalDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/access-policies/getByWorkloadIds/{clientWorkloadId}/{serverWorkloadId}" ``` ### GET /api/v1/access-policies **Summary:** Get a page of Access Policies **Description:** Retrieve a page of Access Policies. **Operation ID:** get-access-policies **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string - Filter returned access policies using either a string or a key:value combination * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of Access Policies * Content-Type: application/json * Schema: PolicyListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/access-policies?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### POST /api/v1/access-policies **Summary:** Create an Access Policy **Description:** Create an Access Policy. **Operation ID:** post-access-policy **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** PolicyDTO * Content-Type: application/json * Schema: PolicyDTO **Responses:** * **200**: Created Access Policy * Content-Type: application/json * Schema: PolicyDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/access-policies" ``` ### PUT /api/v1/access-policies **Summary:** Update an Access Policy **Description:** Update an Access Policy. **Operation ID:** put-access-policy **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** PolicyDTO * Content-Type: application/json * Schema: PolicyDTO **Responses:** * **200**: Updated Access Policy * Content-Type: application/json * Schema: PolicyDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/access-policies" ``` ### POST /api/v1/access-policies/{id}/notes **Summary:** Add a note to an Access Policy **Description:** Add a note to an Access Policy. **Operation ID:** post-access-policy-note **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Policy * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** PolicyNoteDTO * Content-Type: application/json * Schema: PolicyNoteDTO **Responses:** * **201**: Note added to an Access Policy * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/access-policies/{id}/notes" ``` ## Access Policy v2 ### GET /api/v2/access-policies/{id} **Summary:** Get the identified Access Policy **Description:** Get the Access Policy identified by its ID. **Operation ID:** get-access-policy-v2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Policy **Responses:** * **200**: Access Policy * Content-Type: application/json * Schema: GetPolicyDTO * **204**: Access Policy Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v2/access-policies/{id}" ``` ### DELETE /api/v2/access-policies/{id} **Summary:** Delete an Access Policy **Description:** Delete an Access Policy. **Operation ID:** delete-access-policy-v2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Policy **Responses:** * **204**: Deleted the Access Policy * **400**: Bad Request * **401**: Not Authenticated * **404**: Not Found * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io/api/v2/access-policies/{id}" ``` ### PATCH /api/v2/access-policies/{id} **Summary:** Patch an Access Policy **Description:** Patch an Access Policy. **Operation ID:** patch-access-policy-v2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Policy **Request Body:** PatchPolicyV2DTO * Content-Type: application/json * Schema: PatchPolicyV2DTO **Responses:** * **200**: Patched Access Policy * Content-Type: application/json * Schema: CreatePolicyDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/access-policies/{id}" ``` ### GET /api/v2/access-policies/getByWorkloadIds/{clientWorkloadId}/{serverWorkloadId} **Summary:** Get the identified Access Policy **Description:** Get the Access Policy identified by a Client and Server Workload. **Operation ID:** get-access-policy-by-workloads-v2 **Parameters:** * **clientWorkloadId** (path) *(required)*: string (uuid) - ID of Client Workload * **serverWorkloadId** (path) *(required)*: string (uuid) - ID of Server Workload **Responses:** * **200**: Access Policy * Content-Type: application/json * Schema: GetPolicyDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v2/access-policies/getByWorkloadIds/{clientWorkloadId}/{serverWorkloadId}" ``` ### GET /api/v2/access-policies **Summary:** Get a page of Access Policies **Description:** Retrieve a page of Access Policies. **Operation ID:** get-access-policies-v2 **Parameters:** * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string - Filter returned access policies using either a string or a key:value combination * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string * **query** (query) *(optional)*: string **Responses:** * **200**: Page of Access Policies * Content-Type: application/json * Schema: GetPolicyDTOListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v2/access-policies?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value&query=example-value" ``` ### POST /api/v2/access-policies **Summary:** Create an Access Policy **Description:** Create an Access Policy. **Operation ID:** post-access-policy-v2 **Request Body:** CreatePolicyDTO * Content-Type: application/json * Schema: CreatePolicyDTO **Responses:** * **200**: Created Access Policy * Content-Type: application/json * Schema: CreatePolicyDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/access-policies" ``` ### PUT /api/v2/access-policies **Summary:** Update an Access Policy **Description:** Update an Access Policy. **Operation ID:** put-access-policy-v2 **Request Body:** CreatePolicyDTO * Content-Type: application/json * Schema: CreatePolicyDTO **Responses:** * **200**: Updated Access Policy * Content-Type: application/json * Schema: CreatePolicyDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/access-policies" ``` ### POST /api/v2/access-policies/{id}/notes **Summary:** Add a note to an Access Policy **Description:** Add a note to an Access Policy. **Operation ID:** post-access-policy-note-v2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Policy **Request Body:** PolicyNoteDTO * Content-Type: application/json * Schema: PolicyNoteDTO **Responses:** * **201**: Note added to an Access Policy * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/access-policies/{id}/notes" ``` ### GET /api/v2/access-policies/{id}/notes **Summary:** Gets notes for an Access Policy **Description:** Retrieves note information for an Access Policy. **Operation ID:** get-access-policy-notes-v2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Policy **Responses:** * **200**: Page of Access Policy Notes * Content-Type: application/json * Schema: PolicyNoteDTOListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v2/access-policies/{id}/notes" ``` ### GET /api/v2/access-policies/{id}/credential-mappings **Summary:** Gets a credential mappings of Access Policy **Description:** Retrieves credential mappings of Access Policy. **Operation ID:** get-access-policy-credential-mappings-v2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Policy **Responses:** * **200**: Page of Credential Mappings * Content-Type: application/json * Schema: PolicyNoteDTOListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v2/access-policies/{id}/credential-mappings" ``` ## Agent Controller ### GET /api/v1/agent-controllers **Summary:** Get a page of Agent Controllers **Description:** Get a page of Agent Controllers. **Operation ID:** get-agent-controllers **Parameters:** * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string * **check-tls-type** (query) *(optional)*: boolean **Responses:** * **200**: Page of Agent Controllers * Content-Type: application/json * Schema: AgentControllerListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/agent-controllers?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value&check-tls-type=example-value" ``` ### POST /api/v1/agent-controllers **Summary:** Create an Agent Controller **Description:** Create an Agent Controller. **Operation ID:** post-agent-controller **Request Body:** AgentControllerDTO * Content-Type: application/json * Schema: AgentControllerDTO **Responses:** * **201**: Created Agent Controller * Content-Type: application/json * Schema: AgentControllerDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/agent-controllers" ``` ### PUT /api/v1/agent-controllers **Summary:** Update an Agent Controller **Description:** Update an Agent Controller. **Operation ID:** put-agent-controller **Request Body:** AgentControllerDTO * Content-Type: application/json * Schema: AgentControllerDTO **Responses:** * **200**: Updated Agent Controller * Content-Type: application/json * Schema: AgentControllerDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/agent-controllers" ``` ### GET /api/v1/agent-controllers/{id} **Summary:** Get an Agent Controller **Description:** Get an Agent Controller identified by its ID. **Operation ID:** get-agent-controller **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Agent Controller **Responses:** * **200**: Agent Controller * Content-Type: application/json * Schema: AgentControllerDTO * **204**: Agent Controller Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/agent-controllers/{id}" ``` ### PATCH /api/v1/agent-controllers/{id} **Summary:** Patch an Agent Controller **Description:** Patch an Agent Controller identified by its ID. **Operation ID:** patch-agent-controller **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Agent Controller **Request Body:** AgentControllerPatchDTO * Content-Type: application/json * Schema: AgentControllerPatchDTO **Responses:** * **200**: Patched Agent Controller * Content-Type: application/json * Schema: AgentControllerDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/agent-controllers/{id}" ``` ### DELETE /api/v1/agent-controllers/{id} **Summary:** Delete an Agent Controller **Description:** Delete an Agent Controller identified by its ID. **Operation ID:** delete-agent-controller **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Agent Controller **Responses:** * **201**: Successfully deleted Agent Controller * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io/api/v1/agent-controllers/{id}" ``` ### POST /api/v1/agent-controllers/{agentControllerExternalId}/device-code **Summary:** Generate a Device Code for an Agent Controller **Description:** Generate a Device Code for an Agent Controller. **Operation ID:** post-agent-controller-device-code **Parameters:** * **agentControllerExternalId** (path) *(required)*: string (uuid) - ID of Agent Controller **Responses:** * **201**: Agent Controller Device Code * Content-Type: application/json * Schema: AgentControllerDeviceCodeDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ "https://your-tenant.aembit.io/api/v1/agent-controllers/{agentControllerExternalId}/device-code" ``` ## Audit Log ### GET /api/v1/audit-logs **Summary:** Get a page of Audit Log events **Description:** Get a page of Audit Log events. **Operation ID:** get-audit-logs **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **order** (query) *(optional)*: string * **search** (query) *(optional)*: string * **span-last-minutes** (query) *(optional)*: integer (int64) * **span-last-days** (query) *(optional)*: integer (int32) * **start-date** (query) *(optional)*: string (date-time) * **end-date** (query) *(optional)*: string (date-time) * **category** (query) *(optional)*: string * **severity** (query) *(optional)*: string **Responses:** * **200**: Page of Audit Logs * Content-Type: application/json * Schema: AuditLogListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/audit-logs?page=example-value&per-page=example-value&order=example-value&search=example-value&span-last-minutes=example-value&span-last-days=example-value&start-date=example-value&end-date=example-value&category=example-value&severity=example-value" ``` ### GET /api/v1/audit-logs/{id} **Summary:** Get an Audit Log event **Description:** Get an Audit Log event identified by its ID. **Operation ID:** get-audit-log **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Audit Log * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Audit Log * Content-Type: application/json * Schema: AuditLogDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/audit-logs/{id}" ``` ## Access Authorization Event ### GET /api/v1/authorization-events **Summary:** Get a page of Access Authorization Events **Description:** Get a page of Access Authorization Events. **Operation ID:** get-access-authorization-events **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **order** (query) *(optional)*: string * **search** (query) *(optional)*: string * **span-last-minutes** (query) *(optional)*: integer (int64) * **span-last-hours** (query) *(optional)*: integer (int32) * **start-date** (query) *(optional)*: string (date-time) * **end-date** (query) *(optional)*: string (date-time) * **severity** (query) *(optional)*: string * **event-type** (query) *(optional)*: string **Responses:** * **200**: Page of Access Authorization Events * Content-Type: application/json * Schema: AuthorizationEventListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/authorization-events?page=example-value&per-page=example-value&order=example-value&search=example-value&span-last-minutes=example-value&span-last-hours=example-value&start-date=example-value&end-date=example-value&severity=example-value&event-type=example-value" ``` ### GET /api/v1/authorization-events/{id} **Summary:** Get an Access Authorization Event **Description:** Get an Access Authorization Event identified by its ID. **Operation ID:** get-access-authorization-event **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Access Authorization Event * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Access Authorization Event * Content-Type: application/json * Schema: AuthorizationEventDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/authorization-events/{id}" ``` ## Compliance ### GET /api/v1/compliance-settings **Summary:** Gets global compliance settings **Description:** Gets global compliance settings which control the rules for creating access policy and other entities **Operation ID:** get-compliance-settings **Responses:** * **200**: A list of compliance settings * Content-Type: application/json * Schema: Array * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/compliance-settings" ``` ### PUT /api/v1/compliance-settings **Summary:** Updates a global compliance setting **Description:** Updates a global compliance setting **Operation ID:** update-compliance-setting **Request Body:** SettingDTO * Content-Type: application/json * Schema: SettingDTO **Responses:** * **200**: Successfully updated a compliance setting * Content-Type: application/json * Schema: SettingDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/compliance-settings" ``` ## Content Security ### GET /api/v1/content-security/{id} **Summary:** Get a Content Security **Description:** Get a Content Security identified by its ID. **Operation ID:** get-content-security **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Content Security **Responses:** * **200**: Content Security * Content-Type: application/json * Schema: ContentSecurityDTO | CrowdStrikeAIDRContentSecurityDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/content-security/{id}" ``` ### DELETE /api/v1/content-security/{id} **Summary:** Delete a Content Security **Description:** Delete a Content Security identified by its ID. **Operation ID:** delete-content-security **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Content Security **Responses:** * **204**: Successfully deleted Content Security * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io/api/v1/content-security/{id}" ``` ### PATCH /api/v1/content-security/{id} **Summary:** Patch a Content Security **Description:** Patch a Content Security identified by its ID. **Operation ID:** patch-content-security **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Content Security **Request Body:** ContentSecurityPatchDTO * Content-Type: application/json * Schema: ContentSecurityPatchDTO **Responses:** * **200**: Patched Content Security * Content-Type: application/json * Schema: ContentSecurityDTO | CrowdStrikeAIDRContentSecurityDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/content-security/{id}" ``` ### GET /api/v1/content-security **Summary:** Get a page of Content Security **Description:** Get a page of Content Security. **Operation ID:** get-content-security-list **Parameters:** * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of Content Security * Content-Type: application/json * Schema: ContentSecurityDTOListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/content-security?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### POST /api/v1/content-security **Summary:** Create a Content Security **Description:** Create a Content Security. **Operation ID:** post-content-security **Request Body:** ContentSecurityDTO * Content-Type: application/json * Schema: ContentSecurityDTO | CrowdStrikeAIDRContentSecurityDTO **Responses:** * **201**: Created Content Security * Content-Type: application/json * Schema: ContentSecurityDTO | CrowdStrikeAIDRContentSecurityDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/content-security" ``` ### PUT /api/v1/content-security **Summary:** Update a Content Security **Description:** Update a Content Security. **Operation ID:** put-content-security **Request Body:** ContentSecurityDTO * Content-Type: application/json * Schema: ContentSecurityDTO | CrowdStrikeAIDRContentSecurityDTO **Responses:** * **200**: Updated Content Security * Content-Type: application/json * Schema: ContentSecurityDTO | CrowdStrikeAIDRContentSecurityDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/content-security" ``` ## Credential Provider (Deprecated) ### GET /api/v1/credential-providers/{id} **Summary:** Get a Credential Provider **Description:** Get a Credential Provider identified by its ID. **Operation ID:** get-credential-provider **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Credential Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Credential Provider * Content-Type: application/json * Schema: CredentialProviderUIDTO * **204**: Credential Provider Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/credential-providers/{id}" ``` ### DELETE /api/v1/credential-providers/{id} **Summary:** Delete a Credential Provider **Description:** Delete a Credential Provider identified by its ID. **Operation ID:** delete-credential-provider **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Credential Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **204**: Deleted Credential Provider * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/credential-providers/{id}" ``` ### PATCH /api/v1/credential-providers/{id} **Summary:** Patch a Credential Provider **Description:** Patch a Credential Provider. **Operation ID:** patch-credential-provider **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Credential Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** CredentialProviderPatchDTO * Content-Type: application/json * Schema: CredentialProviderPatchDTO **Responses:** * **201**: Patched Credential Provider * Content-Type: application/json * Schema: CredentialProviderUIDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/credential-providers/{id}" ``` ### GET /api/v1/credential-providers/{id}/authorize **Summary:** Get a Credential Provider Authorization URL **Description:** Get a Credential Provider Authorization URL identified by the Credential Provider ID. **Operation ID:** get-credential-provider-authorization **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Credential Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **302**: Redirects to the Credential Provider Authorization URL * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/credential-providers/{id}/authorize" ``` ### GET /api/v1/credential-providers **Summary:** Get a page of Credential Providers **Description:** Get a page of Credential Providers. **Operation ID:** get-credential-providers **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of Credential Providers * Content-Type: application/json * Schema: CredentialProviderUIDTOCredentialProviderListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/credential-providers?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### POST /api/v1/credential-providers **Summary:** Create a Credential Provider **Description:** Create a Credential Provider. **Operation ID:** post-credential-provider **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** CredentialProviderDTO * Content-Type: application/json * Schema: CredentialProviderDTO **Responses:** * **201**: Created Credential Provider * Content-Type: application/json * Schema: CredentialProviderUIDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/credential-providers" ``` ### PUT /api/v1/credential-providers **Summary:** Update a Credential Provider **Description:** Update a Credential Provider. **Operation ID:** put-credential-provider **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** CredentialProviderDTO * Content-Type: application/json * Schema: CredentialProviderDTO **Responses:** * **201**: Updated Credential Provider * Content-Type: application/json * Schema: CredentialProviderUIDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/credential-providers" ``` ### GET /api/v1/credential-providers/{id}/verification **Summary:** Verify the Credential Provider **Description:** Verify the Credential Provider will successfully return a credential. **Operation ID:** get-credential-provider-verification **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Credential Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Details on the verification of a Credential Provider * Content-Type: application/json * Schema: GenericResponseDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/credential-providers/{id}/verification" ``` ## Credential Provider Integration ### GET /api/v1/credential-integrations/{id} **Summary:** Get a Credential Provider Integration **Description:** Get a Credential Provider Integration identified by its ID. **Operation ID:** get-credential-provider-integration **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Credential Provider Integration **Responses:** * **200**: Credential Provider Integration * Content-Type: application/json * Schema: CredentialProviderIntegrationDTO | GitLabCredentialProviderIntegrationDTO | AwsIamRoleCpiDTO | AzureEntraFederationCredentialProviderIntegrationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/credential-integrations/{id}" ``` ### DELETE /api/v1/credential-integrations/{id} **Summary:** Delete a Credential Provider Integration **Description:** Delete a Credential Provider Integration identified by its ID. **Operation ID:** delete-credential-provider-integration **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Credential Provider Integration **Responses:** * **204**: Successfully deleted Credential Provider Integration * **400**: Bad Request * **401**: Not Authenticated * **404**: Not Found * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io/api/v1/credential-integrations/{id}" ``` ### PATCH /api/v1/credential-integrations/{id} **Summary:** Patch a Credential Provider Integration **Description:** Patch a Credential Provider Integration identified by its ID. **Operation ID:** patch-credential-provider-integration **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Credential Provider Integration **Request Body:** CredentialProviderIntegrationPatchDTO * Content-Type: application/json * Schema: CredentialProviderIntegrationPatchDTO **Responses:** * **200**: Patched Credential Provider Integration * Content-Type: application/json * Schema: CredentialProviderIntegrationDTO | GitLabCredentialProviderIntegrationDTO | AwsIamRoleCpiDTO | AzureEntraFederationCredentialProviderIntegrationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/credential-integrations/{id}" ``` ### GET /api/v1/credential-integrations **Summary:** Get a page of Credential Provider Integrations **Description:** Get a page of Credential Provider Integrations. **Operation ID:** get-credential-provider-integrations **Parameters:** * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of Credential Provider Integrations * Content-Type: application/json * Schema: ListCredentialProviderIntegrationDTOListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/credential-integrations?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### POST /api/v1/credential-integrations **Summary:** Create a Credential Provider Integration **Description:** Create a Credential Provider Integration. **Operation ID:** post-credential-provider-integration **Request Body:** CredentialProviderIntegrationDTO * Content-Type: application/json * Schema: CredentialProviderIntegrationDTO | GitLabCredentialProviderIntegrationDTO | AwsIamRoleCpiDTO | AzureEntraFederationCredentialProviderIntegrationDTO **Responses:** * **201**: Created Credential Provider Integration * Content-Type: application/json * Schema: CredentialProviderIntegrationDTO | GitLabCredentialProviderIntegrationDTO | AwsIamRoleCpiDTO | AzureEntraFederationCredentialProviderIntegrationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/credential-integrations" ``` ### PUT /api/v1/credential-integrations **Summary:** Update a Credential Provider Integration **Description:** Update a Credential Provider Integration. **Operation ID:** put-credential-provider-integration **Request Body:** CredentialProviderIntegrationDTO * Content-Type: application/json * Schema: CredentialProviderIntegrationDTO | GitLabCredentialProviderIntegrationDTO | AwsIamRoleCpiDTO | AzureEntraFederationCredentialProviderIntegrationDTO **Responses:** * **200**: Updated Credential Provider Integration * Content-Type: application/json * Schema: CredentialProviderIntegrationDTO | GitLabCredentialProviderIntegrationDTO | AwsIamRoleCpiDTO | AzureEntraFederationCredentialProviderIntegrationDTO * **400**: Bad Request * **401**: Not Authenticated * **404**: Not Found * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/credential-integrations" ``` ### GET /api/v1/credential-integrations/list/{type} **Summary:** Get a list of Credential Provider Integrations by type **Description:** Get a list of Credential Provider Integrations by type. The most common usage is to populate a dropdown or selection list in the UI. **Operation ID:** get-credential-provider-integration-list **Parameters:** * **type** (path) *(required)*: CredentialProviderIntegrationType - Type of Credential Provider Integration **Responses:** * **200**: List of Credential Provider Integrations * Content-Type: application/json * Schema: Array * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/credential-integrations/list/{type}" ``` ## Credential Provider v2 ### POST /api/v2/credential-providers **Summary:** Create a Credential Provider **Description:** Create a Credential Provider. **Operation ID:** post-credential-provider2 **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** CredentialProviderV2DTO * Content-Type: application/json * Schema: CredentialProviderV2DTO | CPTypeAembitAccessTokenV2DTO | CPTypeApiKeyUIV2DTO | CPAwsStsV2DTO | CPTypeAzureEntraFederationV2DTO | CPTypeAzureKeyVaultValueDTO | CPTypeClaudeWifV2DTO | CPTypeGoogleWorkflowIDFederationV2DTO | CPGitLabManagedAccountDTO | CPTypeOAuth2AuthorizationCodeUIV2DTO | CPTypeOAuth2ClientCredentialsUIV2DTO | CPTypeOpenAiWifV2DTO | CPTypeJWTTokenV2DTO | CPTypeUsernamePasswordUIV2DTO | CPTypeVaultClientTokenV2DTO **Responses:** * **201**: Created Credential Provider * Content-Type: application/json * Schema: CredentialProviderV2DTO | CPTypeAembitAccessTokenV2DTO | CPTypeApiKeyUIV2DTO | CPAwsStsV2DTO | CPTypeAzureEntraFederationV2DTO | CPTypeAzureKeyVaultValueDTO | CPTypeClaudeWifV2DTO | CPTypeGoogleWorkflowIDFederationV2DTO | CPGitLabManagedAccountDTO | CPTypeOAuth2AuthorizationCodeUIV2DTO | CPTypeOAuth2ClientCredentialsUIV2DTO | CPTypeOpenAiWifV2DTO | CPTypeJWTTokenV2DTO | CPTypeUsernamePasswordUIV2DTO | CPTypeVaultClientTokenV2DTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/credential-providers" ``` ### PUT /api/v2/credential-providers **Summary:** Update a Credential Provider **Description:** Update a Credential Provider. **Operation ID:** put-credential-provider2 **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** CredentialProviderV2DTO * Content-Type: application/json * Schema: CredentialProviderV2DTO | CPTypeAembitAccessTokenV2DTO | CPTypeApiKeyUIV2DTO | CPAwsStsV2DTO | CPTypeAzureEntraFederationV2DTO | CPTypeAzureKeyVaultValueDTO | CPTypeClaudeWifV2DTO | CPTypeGoogleWorkflowIDFederationV2DTO | CPGitLabManagedAccountDTO | CPTypeOAuth2AuthorizationCodeUIV2DTO | CPTypeOAuth2ClientCredentialsUIV2DTO | CPTypeOpenAiWifV2DTO | CPTypeJWTTokenV2DTO | CPTypeUsernamePasswordUIV2DTO | CPTypeVaultClientTokenV2DTO **Responses:** * **200**: Updated Credential Provider * Content-Type: application/json * Schema: CredentialProviderV2DTO | CPTypeAembitAccessTokenV2DTO | CPTypeApiKeyUIV2DTO | CPAwsStsV2DTO | CPTypeAzureEntraFederationV2DTO | CPTypeAzureKeyVaultValueDTO | CPTypeClaudeWifV2DTO | CPTypeGoogleWorkflowIDFederationV2DTO | CPGitLabManagedAccountDTO | CPTypeOAuth2AuthorizationCodeUIV2DTO | CPTypeOAuth2ClientCredentialsUIV2DTO | CPTypeOpenAiWifV2DTO | CPTypeJWTTokenV2DTO | CPTypeUsernamePasswordUIV2DTO | CPTypeVaultClientTokenV2DTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/credential-providers" ``` ### GET /api/v2/credential-providers **Summary:** Get a page of Credential Providers **Description:** Get a page of Credential Providers. **Operation ID:** get-credential-providers-v2 **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of Credential Providers * Content-Type: application/json * Schema: CredentialProviderV2DTOCredentialProviderListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v2/credential-providers?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### GET /api/v2/credential-providers/{id} **Summary:** Get a Credential Provider **Description:** Get a Credential Provider identified by its ID. **Operation ID:** get-credential-provider2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Credential Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Credential Provider * Content-Type: application/json * Schema: CredentialProviderV2DTO | CPTypeAembitAccessTokenV2DTO | CPTypeApiKeyUIV2DTO | CPAwsStsV2DTO | CPTypeAzureEntraFederationV2DTO | CPTypeAzureKeyVaultValueDTO | CPTypeClaudeWifV2DTO | CPTypeGoogleWorkflowIDFederationV2DTO | CPGitLabManagedAccountDTO | CPTypeOAuth2AuthorizationCodeUIV2DTO | CPTypeOAuth2ClientCredentialsUIV2DTO | CPTypeOpenAiWifV2DTO | CPTypeJWTTokenV2DTO | CPTypeUsernamePasswordUIV2DTO | CPTypeVaultClientTokenV2DTO * **204**: Credential Provider Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v2/credential-providers/{id}" ``` ### DELETE /api/v2/credential-providers/{id} **Summary:** Delete a Credential Provider **Description:** Delete a Credential Provider identified by its ID. **Operation ID:** delete-credential-provider2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Credential Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **204**: Deleted Credential Provider * **400**: Bad Request * **401**: Not Authenticated * **404**: Not Found * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v2/credential-providers/{id}" ``` ### PATCH /api/v2/credential-providers/{id} **Summary:** Patch a Credential Provider **Description:** Patch a Credential Provider. **Operation ID:** patch-credential-provider-v2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Credential Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** CredentialProviderPatchDTO * Content-Type: application/json * Schema: CredentialProviderPatchDTO **Responses:** * **200**: Patched Credential Provider * Content-Type: application/json * Schema: CredentialProviderV2DTO | CPTypeAembitAccessTokenV2DTO | CPTypeApiKeyUIV2DTO | CPAwsStsV2DTO | CPTypeAzureEntraFederationV2DTO | CPTypeAzureKeyVaultValueDTO | CPTypeClaudeWifV2DTO | CPTypeGoogleWorkflowIDFederationV2DTO | CPGitLabManagedAccountDTO | CPTypeOAuth2AuthorizationCodeUIV2DTO | CPTypeOAuth2ClientCredentialsUIV2DTO | CPTypeOpenAiWifV2DTO | CPTypeJWTTokenV2DTO | CPTypeUsernamePasswordUIV2DTO | CPTypeVaultClientTokenV2DTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/credential-providers/{id}" ``` ### GET /api/v2/credential-providers/{id}/verification **Summary:** Verify the Credential Provider **Description:** Verify the Credential Provider will successfully return a credential. **Operation ID:** get-credential-provider-verification-v2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Credential Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Details on the verification of a Credential Provider * Content-Type: application/json * Schema: GenericResponseDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v2/credential-providers/{id}/verification" ``` ### GET /api/v2/credential-providers/{id}/authorize **Summary:** Get a Credential Provider Authorization URL **Description:** Get a Credential Provider Authorization URL identified by the Credential Provider ID. **Operation ID:** get-credential-provider-authorization-v2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Credential Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **302**: Redirects to the Credential Provider Authorization URL * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v2/credential-providers/{id}/authorize" ``` ## DiscoveryIntegration ### GET /api/v1/discovery-integrations **Summary:** Get a page of Integrations **Description:** Get a page of Integrations. **Operation ID:** get-discovery-integrations **Parameters:** * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string **Responses:** * **200**: Page of Integrations * Content-Type: application/json * Schema: DiscoveryIntegrationListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/discovery-integrations?page=example-value&per-page=example-value&filter=example-value&order=example-value" ``` ### POST /api/v1/discovery-integrations **Summary:** Create an Integration **Description:** Create an Integration. **Operation ID:** post-discovery-integration **Request Body:** DiscoveryIntegrationDTO * Content-Type: application/json * Schema: DiscoveryIntegrationDTO **Responses:** * **201**: Created Integration * Content-Type: application/json * Schema: DiscoveryIntegrationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/discovery-integrations" ``` ### PUT /api/v1/discovery-integrations **Summary:** Update an Integration **Description:** Update an Integration. **Operation ID:** put-discovery-integration **Request Body:** DiscoveryIntegrationDTO * Content-Type: application/json * Schema: DiscoveryIntegrationDTO **Responses:** * **200**: Updated Integration * Content-Type: application/json * Schema: DiscoveryIntegrationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/discovery-integrations" ``` ### GET /api/v1/discovery-integrations/{id} **Summary:** Get an Integration **Description:** Get an Integration. **Operation ID:** get-discovery-integration **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Integration **Responses:** * **200**: Integration * Content-Type: application/json * Schema: DiscoveryIntegrationDTO * **204**: Integration Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/discovery-integrations/{id}" ``` ### DELETE /api/v1/discovery-integrations/{id} **Summary:** Delete an Integration **Description:** Delete an Integration as identified by its ID. **Operation ID:** delete-discovery-integration **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Integration **Responses:** * **200**: Successfully deleted Integration * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io/api/v1/discovery-integrations/{id}" ``` ### PATCH /api/v1/discovery-integrations/{id} **Summary:** Patch an Integration **Description:** Patch an Integration as identified by its ID. **Operation ID:** patch-discovery-integration **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Integration **Request Body:** DiscoveryIntegrationPatchDTO * Content-Type: application/json * Schema: DiscoveryIntegrationPatchDTO **Responses:** * **200**: Patched Integration * Content-Type: application/json * Schema: DiscoveryIntegrationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/discovery-integrations/{id}" ``` ## DiscoveryServerWorkloadDraft ### GET /api/alpha/server-workload-drafts/{id} **Parameters:** * **id** (path) *(required)*: string (uuid) **Responses:** * **200**: OK **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/alpha/server-workload-drafts/{id}" ``` ## Workload Event ### GET /api/v1/workload-events **Summary:** Get a page of Workload Events **Description:** Get a page of Workload Events. **Operation ID:** get-workload-events **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **order** (query) *(optional)*: string * **search** (query) *(optional)*: string * **span-last-minutes** (query) *(optional)*: integer (int32) * **span-last-hours** (query) *(optional)*: integer (int32) * **start-date** (query) *(optional)*: string (date-time) * **end-date** (query) *(optional)*: string (date-time) * **application-protocol** (query) *(optional)*: string * **severity** (query) *(optional)*: string * **source-workload** (query) *(optional)*: Array\ * **target-workload** (query) *(optional)*: Array\ * **user-id** (query) *(optional)*: string **Responses:** * **200**: Page of Workload Events * Content-Type: application/json * Schema: EventListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/workload-events?page=example-value&per-page=example-value&order=example-value&search=example-value&span-last-minutes=example-value&span-last-hours=example-value&start-date=example-value&end-date=example-value&application-protocol=example-value&severity=example-value&source-workload=example-value&target-workload=example-value&user-id=example-value" ``` ### GET /api/v1/workload-events/{id} **Summary:** Get a Workload Event **Description:** Get a Workload Event. **Operation ID:** get-workload-event **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Workload Event * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Workload Event * Content-Type: application/json * Schema: EventDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/workload-events/{id}" ``` ## Health ### GET /api/v1/health **Summary:** Aembit Cloud API Health **Description:** Get the health of the Aembit Cloud API. **Operation ID:** get-health **Responses:** * **200**: API Health * Content-Type: application/json * Schema: HealthDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/health" ``` ## Integration ### GET /api/v1/integrations **Summary:** Get a page of Integrations **Description:** Get a page of Integrations. **Operation ID:** get-integrations **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string **Responses:** * **200**: Page of Integrations * Content-Type: application/json * Schema: IntegrationDTOIntegrationListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/integrations?page=example-value&per-page=example-value&filter=example-value&order=example-value" ``` ### POST /api/v1/integrations **Summary:** Create an Integration **Description:** Create an Integration. **Operation ID:** post-integration **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** IntegrationDTO * Content-Type: application/json * Schema: IntegrationDTO **Responses:** * **201**: Created Integration * Content-Type: application/json * Schema: IntegrationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/integrations" ``` ### PUT /api/v1/integrations **Summary:** Update an Integration **Description:** Update an Integration. **Operation ID:** put-integration **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** IntegrationDTO * Content-Type: application/json * Schema: IntegrationDTO **Responses:** * **200**: Updated Integration * Content-Type: application/json * Schema: IntegrationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/integrations" ``` ### GET /api/v1/integrations/{id} **Summary:** Get an Integration **Description:** Get an Integration. **Operation ID:** get-integration **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Integration * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Integration * Content-Type: application/json * Schema: IntegrationDTO * **204**: Integration Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/integrations/{id}" ``` ### DELETE /api/v1/integrations/{id} **Summary:** Delete an Integration **Description:** Delete an Integration as identified by its ID. **Operation ID:** delete-integration **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Integration * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Successfully deleted Integration * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/integrations/{id}" ``` ### PATCH /api/v1/integrations/{id} **Summary:** Patch an Integration **Description:** Patch an Integration as identified by its ID. **Operation ID:** patch-integration **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Integration * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** IntegrationPatchDTO * Content-Type: application/json * Schema: IntegrationPatchDTO **Responses:** * **200**: Patched Integration * Content-Type: application/json * Schema: IntegrationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/integrations/{id}" ``` ## Integration v2 ### GET /api/v2/integrations **Summary:** Get a page of Integrations **Description:** Get a page of Integrations. **Operation ID:** get-integrations2 **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string **Responses:** * **200**: Page of Integrations * Content-Type: application/json * Schema: IntegrationV2DTOIntegrationListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v2/integrations?page=example-value&per-page=example-value&filter=example-value&order=example-value" ``` ### POST /api/v2/integrations **Summary:** Create an Integration **Description:** Create an Integration. **Operation ID:** post-integration2 **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** IntegrationV2DTO * Content-Type: application/json * Schema: IntegrationV2DTO | CrowdStrikeIntegrationDTO | WizIntegrationDTO | GeoIPIntegrationDTO | TimeIntegrationDTO **Responses:** * **201**: Created Integration * Content-Type: application/json * Schema: IntegrationV2DTO | CrowdStrikeIntegrationDTO | WizIntegrationDTO | GeoIPIntegrationDTO | TimeIntegrationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/integrations" ``` ### PUT /api/v2/integrations **Summary:** Update an Integration **Description:** Update an Integration. **Operation ID:** put-integration2 **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** IntegrationV2DTO * Content-Type: application/json * Schema: IntegrationV2DTO | CrowdStrikeIntegrationDTO | WizIntegrationDTO | GeoIPIntegrationDTO | TimeIntegrationDTO **Responses:** * **200**: Updated Integration * Content-Type: application/json * Schema: IntegrationV2DTO | CrowdStrikeIntegrationDTO | WizIntegrationDTO | GeoIPIntegrationDTO | TimeIntegrationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/integrations" ``` ### GET /api/v2/integrations/{id} **Summary:** Get an Integration **Description:** Get an Integration. **Operation ID:** get-integration2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Integration * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Integration * Content-Type: application/json * Schema: IntegrationV2DTO | CrowdStrikeIntegrationDTO | WizIntegrationDTO | GeoIPIntegrationDTO | TimeIntegrationDTO * **204**: Integration Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v2/integrations/{id}" ``` ### DELETE /api/v2/integrations/{id} **Summary:** Delete an Integration **Description:** Delete an Integration as identified by its ID. **Operation ID:** delete-integration2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Integration * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Successfully deleted Integration * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v2/integrations/{id}" ``` ### PATCH /api/v2/integrations/{id} **Summary:** Patch an Integration **Description:** Patch an Integration as identified by its ID. **Operation ID:** patch-integration2 **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Integration * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** IntegrationPatchDTO * Content-Type: application/json * Schema: IntegrationPatchDTO **Responses:** * **200**: Patched Integration * Content-Type: application/json * Schema: IntegrationV2DTO | CrowdStrikeIntegrationDTO | WizIntegrationDTO | GeoIPIntegrationDTO | TimeIntegrationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/integrations/{id}" ``` ## Log Stream ### GET /api/v1/log-streams **Summary:** Get a page of Log Streams **Description:** Get a page of Log Streams. **Operation ID:** get-log-streams **Parameters:** * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string **Responses:** * **200**: Page of Log Streams * Content-Type: application/json * Schema: LogStreamListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/log-streams?page=example-value&per-page=example-value&filter=example-value&order=example-value" ``` ### POST /api/v1/log-streams **Summary:** Create a Log Stream **Description:** Create a Log Stream. **Operation ID:** post-log-stream **Request Body:** LogStreamDTO * Content-Type: application/json * Schema: LogStreamAWSS3DestinationDTO | LogStreamGCSBucketDestinationDTO | LogStreamCrowdstrikeDestinationDTO | LogStreamSplunkDestinationDTO **Responses:** * **201**: Created Log Stream * Content-Type: application/json * Schema: LogStreamAWSS3DestinationDTO | LogStreamGCSBucketDestinationDTO | LogStreamCrowdstrikeDestinationDTO | LogStreamSplunkDestinationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/log-streams" ``` ### PUT /api/v1/log-streams **Summary:** Update a Log Stream **Description:** Update a Log Stream. **Operation ID:** put-log-stream **Request Body:** LogStreamDTO * Content-Type: application/json * Schema: LogStreamAWSS3DestinationDTO | LogStreamGCSBucketDestinationDTO | LogStreamCrowdstrikeDestinationDTO | LogStreamSplunkDestinationDTO **Responses:** * **200**: Updated Log Stream * Content-Type: application/json * Schema: LogStreamAWSS3DestinationDTO | LogStreamGCSBucketDestinationDTO | LogStreamCrowdstrikeDestinationDTO | LogStreamSplunkDestinationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/log-streams" ``` ### GET /api/v1/log-streams/{id} **Summary:** Get a Log Stream **Description:** Get a Log Stream identified by its ID. **Operation ID:** get-log-stream **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Log Stream **Responses:** * **200**: Log Stream * Content-Type: application/json * Schema: LogStreamAWSS3DestinationDTO | LogStreamGCSBucketDestinationDTO | LogStreamCrowdstrikeDestinationDTO | LogStreamSplunkDestinationDTO * **204**: Log Stream Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/log-streams/{id}" ``` ### DELETE /api/v1/log-streams/{id} **Summary:** Delete a Log Stream **Description:** Delete a Log Stream identified by its ID. **Operation ID:** delete-log-stream **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Log Stream **Responses:** * **204**: Successfully deleted Log Stream * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io/api/v1/log-streams/{id}" ``` ### PATCH /api/v1/log-streams/{id} **Summary:** Patch a Log Stream **Description:** Patch a Log Stream identified by its ID. **Operation ID:** patch-log-stream **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Log Stream **Request Body:** LogStreamPatchDTO * Content-Type: application/json * Schema: LogStreamPatchDTO **Responses:** * **200**: Patched Log Stream * Content-Type: application/json * Schema: LogStreamAWSS3DestinationDTO | LogStreamGCSBucketDestinationDTO | LogStreamCrowdstrikeDestinationDTO | LogStreamSplunkDestinationDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/log-streams/{id}" ``` ## Resource Set ### GET /api/v1/resource-sets/{id} **Summary:** Get a Resource Set **Description:** Get a Resource Set identified by its ID. **Operation ID:** get-resource-set **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Resource Set **Responses:** * **200**: Resource Set * Content-Type: application/json * Schema: ResourceSetDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/resource-sets/{id}" ``` ### PATCH /api/v1/resource-sets/{id} **Summary:** Patch a Resource Set **Description:** Patch a Resource Set identified by its ID. **Operation ID:** patch-resource-set **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Resource Set **Request Body:** ResourceSetPatchDTO * Content-Type: application/json * Schema: ResourceSetPatchDTO **Responses:** * **200**: Patched Resource Set * Content-Type: application/json * Schema: ResourceSetDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/resource-sets/{id}" ``` ### DELETE /api/v1/resource-sets/{id} **Summary:** Delete a Resource Set **Description:** Delete a Resource Set identified by its ID. **Operation ID:** delete-resource-set-integration **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Resource Set **Responses:** * **204**: Successfully deleted Resource Set * **400**: Bad Request * **401**: Not Authenticated * **404**: Not Found * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io/api/v1/resource-sets/{id}" ``` ### GET /api/v1/resource-sets **Summary:** Get a page of Resource Sets **Description:** Get a page of Resource Sets. **Operation ID:** get-resource-sets **Parameters:** * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of Resource Sets * Content-Type: application/json * Schema: ResourceSetDTOListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/resource-sets?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### POST /api/v1/resource-sets **Summary:** Create a Resource Set **Description:** Create a Resource Set. **Operation ID:** post-resource-set **Request Body:** ResourceSetDTO * Content-Type: application/json * Schema: ResourceSetDTO **Responses:** * **201**: Created Resource Set * Content-Type: application/json * Schema: ResourceSetDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/resource-sets" ``` ### PUT /api/v1/resource-sets **Summary:** Update a Resource Set **Description:** Update a Resource Set. **Operation ID:** put-resource-set **Request Body:** ResourceSetDTO * Content-Type: application/json * Schema: ResourceSetDTO **Responses:** * **200**: Updated Resource Set * Content-Type: application/json * Schema: ResourceSetDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/resource-sets" ``` ## Role ### GET /api/v1/roles **Summary:** Get a page of Roles **Description:** Get a page of Roles. **Operation ID:** get-roles **Parameters:** * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of Roles * Content-Type: application/json * Schema: RoleListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/roles?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### POST /api/v1/roles **Summary:** Create a new Role **Description:** Create a new Role. **Operation ID:** post-role **Request Body:** RoleDTO * Content-Type: application/json * Schema: RoleDTO **Responses:** * **201**: Created Role * Content-Type: application/json * Schema: RoleDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/roles" ``` ### PUT /api/v1/roles **Summary:** Update a Role **Description:** Update a Role. **Operation ID:** put-role **Request Body:** RoleDTO * Content-Type: application/json * Schema: RoleDTO **Responses:** * **200**: Updated Role * Content-Type: application/json * Schema: RoleDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/roles" ``` ### GET /api/v1/roles/{id} **Summary:** Get a Role **Description:** Get a Role identified by its ID. **Operation ID:** get-role **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Role **Responses:** * **200**: Role * Content-Type: application/json * Schema: RoleDTO * **204**: Role Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/roles/{id}" ``` ### DELETE /api/v1/roles/{id} **Summary:** Delete a Role **Description:** Delete a Role identified by its ID. **Operation ID:** delete-role **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Role **Responses:** * **204**: Successfully deleted Role * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io/api/v1/roles/{id}" ``` ### PATCH /api/v1/roles/{id} **Summary:** Patch a Role **Description:** Patch a Role identified by its ID. **Operation ID:** patch-role **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Role **Request Body:** RolePatchDTO * Content-Type: application/json * Schema: RolePatchDTO **Responses:** * **200**: Patch Role * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/roles/{id}" ``` ## Routing ### GET /api/v1/routings/{id} **Summary:** Get a Routing **Description:** Get a Routing identified by its ID. **Operation ID:** get-routing **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Routing **Responses:** * **200**: Routing * Content-Type: application/json * Schema: RoutingDTO * **400**: Bad Request * **401**: Not Authenticated * **403**: Forbidden * **404**: Not Found * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/routings/{id}" ``` ### PATCH /api/v1/routings/{id} **Summary:** Patch a Routing **Description:** Patch a Routing identified by its ID. **Operation ID:** patch-routing **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Routing **Request Body:** RoutingPatchDTO * Content-Type: application/json * Schema: RoutingPatchDTO **Responses:** * **200**: Patched Routing * Content-Type: application/json * Schema: RoutingDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/routings/{id}" ``` ### GET /api/v1/routings **Summary:** Get a page of Routings **Description:** Get a page of Routings. **Operation ID:** get-routings **Parameters:** * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of Routings * Content-Type: application/json * Schema: RoutingDTOListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/routings?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### POST /api/v1/routings **Summary:** Create a Routing **Description:** Create a Routing. **Operation ID:** post-routing **Request Body:** RoutingDTO * Content-Type: application/json * Schema: RoutingDTO **Responses:** * **201**: Created Routing * Content-Type: application/json * Schema: RoutingDTO * **400**: Bad Request * **401**: Not Authenticated * **403**: Forbidden * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/routings" ``` ### PUT /api/v1/routings **Summary:** Update a Routing **Description:** Update a Routing. **Operation ID:** put-routing **Request Body:** RoutingDTO * Content-Type: application/json * Schema: RoutingDTO **Responses:** * **200**: Updated Routing * Content-Type: application/json * Schema: RoutingDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/routings" ``` ## SignOn Policy ### GET /api/v1/signin-policies **Summary:** Get a SignOn Policy **Description:** Get a SignOn Policy by its name. **Operation ID:** get-signon-policy **Responses:** * **200**: SignOn Policy * Content-Type: application/json * Schema: GetSignInPolicyDTO * **204**: SignOn Policy Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/signin-policies" ``` ## MFA SignOn Policy ### PUT /api/v1/signin-policies/mfa **Summary:** Update a MFA SignOn Policy **Description:** Update a MFA SignOn Policy. **Operation ID:** put-mfa-signon Policy **Request Body:** MFASignInPolicyDTO * Content-Type: application/json * Schema: MFASignInPolicyDTO **Responses:** * **200**: Updated MFA SignOn Policy * Content-Type: application/json * Schema: MFASignInPolicyDTO * **400**: Bad Request * **401**: Not Authenticated * **403**: Forbidden * Content-Type: application/json * Schema: GenericResponseDTO * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/signin-policies/mfa" ``` ## SSO SignOn Policy ### PUT /api/v1/signin-policies/sso **Summary:** Update a SSO SignOn Policy **Description:** Update a SSO SignOn Policy. **Operation ID:** put-SSO-signon Policy **Request Body:** SSOSignInPolicyDTO * Content-Type: application/json * Schema: SSOSignInPolicyDTO **Responses:** * **200**: Updated SSO SignOn Policy * Content-Type: application/json * Schema: SSOSignInPolicyDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/signin-policies/sso" ``` ## SSO Identity Provider ### GET /api/v1/sso-idps/{id}/verification **Summary:** Verify the SSO Identity Provider **Description:** Verify the SSO Identity Provider has all necessary configuration data. **Operation ID:** get-identity-provider-verification **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of SSO Identity Provider **Responses:** * **200**: SSO Identity Provider verification * Content-Type: application/json * Schema: GenericResponseDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/sso-idps/{id}/verification" ``` ### GET /api/v1/sso-idps/{id} **Summary:** Get a SSO Identity Provider **Description:** Get a SSO Identity Provider identified by its ID. **Operation ID:** get-identity-provider **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of SSO Identity Provider **Responses:** * **200**: SSO Identity Provider * Content-Type: application/json * Schema: SSOIdentityProviderDTO | SamlIdentityProviderDTO | OidcIdentityProviderDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/sso-idps/{id}" ``` ### DELETE /api/v1/sso-idps/{id} **Summary:** Delete a SSO Identity Provider **Description:** Delete a SSO Identity Provider identified by its ID. **Operation ID:** delete-identity-provider **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of SSO Identity Provider **Responses:** * **204**: Successfully deleted SSO Identity Provider * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io/api/v1/sso-idps/{id}" ``` ### PATCH /api/v1/sso-idps/{id} **Summary:** Patch a SSO Identity Provider **Description:** Patch a SSO Identity Provider identified by its ID. **Operation ID:** patch-identity-provider **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of SSO Identity Provider **Request Body:** SSOIdentityProviderPatchDTO * Content-Type: application/json * Schema: SSOIdentityProviderPatchDTO **Responses:** * **200**: Patched SSO Identity Provider * Content-Type: application/json * Schema: SSOIdentityProviderDTO | SamlIdentityProviderDTO | OidcIdentityProviderDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/sso-idps/{id}" ``` ### GET /api/v1/sso-idps **Summary:** Get a page of SSO Identity Providers **Description:** Get a page of SSO Identity Providers. **Operation ID:** get-identity-providers **Parameters:** * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of SSO Identity Providers * Content-Type: application/json * Schema: SSOIdentityProviderDTOListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/sso-idps?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### POST /api/v1/sso-idps **Summary:** Create a SSO Identity Provider **Description:** Create a SSO Identity Provider. **Operation ID:** post-identity-provider **Request Body:** SSOIdentityProviderDTO * Content-Type: application/json * Schema: SSOIdentityProviderDTO | SamlIdentityProviderDTO | OidcIdentityProviderDTO **Responses:** * **201**: Created SSO Identity Provider * Content-Type: application/json * Schema: SSOIdentityProviderDTO | SamlIdentityProviderDTO | OidcIdentityProviderDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/sso-idps" ``` ### PUT /api/v1/sso-idps **Summary:** Update a SSO Identity Provider **Description:** Update a SSO Identity Provider. **Operation ID:** put-identity-provider **Request Body:** SSOIdentityProviderDTO * Content-Type: application/json * Schema: SSOIdentityProviderDTO | SamlIdentityProviderDTO | OidcIdentityProviderDTO **Responses:** * **200**: Updated SSO Identity Provider * Content-Type: application/json * Schema: SSOIdentityProviderDTO | SamlIdentityProviderDTO | OidcIdentityProviderDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/sso-idps" ``` ## Standalone Certificate Authority ### DELETE /api/v1/certificate-authorities/{id} **Summary:** Delete a Standalone Certificate Authority **Description:** Delete a Standalone Certificate Authority identified by its ID. **Operation ID:** delete-standalone-certificate-authority **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Standalone Certificate Authority **Responses:** * **204**: Successfully deleted Standalone Certificate Authority * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io/api/v1/certificate-authorities/{id}" ``` ### GET /api/v1/certificate-authorities/{id} **Summary:** Get a Standalone Certificate Authority **Description:** Get a Standalone Certificate Authority identified by its ID. **Operation ID:** get-standalone-certificate-authority **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Standalone Certificate Authority **Responses:** * **200**: Standalone Certificate Authority * Content-Type: application/json * Schema: StandaloneCertificateResponseDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/certificate-authorities/{id}" ``` ### PATCH /api/v1/certificate-authorities/{id} **Summary:** Patch a Standalone Certificate Authority **Description:** Patch a Standalone Certificate Authority identified by its ID. **Operation ID:** patch-standalone-certificate-authority **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Standalone Certificate Authority **Request Body:** StandaloneCertificatePatchDTO * Content-Type: application/json * Schema: StandaloneCertificatePatchDTO **Responses:** * **200**: Patched Standalone Certificate Authority * Content-Type: application/json * Schema: StandaloneCertificateResponseDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/certificate-authorities/{id}" ``` ### GET /api/v1/certificate-authorities **Summary:** Get a page of Standalone Certificate Authorities **Description:** Get a page of Standalone Certificate Authorities. **Operation ID:** get-standalone-certificate-authorities **Parameters:** * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of Standalone Certificate Authorities * Content-Type: application/json * Schema: StandaloneCertificateResponseDTOListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/certificate-authorities?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### POST /api/v1/certificate-authorities **Summary:** Create a Standalone Certificate Authority **Description:** Create a Standalone Certificate Authority. **Operation ID:** post-standalone-certificate-authority **Request Body:** StandaloneCertificateDTO * Content-Type: application/json * Schema: StandaloneCertificateRequestDTO **Responses:** * **201**: Created Standalone Certificate Authority * Content-Type: application/json * Schema: StandaloneCertificateResponseDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/certificate-authorities" ``` ### PUT /api/v1/certificate-authorities **Summary:** Update a Standalone Certificate Authority **Description:** Update a Standalone Certificate Authority. **Operation ID:** put-standalone-certificate-authority **Request Body:** StandaloneCertificateDTO * Content-Type: application/json * Schema: StandaloneCertificateRequestDTO **Responses:** * **200**: Updated Standalone Certificate Authority * Content-Type: application/json * Schema: StandaloneCertificateResponseDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/certificate-authorities" ``` ## Standalone TLS Decrypt ### GET /api/v1/certificate-authorities/{id}/root-ca **Summary:** Download Standalone Root CA Certificate **Description:** Download the Standalone Root CA Certificate. This CA Certificate can be used for TLS verification when utilizing the Aembit TLS Decrypt feature. **Operation ID:** standalone-root-ca **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Standalone Certificate Authority **Responses:** * **200**: OK * Content-Type: application/x-pem-file * Schema: string (binary) **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/certificate-authorities/{id}/root-ca" ``` ## TLS Decrypt ### GET /api/v1/root-ca **Summary:** Download Tenant Root CA Certificate **Description:** Download the Tenant Root CA Certificate. This CA Certificate can be used for TLS verification when utilizing the Aembit TLS Decrypt feature. **Operation ID:** root-ca **Responses:** * **200**: OK * Content-Type: application/x-pem-file * Schema: string (binary) **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/root-ca" ``` ## Trust Provider ### GET /api/v1/trust-providers **Summary:** Get a page of Trust Providers **Description:** Get a page of Trust Providers. **Operation ID:** get-trust-providers **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string * **active** (query) *(optional)*: boolean **Responses:** * **200**: Page of Trust Providers * Content-Type: application/json * Schema: TrustProviderListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/trust-providers?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value&active=example-value" ``` ### POST /api/v1/trust-providers **Summary:** Create a Trust Provider **Description:** Create a Trust Provider. **Operation ID:** post-trust-provider **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** TrustProviderDTO * Content-Type: application/json * Schema: TrustProviderDTO **Responses:** * **200**: Created Trust Provider * Content-Type: application/json * Schema: TrustProviderDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/trust-providers" ``` ### PUT /api/v1/trust-providers **Summary:** Update a Trust Provider **Description:** Update a Trust Provider. **Operation ID:** put-trust-provider **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** TrustProviderDTO * Content-Type: application/json * Schema: TrustProviderDTO **Responses:** * **200**: Updated Trust Provider * Content-Type: application/json * Schema: TrustProviderDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/trust-providers" ``` ### GET /api/v1/trust-providers/{id} **Summary:** Get a Trust Provider **Description:** Get a Trust Provider identified by its ID. **Operation ID:** get-trust-provider **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Trust Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Trust Provider * Content-Type: application/json * Schema: TrustProviderDTO * **204**: Trust Provider Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/trust-providers/{id}" ``` ### DELETE /api/v1/trust-providers/{id} **Summary:** Delete a Trust Provider **Description:** Delete a Trust Provider identified by its ID. **Operation ID:** delete-trust-provider **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Trust Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **204**: Successfully deleted Trust Provider * **400**: Bad Request * **401**: Not Authenticated * **404**: Not Found * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/trust-providers/{id}" ``` ### PATCH /api/v1/trust-providers/{id} **Summary:** Patch a Trust Provider **Description:** Patch a Trust Provider. **Operation ID:** patch-trust-provider **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Trust Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** TrustProviderPatchDTO * Content-Type: application/json * Schema: TrustProviderPatchDTO **Responses:** * **200**: Patched Trust Provider * Content-Type: application/json * Schema: TrustProviderDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/trust-providers/{id}" ``` ## Trust Provider Secret ### GET /api/v1/trust-providers/{tpId}/secrets **Summary:** Get a page of Trust Provider Secrets **Description:** Get a page of Trust Provider Secrets. **Operation ID:** get-trust-providers-secrets **Parameters:** * **tpId** (path) *(required)*: string (uuid) - ID of Trust Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string **Responses:** * **200**: Page of Trust Providers Secrets * Content-Type: application/json * Schema: TrustProviderSecretDTOListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/trust-providers/{tpId}/secrets?page=example-value&per-page=example-value&filter=example-value&order=example-value" ``` ### POST /api/v1/trust-providers/{tpId}/secrets **Summary:** Create a Trust Provider Secret **Description:** Create a Trust Provider Secret. **Operation ID:** post-trust-provider-secret **Parameters:** * **tpId** (path) *(required)*: string (uuid) - ID of Trust Provider * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** TrustProviderDTO * Content-Type: application/json * Schema: TrustProviderSecretSlimDTO **Responses:** * **200**: Created Trust Provider Secret * Content-Type: application/json * Schema: TrustProviderSecretDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/trust-providers/{tpId}/secrets" ``` ### GET /api/v1/trust-providers/{tpId}/secrets/{secretId} **Summary:** Get a Trust Provider Secret **Description:** Get a Trust Provider Secret identified by its ID. **Operation ID:** get-trust-provider-secret **Parameters:** * **tpId** (path) *(required)*: string (uuid) - ID of Trust Provider * **secretId** (path) *(required)*: string (uuid) - ID of Trust Provider Secret * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Trust Provider * Content-Type: application/json * Schema: TrustProviderDTO * **204**: Trust Provider Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/trust-providers/{tpId}/secrets/{secretId}" ``` ### DELETE /api/v1/trust-providers/{tpId}/secrets/{secretId} **Summary:** Delete a Trust Provider Secret **Description:** Delete a Trust Provider Secret identified by its ID. **Operation ID:** delete-trust-provider-secret **Parameters:** * **tpId** (path) *(required)*: string (uuid) - ID of Trust Provider * **secretId** (path) *(required)*: string (uuid) - ID of Trust Provider Secret * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **204**: Successfully deleted Trust Provider Secret * **400**: Bad Request * **401**: Not Authenticated * **404**: Not Found * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/trust-providers/{tpId}/secrets/{secretId}" ``` ## User ### GET /api/v1/users **Summary:** Get a page of Users **Description:** Get a page of Users. **Operation ID:** get-users **Parameters:** * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of Users * Content-Type: application/json * Schema: UserListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/users?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### POST /api/v1/users **Summary:** Create a User **Description:** Create a User. **Operation ID:** post-user **Request Body:** UserDTO * Content-Type: application/json * Schema: UserDTO **Responses:** * **201**: Created User * Content-Type: application/json * Schema: UserDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/users" ``` ### PATCH /api/v1/users/{id} **Summary:** Patch a User **Description:** Patch a User identified by its ID. **Operation ID:** patch-user **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of User **Request Body:** UserPatchDTO * Content-Type: application/json * Schema: UserPatchDTO **Responses:** * **200**: Patched User * Content-Type: application/json * Schema: UserDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/users/{id}" ``` ### GET /api/v1/users/{id} **Summary:** Get a User **Description:** Get a User identified by its ID. **Operation ID:** get-user **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of User **Responses:** * **201**: User * Content-Type: application/json * Schema: UserDTO * **204**: User Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/users/{id}" ``` ### PUT /api/v1/users/{id} **Summary:** Update a User **Description:** Update a User. **Operation ID:** put-user **Parameters:** * **id** (path) *(required)*: string **Request Body:** UserDTO * Content-Type: application/json * Schema: UserDTO **Responses:** * **200**: User * Content-Type: application/json * Schema: UserDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/users/{id}" ``` ### DELETE /api/v1/users/{id} **Summary:** Delete a User **Description:** Delete a User identified by its ID. **Operation ID:** delete-user **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of User **Responses:** * **204**: Successfully deleted User * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io/api/v1/users/{id}" ``` ### POST /api/v1/users/{id}/unlock **Summary:** Unlock a User **Description:** Unlock a User identified by its ID. **Operation ID:** post-user-unlock **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of User **Responses:** * **200**: Successfully unlocked User * Content-Type: application/json * Schema: GenericResponseDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ "https://your-tenant.aembit.io/api/v1/users/{id}/unlock" ``` ## Server Workload ### POST /api/v1/server-workloads **Summary:** Create a Server Workload **Description:** Create a Server Workload. **Operation ID:** post-server-workload **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** ServerWorkloadExternalDTO * Content-Type: application/json * Schema: ServerWorkloadExternalDTO **Responses:** * **204**: Created Server Workload * Content-Type: application/json * Schema: ServerWorkloadExternalDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/server-workloads" ``` ### PUT /api/v1/server-workloads **Summary:** Update a Server Workload **Description:** Update a Server Workload. **Operation ID:** put-server-workload **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** ServerWorkloadExternalDTO * Content-Type: application/json * Schema: ServerWorkloadExternalDTO **Responses:** * **200**: Updated Server Workload * Content-Type: application/json * Schema: ServerWorkloadExternalDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/server-workloads" ``` ### GET /api/v1/server-workloads **Summary:** Get a page of Server Workloads **Description:** Get a page of Server Workloads. **Operation ID:** get-server-workloads **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of Server Workloads * Content-Type: application/json * Schema: ServerWorkloadListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/server-workloads?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### PATCH /api/v1/server-workloads/{id} **Summary:** Patch a Server Workload **Description:** Patch a Server Workload. **Operation ID:** patch-server-workload **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Server Workload * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** EntityPatchDTO * Content-Type: application/json * Schema: EntityPatchDTO **Responses:** * **200**: Patched Server Workload * Content-Type: application/json * Schema: ServerWorkloadExternalDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/server-workloads/{id}" ``` ### GET /api/v1/server-workloads/{id} **Summary:** Get a Server Workload **Description:** Get a Server Workload identified by its ID. **Operation ID:** get-server-workload **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Server Workload * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Server Workload * Content-Type: application/json * Schema: ServerWorkloadExternalDTO * **204**: Server Workload Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/server-workloads/{id}" ``` ### DELETE /api/v1/server-workloads/{id} **Summary:** Delete a Server Workload **Description:** Delete a Server Workload identified by its ID. **Operation ID:** delete-server-workload **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Server Workload * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **204**: Successfully deleted Server Workload * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/server-workloads/{id}" ``` ## Client Workload ### POST /api/v1/client-workloads **Summary:** Create a Client Workload **Description:** Create a Client Workload. **Operation ID:** post-client-workload **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** ClientWorkloadExternalDTO * Content-Type: application/json * Schema: ClientWorkloadExternalDTO **Responses:** * **204**: Created Client Workload * Content-Type: application/json * Schema: ClientWorkloadExternalDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X POST \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/client-workloads" ``` ### PUT /api/v1/client-workloads **Summary:** Update a Client Workload **Description:** Update a Client Workload. **Operation ID:** put-client-workload **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** ClientWorkloadExternalDTO * Content-Type: application/json * Schema: ClientWorkloadExternalDTO **Responses:** * **200**: Updated Client Workload * Content-Type: application/json * Schema: ClientWorkloadExternalDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PUT \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/client-workloads" ``` ### GET /api/v1/client-workloads **Summary:** Get a page of Client Workloads **Description:** Get a page of Client Workloads. **Operation ID:** get-client-workloads **Parameters:** * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) * **page** (query) *(optional)*: integer (int32) * **per-page** (query) *(optional)*: integer (int32) * **filter** (query) *(optional)*: string * **order** (query) *(optional)*: string * **group-by** (query) *(optional)*: string **Responses:** * **200**: Page of Client Workloads * Content-Type: application/json * Schema: ClientWorkloadListDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/client-workloads?page=example-value&per-page=example-value&filter=example-value&order=example-value&group-by=example-value" ``` ### PATCH /api/v1/client-workloads/{id} **Summary:** Patch a Client Workload **Description:** Patch a Client Workload. **Operation ID:** patch-client-workload **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Client Workload * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Request Body:** ClientWorkloadPatchDTO * Content-Type: application/json * Schema: ClientWorkloadPatchDTO **Responses:** * **200**: Patched Client Workload * Content-Type: application/json * Schema: ClientWorkloadExternalDTO * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X PATCH \ -H "X-Aembit-ResourceSet: your-resource-set-id" -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/client-workloads/{id}" ``` ### GET /api/v1/client-workloads/{id} **Summary:** Get a Client Workload **Description:** Get a Client Workload identified by its ID. **Operation ID:** get-client-workload **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Client Workload * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **200**: Client Workload * Content-Type: application/json * Schema: ClientWorkloadExternalDTO * **204**: Client Workload Not Found * **400**: Bad Request * **401**: Not Authenticated * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X GET \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/client-workloads/{id}" ``` ### DELETE /api/v1/client-workloads/{id} **Summary:** Delete a Client Workload **Description:** Delete a Client Workload identified by its ID. **Operation ID:** delete-client-workload **Parameters:** * **id** (path) *(required)*: string (uuid) - ID of Client Workload * **X-Aembit-ResourceSet** (header) *(optional)*: string (uuid) **Responses:** * **204**: Successfully deleted Client Workload * **400**: Bad Request * **401**: Not Authenticated * **404**: Not Found * **500**: Internal Server Error * Content-Type: application/json * Schema: GenericResponseDTO **cURL Example:** ```bash curl -X DELETE \ -H "X-Aembit-ResourceSet: your-resource-set-id" \ "https://your-tenant.aembit.io/api/v1/client-workloads/{id}" ``` ### GET /api/v1/client-workloads/identifiers **Summary:** Get Client Identifier List **Description:** Get list of client identifier objects **Operation ID:** get-client-identifiers **Responses:** * **200**: Client Identifiers * Content-Type: application/json * Schema: Array * **204**: Client Identifiers Not Found * **400**: Bad Request * **401**: Not Authenticated **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/client-workloads/identifiers" ``` *** # Aembit Cloud API - Data Schemas **Version:** v1 ### AccessConditionDTO DTO of an individual Access Condition for enforcement during Access Policy evaluation **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **integrationID** *(optional)*: string (uuid) - ID of the Integration Entity used by this Access Condition * **integration** *(optional)*: IntegrationDTO - Integration Entity used by this Access Condition * **conditions** *(required)*: object - Rules which are enforced by the Access Condition * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Access Condition * **integrationType** *(optional)*: string | null ### AccessConditionDTOAccessConditionListDTO Page of Access Conditions **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP Status Code of the response * **recordsTotal** *(optional)*: integer (int32) - Total number of Access Conditions * **accessConditions** *(optional)*: Array | null - Page of Access Conditions ### AccessConditionPatchDTO Patch Request DTO for individual Access Condition **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity ### AccessConditionV2DTO **Type:** object **Properties:** * **integrationType** *(required)*: string | null * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **integrationID** *(optional)*: string (uuid) - ID of the Integration Entity used by this Access Condition * **integration** *(optional)*: IntegrationV2DTO | CrowdStrikeIntegrationDTO | WizIntegrationDTO | GeoIPIntegrationDTO | TimeIntegrationDTO | null - Integration Entity used by this Access Condition * **maxLastSeenSeconds** *(optional)*: integer (int32) * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Access Condition ### AccessConditionV2DTOAccessConditionListDTO Page of Access Conditions **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP Status Code of the response * **recordsTotal** *(optional)*: integer (int32) - Total number of Access Conditions * **accessConditions** *(optional)*: Array\ | null - Page of Access Conditions ### AgentControllerDTO DTO of an individual Agent Controller for Agent Proxy management **Type:** object **Properties:** * **id** *(optional)*: integer (int) - ID of the Agent Controller * **externalId** *(optional)*: string (uuid) - ID of the Agent Controller * **createdAt** *(optional)*: string (date) - Agent Controller creation Timestamp * **version** *(optional)*: string | null - Last reported software version of the Agent Controller * **isActive** *(optional)*: boolean (boolean) - Active status of the Agent Controller * **name** *(required)*: string - Name of the Agent Controller * **description** *(optional)*: string | null - Description of the Agent Controller * **tags** *(optional)*: Array | null - Tags assigned to the Agent Controller * **tlsCertificates** *(optional)*: Array | null - TLS Certificates associated with the Agent Controller * **trustProviderId** *(optional)*: string (uuid) | null - Trust Provider ID of the Agent Controller used for attested authentication * **trustProvider** *(optional)*: TrustProviderDTO - Trust Provider of the Agent Controller used for attested authentication * **modifiedAt** *(optional)*: string (date) - Agent Controller modification Timestamp * **isHealthy** *(optional)*: boolean (boolean) - Recently reported Agent Controller Health Status * **lastReportedUptime** *(optional)*: integer (int64) - Last Reported Agent Controller Uptime (in seconds) * **lastReportedHealthTime** *(optional)*: string (date) | null - Last Reported Agent Controller Health Time * **allowedTlsHostname** *(optional)*: string | null - Allowed TLS Hostname for Aembit Managed TLS ### AgentControllerDeviceCodeDTO DTO of an individual Agent Controller Device Code **Type:** object **Properties:** * **device\_code** *(optional)*: string | null - One time use OAuth 2 Device Code for use during AgentController deployment and registration ### AgentControllerListDTO Page of Agent Controllers for Agent Proxy management **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP StatusCode for the current result * **recordsTotal** *(optional)*: integer (int32) - Total number of AgentControllers available * **agentControllers** *(optional)*: Array | null - Page of AgentControllers for this request ### AgentControllerPatchDTO Patch Request DTO for individual Agent Controller **Type:** object **Properties:** * **version** *(optional)*: string | null * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified Agent Controller * **trustProviderId** *(optional)*: string (uuid) | null - New Trust Provider to use for the identified Agent Controller ### AgentControllerTagDTO Agent Controller Tag key and value **Type:** object **Properties:** * **key** *(required)*: string - Key for the Agent Controller Tag * **value** *(required)*: string - Value for the Agent Controller Tag ### AgentControllerTlsCertificateDTO Agent Controller TLS Certificate information **Type:** object **Properties:** * **subject** *(required)*: string - Subject of the Certificate * **serialNumber** *(required)*: string - Serial Number of the Certificate * **thumbprint** *(required)*: string - Thumbprint of the Certificate * **notBefore** *(required)*: string (date-time) - Creation Timestamp of the Certificate * **notAfter** *(required)*: string (date-time) - Expiration Timestamp of the Certificate * **hostName** *(required)*: string - Last reported Hostname for the Agent Controller * **createdAt** *(required)*: string (date-time) - Creation Timestamp for this Agent Controller TLS Certificate * **isManagedByAembit** *(optional)*: boolean (boolean) - True if the Agent Controller TLS Certificate is managed by Aembit ### AuditActorDTO DTO for the Actor details of an Aembit Audit Log **Type:** object **Properties:** * **type** *(optional)*: string | null - The type of Audit Log actor (e.g. User, System, or Role) * **displayName** *(optional)*: string | null - Fully qualified Audit Log Actor name * **userName** *(optional)*: string | null * **email** *(optional)*: string | null * **credentialProviderId** *(optional)*: string | null - Credential Provider ID that was used to generate the Role-based Access Token for this Audit Log action * **accessPolicyId** *(optional)*: string | null - Access Policy ID that was used to generate the Role-based Access Token for this Audit Log action ### AuditClientDTO DTO for the Client details of an Aembit Audit Log **Type:** object **Properties:** * **ipAddress** *(optional)*: string | null - IP Address of the remote client * **userAgent** *(optional)*: UserAgentDTO - HTTP User Agent of the remote client ### AuditLogDTO DTO for an individual Aembit Audit Log **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) - ID of an Aembit Audit Log * **resourceSetId** *(optional)*: string (uuid) - Resource Set ID of an Aembit Audit Log * **category** *(optional)*: string | null - Category of an Aembit Audit Log (e.g. Users, AccessPolicies, Workloads, etc.) * **actor** *(optional)*: AuditActorDTO - Actor DTO of an Aembit Audit Log * **activity** *(optional)*: string | null - Activity of an Aembit Audit Log * **target** *(optional)*: string | null - Target of an Aembit Audit Log * **client** *(optional)*: AuditClientDTO - Remote Client DTO of an Aembit Audit Log * **outcome** *(optional)*: AuditOutcomeDTO - Outcome DTO of an Aembit Audit Log * **trustProvider** *(optional)*: EventResultDTO - Attestation Result DTO for an AgentController of an Aembit Audit Log * **severity** *(optional)*: string | null - Severity of an Aembit Audit Log * **createdAt** *(optional)*: string (date-time) - Timestamp of when this Aembit Audit Log was created ### AuditLogListDTO Page of Aembit Audit Logs **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP Status Code of the response * **recordsTotal** *(optional)*: integer (int32) - Total number of Aembit Audit Logs * **auditLogs** *(optional)*: Array | null - Page of Aembit Audit Logs ### AuditOutcomeDTO DTO for the Outcome of an individual Aembit Audit Log **Type:** object **Properties:** * **reason** *(optional)*: string | null - Reason for the outcome of this Aembit Audit Log * **result** *(optional)*: string | null - Outcome of the action associated with this Aembit Audit Log ### AuthorizationEventAtttestationResultDTO Individual Access Entity Attestation Result of an Aembit Access Authorization Event **Type:** object **Properties:** * **id** *(optional)*: string (uuid) - Access Entity ID * **name** *(optional)*: string | null - Access Entity Name * **result** *(optional)*: string | null - Access Entity processing Result for this Access Authorization Event * **matches** *(optional)*: Array | null - List of matched Access Entity Identifiers * **reason** *(optional)*: string | null * **attribute** *(optional)*: string | null * **expectedValue** *(optional)*: string | null * **expectedValues** *(optional)*: Array | null * **actualValue** *(optional)*: string | null ### AuthorizationEventCPResultDTO Individual Credential Provider Result of an Aembit Access Authorization Event **Type:** object **Properties:** * **id** *(optional)*: string (uuid) - Access Entity ID * **name** *(optional)*: string | null - Access Entity Name * **result** *(optional)*: string | null - Access Entity processing Result for this Access Authorization Event * **matches** *(optional)*: Array | null - List of matched Access Entity Identifiers * **type** *(optional)*: string | null - Credential Provider Type * **reason** *(optional)*: string | null - Credential Provider Failure Reason ### AuthorizationEventDTO An individual Aembit Access Authorization Event **Type:** object **Properties:** * **authorizationChain** *(optional)*: Array | null * **meta** *(optional)*: AuthorizationEventDataMetaDTO - Metadata for an individual Aembit Access Authorization Event * **outcome** *(optional)*: AuthorizationEventOutcomeDTO - Outcome information for an individual Aembit Access Authorization Event * **clientRequest** *(optional)*: ClientRequestDTO - Client Request information for an individual Aembit Access Authorization Event * **environment** *(optional)*: AuthorizationEventEnvironmentDataDTO * **clientWorkload** *(optional)*: AuthorizationEventEntityResultDTO - Client Workload information for an individual Aembit Access Authorization Event * **clientWorkloads** *(optional)*: Array | null - Client Workload information for an individual Aembit Access Authorization Event * **serverWorkload** *(optional)*: AuthorizationEventEntityResultDTO - Server Workload information for an individual Aembit Access Authorization Event * **serverWorkloads** *(optional)*: Array | null - Server Workload information for an individual Aembit Access Authorization Event * **accessPolicy** *(optional)*: AuthorizationEventEntityResultDTO - Access Policy information for an individual Aembit Access Authorization Event * **accessPolicies** *(optional)*: Array | null - Access Policy information for an individual Aembit Access Authorization Event * **trustProviders** *(optional)*: Array | null - Trust Provider information for an individual Aembit Access Authorization Event * **accessConditions** *(optional)*: Array | null - Access Condition information for an individual Aembit Access Authorization Event * **contentSecurity** *(optional)*: Array | null - Content Security information for an individual Aembit Access Authorization Event * **credentialProvider** *(optional)*: AuthorizationEventCPResultDTO - Credential Provider information for an individual Aembit Access Authorization Event * **user** *(optional)*: string | null - User information of the Aembit Access Authorization Event ### AuthorizationEventDataMetaDTO Metadata DTO for an individual Aembit Access Authorization Event **Type:** object **Properties:** * **clientIP** *(optional)*: string | null - Remote Client IP Address of the Access Authorization Request * **timestamp** *(optional)*: string (date-time) - Timestamp of the Access Authorization Request * **eventType** *(optional)*: string | null - Event Type of the Access Authorization Request * **eventId** *(optional)*: string (uuid) - Unique ID of the Access Authorization Event * **resourceSetId** *(optional)*: string (uuid) - Resource Set ID of the Access Authorization Event * **contextId** *(optional)*: string (uuid) - Context ID of the Access Authorization Events for a single Access Authorization Request * **directiveId** *(optional)*: string (uuid) - Directive ID of the Access Authorization Event (if available) * **severity** *(optional)*: string | null - Severity of the Access Authorization Event (e.g. Info, Warning, Error) ### AuthorizationEventEntityResultDTO Access Entity Result of an Aembit Access Authorization Event **Type:** object **Properties:** * **id** *(optional)*: string (uuid) - Access Entity ID * **name** *(optional)*: string | null - Access Entity Name * **result** *(optional)*: string | null - Access Entity processing Result for this Access Authorization Event * **matches** *(optional)*: Array | null - List of matched Access Entity Identifiers ### AuthorizationEventEnvironmentDataDTO **Type:** object **Properties:** * **network** *(optional)*: RequestMetadaNetworkDTO * **host** *(optional)*: RequestMetadaHostDTO * **process** *(optional)*: RequestMetadaProcessDTO * **aembit** *(optional)*: RequestMetadaAembitDTO * **aws** *(optional)*: RequestMetadaAwsDTO * **gcp** *(optional)*: RequestMetadaGcpDTO * **azure** *(optional)*: RequestMetadaAzureDTO * **kubernetes** *(optional)*: RequestMetadaKubernetesDTO * **gitlab** *(optional)*: RequestMetadaGitlabDTO * **github** *(optional)*: RequestMetadaGithubDTO * **oidc** *(optional)*: RequestMetadataOidcDTO * **terraform** *(optional)*: RequestMetadaTerraformDTO * **oauth** *(optional)*: RequestMetadaOAuthDTO ### AuthorizationEventListDTO Page of Aembit Access Authorization Events **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP Status Code of the response * **recordsTotal** *(optional)*: integer (int32) - Total number of Aembit Audit Logs * **authorizationEvents** *(optional)*: Array | null - Page of Aembit Access Authorization Events ### AuthorizationEventOutcomeDTO Outcome of an individual Aembit Access Authorization Event **Type:** object **Properties:** * **result** *(optional)*: string | null - Result of an individual Aembit Access Authorization Event * **reason** *(optional)*: string | null - Reason for the Result of an individual Aembit Access Authorization Event ### AwsIamRoleCpiDTO DTO for AWS IAM Role Credential Provider Integration **Extends:** CredentialProviderIntegrationDTO **Type:** object **Properties:** * **type** *(required)*: CredentialProviderIntegrationType * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **tokenExpiration** *(optional)*: string (date-time) | null * **lastOperationTimestamp** *(optional)*: string (date-time) | null * **status** *(optional)*: string | null * **errorMessage** *(optional)*: string | null * **roleArn** *(required)*: string - ARN of the AWS IAM Role to assume for access * **lifetimeInSeconds** *(optional)*: integer (int32) - Lifetime of the access credentials in seconds, default is 3600 seconds (1 hour) * **fetchSecretArns** *(optional)*: boolean - Indicates whether to fetch and populate the ARNs of secrets on AWS Secrets Manager Value Credential Provider UI ### AzureEntraFederationCredentialProviderIntegrationDTO Individual Credential Provider Integration **Extends:** CredentialProviderIntegrationDTO **Type:** object **Properties:** * **type** *(required)*: CredentialProviderIntegrationType * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **tokenExpiration** *(optional)*: string (date-time) | null * **lastOperationTimestamp** *(optional)*: string (date-time) | null * **status** *(optional)*: string | null * **errorMessage** *(optional)*: string | null * **audience** *(required)*: string - Audience of the federated OIDC token to authenticate against Azure Entra ID * **subject** *(required)*: string - Subject of the federated OIDC token to authenticate against Azure Entra ID * **azureTenant** *(required)*: string - Tenant ID of the Azure Entra ID to authenticate against Azure Key Vault * **clientId** *(required)*: string - Client ID of the Azure application to authenticate against Azure Key Vault * **keyVaultName** *(required)*: string - Name of the Azure Key Vault to fetch secrets from * **fetchSecretNames** *(optional)*: boolean - Indicates whether to fetch and populate the names of secrets on Azure Key Vault Value Credential Provider UI ### CPAwsStsV2DTO **Extends:** CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider * **awsIAMRoleArn** *(required)*: string - Amazon Resource Name(ARN) for AWS IAM Role * **lifetime** *(optional)*: integer (int32) | null - Access token lifetime (in seconds) ### CPGitLabManagedAccountDTO **Extends:** CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider * **groupIds** *(optional)*: string | null - Comma separated list of GitLab Group Identifiers or Paths * **projectIds** *(optional)*: string | null - Comma separated list of GitLab Project Identifiers or Paths * **accessLevel** *(required)*: integer (int32) - Access level code to use while assigning Managed Service Account to a group or a project * **lifetimeInSeconds** *(required)*: integer (int32) - Lifetime (in seconds) of a Personal Access Token of the Managed Service Account * **scope** *(required)*: string - A space separated list of scopes to be specified when requesting a Personal Access Token of a Managed Service Account * **userId** *(optional)*: integer (int32) - GitLab user ID of the Managed Service Account. * **username** *(optional)*: string | null - GitLab username of the Managed Service Account. * **tokenSensitiveDataId** *(optional)*: string (uuid) * **tokenId** *(optional)*: string | null * **tokenExpiration** *(optional)*: string (date-time) | null - Expiration timestamp of the Personal Access Token of the Managed Service Account. * **lastOperationTimestamp** *(optional)*: string (date-time) | null - Timestamp of the latest operation performed with the Personal Access Token of the Managed Service Account. * **status** *(optional)*: string | null - Status of the Personal Access Token of the Managed Service Account. * **errorMessage** *(optional)*: string | null - Contains an error message related to the last unsuccessful operation using the Personal Access Token of the Managed Service Account. * **credentialProviderIntegrationExternalId** *(optional)*: string (uuid) - ID of the Credential Provider Integration with which this Managed GitLab Account Credential Provider is associated ### CPTypeAembitAccessTokenV2DTO **Extends:** CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider * **audience** *(required)*: string (your\_tenant\_id.api.aembit.io) - Audience for the access token * **roleId** *(required)*: string (uuid) - Aembit Role Id * **lifetimeInSeconds** *(required)*: integer (int32) - Access token lifetime (in seconds) * **absoluteTokenLifetime** *(optional)*: integer (int32) | null - Absolute Lifetime of the Refresh Token. Setting a value indicates Refresh Token Support will be enabled. ### CPTypeApiKeyUIV2DTO **Extends:** CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider * **apiKey** *(required)*: string - API Key ### CPTypeAzureEntraFederationV2DTO **Extends:** CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider * **audience** *(required)*: string - Audience for the access token * **subject** *(required)*: string - Subject for the access token * **scope** *(required)*: string - Scope for the access token * **azureTenant** *(required)*: string - Azure tenant ID * **clientId** *(required)*: string - Azure client ID ### CPTypeAzureKeyVaultValueDTO **Extends:** CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider * **secretName1** *(optional)*: string | null - The first secret. Used when specifying a single key or a key representing a username when working with a username/password pair. * **secretName2** *(optional)*: string | null - The second secret. Used when specifying a password when working with a username/password pair. * **credentialProviderIntegrationExternalId** *(required)*: string (uuid) - ID of the Azure Entra Federation Credential Provider Integration with which this Azure Key Vault Value Credential is associated * **privateNetworkAccess** *(optional)*: boolean - Indicates if the Azure Key Vault Value Credential should be accessed over a private network ### CPTypeClaudeWifV2DTO **Extends:** CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider * **federationRuleId** *(required)*: string - Federation Rule ID * **organizationId** *(required)*: string - Organization ID * **serviceAccountId** *(required)*: string - Service Account ID * **workspaceId** *(optional)*: string | null - Workspace ID * **audience** *(optional)*: string | null - Audience * **scope** *(required)*: string - Scope * **lifetime** *(optional)*: integer (int32) | null - Access token lifetime (in seconds) ### CPTypeGoogleWorkflowIDFederationV2DTO **Extends:** CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider * **audience** *(required)*: string - Audience for the access token * **serviceAccountEmail** *(required)*: string (email) - Service account email * **lifetime** *(optional)*: integer (int32) | null - Access token lifetime (in seconds) ### CPTypeJWTTokenV2DTO **Extends:** CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider * **tokenConfiguration** *(required)*: string - Token configuration type. Accepted value: ‘snowflake’ * **lifetime** *(required)*: integer (int32) - Access token lifetime (in seconds) * **algorithmType** *(required)*: string - Token signing algorithm. Accepted value: ‘RS256’ * **issuer** *(required)*: string (Snowflake\_Account\_Name.Snowflake\_Username.SHA256:{sha256(publicKey)}) - Issuer of the access token * **subject** *(required)*: string (Snowflake\_Account\_Name.Snowflake\_Username) - Subject of the access token * **keyContent** *(optional)*: string | null * **privateKey** *(optional)*: string | null ### CPTypeOAuth2AuthorizationCodeUIV2DTO **Extends:** CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider * **clientID** *(required)*: string - OAuth Client ID * **clientSecret** *(optional)*: string | null - OAuth Client Secret * **scope** *(optional)*: string | null - OAuth Scopes * **customParameters** *(optional)*: Array | null - Custom Claims that are added to the Access Token * **oAuthUrl** *(required)*: string - OAuth well-known metadata endpoint * **authorizationUrl** *(required)*: string - OAuth Authorization URL for handling authorization requests * **tokenUrl** *(required)*: string - OAuth Token URL for handling token requests * **introspectionUrl** *(optional)*: string | null - Introspection Url of the OAuth 2.0 introspection endpoint, used to validate and obtain metadata about access tokens * **isPkceRequired** *(optional)*: boolean - Indicates if Proof Key for Code Exchange (PKCE) protocol flow must be used * **callBackUrl** *(optional)*: string | null - The callback URL where the Authorization Server sends the Authorization Code * **finalCallbackUrl** *(optional)*: string | null - Redirect URL after Aembit successfully completes OAuth authorization. Only available to Tenants which are entitled - contact Aembit support if you require this functionality. * **userAuthorizationUrl** *(optional)*: string | null - Authorization URL to be used for authorization of the Credential Provider by a privileged user * **state** *(optional)*: string | null - State parameter to maintain state between the authorization request and callback ### CPTypeOAuth2ClientCredentialsUIV2DTO **Extends:** CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider * **clientID** *(required)*: string - OAuth Client ID * **clientSecret** *(optional)*: string | null - OAuth Client Secret * **scope** *(optional)*: string | null - OAuth Scopes * **customParameters** *(optional)*: Array | null - Custom Claims that are added to the Access Token * **url** *(required)*: string - OAuth Token URL for handling token requests * **credentialStyle** *(optional)*: string | null - Defines how credential would be transmitted. Accepted value: ‘postBody’, ‘authHeader’ ### CPTypeOAuth2CustomParameters **Type:** object **Properties:** * **key** *(optional)*: string | null * **value** *(optional)*: string | null * **valueType** *(optional)*: string | null ### CPTypeOpenAiWifV2DTO **Extends:** CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider * **identityProviderId** *(required)*: string - Identity Provider ID * **serviceAccountId** *(required)*: string - Service Account ID * **audience** *(optional)*: string | null - Audience ### CPTypeUsernamePasswordUIV2DTO **Extends:** CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider * **username** *(required)*: string - Username * **password** *(required)*: string - Password. Set to null on updates if not wish to change it ### CPTypeVaultClientTokenV2DTO **Extends:** CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider * **issuer** *(required)*: string () - Issuer of the Access Token * **subject** *(required)*: string - Subject of the Access Token * **subjectType** *(optional)*: string | null - Subject type, Accepted values: ‘literal’, ‘dynamic’ * **lifetime** *(required)*: integer (int32) - Access Token(used for authentication against vault OIDC provider) Lifetime in seconds * **customClaimNames** *(optional)*: Array | null - Custom Claims that are added to the Access Token * **vaultHost** *(required)*: string - Vault host * **tls** *(optional)*: boolean - Tls enabled/disabled when connecting to the vault instance * **port** *(required)*: integer (int32) - Port number for connecting to the vault instance * **authenticationPath** *(required)*: string - Vault authentication path * **namespace** *(optional)*: string | null - Namespace to be used when connecting to the vault instance * **role** *(optional)*: string | null - User role to be used when connecting to the vault instance * **forwardingConfig** *(optional)*: string | null - Forwarding configuration for the vault request. Accepted values: ”, ‘conditional’, ‘unconditional’ * **privateNetworkAccess** *(optional)*: boolean - Specifies whether the Vault instance is accessible over a private network ### ClientIdentifierExternalDTO **Type:** object **Properties:** * **name** *(optional)*: string | null * **displayName** *(optional)*: string | null * **environmentPath** *(optional)*: string | null * **isSupported** *(optional)*: boolean ### ClientRequestDTO **Type:** object **Properties:** * **version** *(required)*: string * **network** *(required)*: NetworkDTO ### ClientWorkloadExternalDTO **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **identities** *(optional)*: Array | null * **standaloneCertificateAuthority** *(optional)*: string (uuid) | null - Standalone Certificate Authority associated with this Client Workload * **enforceSso** *(optional)*: boolean - Whether SSO is enforced for MCP authorization * **type** *(optional)*: string | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Client Workload * **ssoIdentityProviders** *(optional)*: Array\ | null ### ClientWorkloadIdentityDTO **Type:** object **Properties:** * **type** *(optional)*: string | null * **value** *(required)*: string * **key** *(optional)*: string | null ### ClientWorkloadListDTO Page of Client Workloads **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) * **recordsTotal** *(optional)*: integer (int32) * **clientWorkloads** *(optional)*: Array | null ### ClientWorkloadPatchDTO **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity * **identities** *(optional)*: Array | null ### ContentSecurityDTO Individual Content Security **Type:** object **Properties:** * **type** *(required)*: string - Content Security Type * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Content Security ### ContentSecurityDTOListDTO **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Current page number of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP StatusCode for the current result * **recordsTotal** *(optional)*: integer (int32) - Total number of entities available * **entities** *(optional)*: Array\ | null - Page of entities for this request ### ContentSecurityPatchDTO Patch request for an individual Content Security **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity ### CreatePolicyDTO Create/Update Access Policy **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **credentialProviders** *(optional)*: Array | null - Credential Providers associated with this Access Policy * **trustProviders** *(optional)*: Array\ | null - Trust Providers associated with this Access Policy * **accessConditions** *(optional)*: Array\ | null - Access Conditions associated with this Access Policy * **contentSecurity** *(optional)*: Array\ | null - Content Security associated with this Access Policy * **clientWorkload** *(optional)*: string (uuid) - Client Workload associated with this Access Policy * **serverWorkload** *(optional)*: string (uuid) - Server Workload associated with this Access Policy ### CredentialProviderDTO Individual Credential Provider **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **type** *(required)*: string - Credential Provider Type (e.g. oauth-client-credential, username-password, etc.) * **roleId** *(optional)*: string (uuid) | null - Credential Provider Role for use with Aembit Access Token type Credential Providers * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) - The Lifetime of a Credential Provider’s credential value * **lifetimeExpiration** *(optional)*: string (date-time) | null - The expiration timestamp for a Credential Provider’s credential value * **providerDetailJSON** *(optional)*: string | null - JSON representation of the Credential Provider configuration details * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider ### CredentialProviderIntegrationDTO Individual Credential Provider Integration **Type:** object **Properties:** * **type** *(required)*: CredentialProviderIntegrationType * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **tokenExpiration** *(optional)*: string (date-time) | null * **lastOperationTimestamp** *(optional)*: string (date-time) | null * **status** *(optional)*: string | null * **errorMessage** *(optional)*: string | null ### CredentialProviderIntegrationPatchDTO Patch Request for an individual Credential Provider Integration **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity ### CredentialProviderIntegrationType **Type:** string **Possible values:** `GitLab`, `AwsIamRole`, `AzureEntraFederation` ### CredentialProviderPatchDTO Patch request for an individual Credential Provider **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity * **providerDetailJSON** *(optional)*: string | null - JSON representation of the Credential Provider configuration details * **type** *(optional)*: string | null - Credential Provider Type (e.g. oauth-client-credential, username-password, etc.) ### CredentialProviderUIDTO Individual Credential Provider **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **type** *(required)*: string - Credential Provider Type (e.g. oauth-client-credential, username-password, etc.) * **roleId** *(optional)*: string (uuid) | null - Credential Provider Role for use with Aembit Access Token type Credential Providers * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) - The Lifetime of a Credential Provider’s credential value * **lifetimeExpiration** *(optional)*: string (date-time) | null - The expiration timestamp for a Credential Provider’s credential value * **providerDetailJSON** *(optional)*: string | null - JSON representation of the Credential Provider configuration details * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider ### CredentialProviderUIDTOCredentialProviderListDTO Page of Credential Providers **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP Status Code of the response * **recordsTotal** *(optional)*: integer (int32) - Total number of Credential Providers * **credentialProviders** *(optional)*: Array | null - Page of Credential Providers ### CredentialProviderV2DTO **Type:** object **Properties:** * **type** *(required)*: string * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **lifetimeTimeSpanSeconds** *(optional)*: integer (int32) * **lifetimeExpiration** *(optional)*: string (date-time) | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Credential Provider ### CredentialProviderV2DTOCredentialProviderListDTO Page of Credential Providers **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP Status Code of the response * **recordsTotal** *(optional)*: integer (int32) - Total number of Credential Providers * **credentialProviders** *(optional)*: Array\ | null - Page of Credential Providers ### CrowdStrikeAIDRContentSecurityDTO Individual Content Security **Extends:** ContentSecurityDTO **Type:** object **Properties:** * **type** *(required)*: string - Content Security Type * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Content Security * **encryptedToken** *(optional)*: string | null - The encrypted API token or client secret used to authenticate with the CrowdStrike Falcon AIDR (AI Detection and Response) service. * **baseUrl** *(required)*: string - The base URL of the CrowdStrike Falcon AIDR service endpoint or API gateway. * **failOpen** *(optional)*: boolean - Indicates whether requests should be allowed (fail-open) or blocked (fail-closed) if the CrowdStrike Falcon AIDR service is unreachable or encounters an error. * **timeoutMs** *(optional)*: integer (int32) - The connection timeout in milliseconds for requests sent to the CrowdStrike Falcon AIDR service. * **maxRetries** *(optional)*: integer (int32) - The maximum number of retry attempts for requests to the CrowdStrike Falcon AIDR service before executing the fail-open or fail-closed policy. ### CrowdStrikeAccessConditionDTO **Extends:** AccessConditionV2DTO **Type:** object **Properties:** * **integrationType** *(required)*: string | null * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **integrationID** *(optional)*: string (uuid) - ID of the Integration Entity used by this Access Condition * **integration** *(optional)*: IntegrationV2DTO | CrowdStrikeIntegrationDTO | WizIntegrationDTO | GeoIPIntegrationDTO | TimeIntegrationDTO | null - Integration Entity used by this Access Condition * **maxLastSeenSeconds** *(optional)*: integer (int32) * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Access Condition * **matchLocalIP** *(optional)*: boolean * **matchHostname** *(optional)*: boolean * **matchMacAddress** *(optional)*: boolean * **matchSerialNumber** *(optional)*: boolean * **preventRestrictedFunctionalityMode** *(optional)*: boolean ### CrowdStrikeIntegrationDTO Integration details for 3rd party data used by Access Conditions **Extends:** IntegrationV2DTO **Type:** object **Properties:** * **integrationType** *(required)*: string | null * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **type** *(required)*: string * **syncFrequencySeconds** *(required)*: integer (int32) * **lastSync** *(optional)*: string (date-time) | null * **lastSyncStatus** *(optional)*: string | null * **endpoint** *(required)*: string * **accessConditionsCount** *(optional)*: integer (int32) * **clientId** *(optional)*: string | null * **tokenUrl** *(optional)*: string | null * **clientSecret** *(optional)*: string | null * **audience** *(optional)*: string | null ### DiscoveryIntegrationDTO Integration details for 3rd party data used by Discovery **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **type** *(required)*: string * **syncFrequencySeconds** *(required)*: integer (int32) * **lastSync** *(optional)*: string (date-time) | null * **lastSyncStatus** *(optional)*: string | null * **endpoint** *(required)*: string * **discoveryIntegrationJSON** *(required)*: string ### DiscoveryIntegrationListDTO Page of Integrations **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP Status Code of the response * **recordsTotal** *(optional)*: integer (int32) - Total number of Integrations * **integrations** *(optional)*: Array | null - Page of Integrations ### DiscoveryIntegrationPatchDTO Patch request for an individual Integration **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity ### EntityMetaDTO **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(optional)*: string | null * **isActive** *(optional)*: boolean * **tags** *(optional)*: Array | null ### EntityPatchDTO **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity ### EventDTO **Type:** object **Properties:** * **meta** *(optional)*: EventMetaDTO * **network** *(optional)*: EventNetworkDTO * **outcome** *(optional)*: EventOutcomeDTO ### EventListDTO **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) * **recordsTotal** *(optional)*: integer (int32) * **workloadEvents** *(optional)*: Array | null ### EventMetaDTO **Type:** object **Properties:** * **timestamp** *(optional)*: string (date-time) * **eventType** *(optional)*: string | null * **eventId** *(optional)*: string | null * **resourceSetId** *(optional)*: string (uuid) * **policyId** *(optional)*: string | null * **action** *(optional)*: string | null * **connectionId** *(optional)*: string | null * **severity** *(optional)*: string | null ### EventNetworkDTO **Type:** object **Properties:** * **clientWorkloadIP** *(optional)*: string | null * **clientWorkloadPort** *(optional)*: integer (int32) * **serverWorkloadIP** *(optional)*: string | null * **serverWorkloadPort** *(optional)*: integer (int32) | null * **proxyPort** *(optional)*: integer (int32) | null ### EventOutcomeDTO **Type:** object **Properties:** * **result** *(optional)*: string | null ### EventResultDTO **Type:** object **Properties:** * **reason** *(optional)*: string | null * **attribute** *(optional)*: string | null * **expectedValue** *(optional)*: string | null * **actualValue** *(optional)*: string | null ### GenericResponseDTO DTO for a Generic API Response **Type:** object **Properties:** * **success** *(optional)*: boolean - True if the API call was successful, False otherwise * **message** *(optional)*: string | null - Message to indicate why the API call failed * **id** *(optional)*: integer (int32) - Unique identifier of the API response ### GeoIPAccessConditionDTO **Extends:** AccessConditionV2DTO **Type:** object **Properties:** * **integrationType** *(required)*: string | null * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **integrationID** *(optional)*: string (uuid) - ID of the Integration Entity used by this Access Condition * **integration** *(optional)*: IntegrationV2DTO | CrowdStrikeIntegrationDTO | WizIntegrationDTO | GeoIPIntegrationDTO | TimeIntegrationDTO | null - Integration Entity used by this Access Condition * **maxLastSeenSeconds** *(optional)*: integer (int32) * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Access Condition * **locations** *(optional)*: Array | null ### GeoIPAccessConditionLocationDTO **Type:** object **Properties:** * **id** *(optional)*: integer (int32) * **shortName** *(required)*: string * **alpha2Code** *(optional)*: string | null * **subdivisions** *(optional)*: Array | null * **geoIPAccessConditionId** *(optional)*: integer (int32) ### GeoIPAccessConditionSubdivisionDTO **Type:** object **Properties:** * **id** *(optional)*: integer (int32) * **name** *(required)*: string * **alpha2Code** *(optional)*: string | null * **subdivisionCode** *(optional)*: string | null * **geoIPAccessConditionLocationId** *(optional)*: integer (int32) ### GeoIPIntegrationDTO Integration details for 3rd party data used by Access Conditions **Extends:** IntegrationV2DTO **Type:** object **Properties:** * **integrationType** *(required)*: string | null * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **type** *(required)*: string * **syncFrequencySeconds** *(required)*: integer (int32) * **lastSync** *(optional)*: string (date-time) | null * **lastSyncStatus** *(optional)*: string | null * **endpoint** *(required)*: string * **accessConditionsCount** *(optional)*: integer (int32) ### GetPolicyDTO Individual Access Policy **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **clientWorkload** *(optional)*: EntityMetaDTO - Client Workload associated with this Access Policy * **serverWorkload** *(optional)*: EntityMetaDTO - Server Workload associated with this Access Policy * **trustProviders** *(optional)*: Array | null - Trust Providers associated with this Access Policy * **credentialProviders** *(optional)*: Array | null - Credential Providers associated with this Access Policy * **accessConditions** *(optional)*: Array | null - Access Conditions associated with this Access Policy * **contentSecurity** *(optional)*: Array | null - Content Security associated with this Access Policy ### GetPolicyDTOListDTO **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Current page number of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP StatusCode for the current result * **recordsTotal** *(optional)*: integer (int32) - Total number of entities available * **entities** *(optional)*: Array | null - Page of entities for this request ### GetSignInPolicyDTO **Type:** object **Properties:** * **ssoRequired** *(optional)*: boolean * **mfaRequired** *(optional)*: boolean ### GitLabCredentialProviderIntegrationDTO Individual Credential Provider Integration **Extends:** CredentialProviderIntegrationDTO **Type:** object **Properties:** * **type** *(required)*: CredentialProviderIntegrationType * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **tokenExpiration** *(optional)*: string (date-time) | null * **lastOperationTimestamp** *(optional)*: string (date-time) | null * **status** *(optional)*: string | null * **errorMessage** *(optional)*: string | null * **url** *(required)*: string * **userId** *(optional)*: string | null * **topLevelGroupId** *(optional)*: string | null * **personalAccessToken** *(optional)*: string | null ### GuidStringKeyValuePairDto **Type:** object **Properties:** * **key** *(optional)*: string (uuid) * **value** *(optional)*: string | null ### HealthDTO Aembit Health Status **Type:** object **Properties:** * **status** *(optional)*: string | null - Aembit Health Status * **version** *(optional)*: string | null - Aembit Cloud Version * **gitSHA** *(optional)*: string | null - Aembit Cloud Version Git SHA * **host** *(optional)*: string | null - Aembit Cloud Requested Hostname * **user** *(optional)*: string | null - Aembit Cloud Authenticated User Email * **userFullName** *(optional)*: string | null - Aembit Cloud Authenticated User Full Name * **tenant** *(optional)*: string | null - Aembit Cloud Tenant ID * **sessionExpiresAt** *(optional)*: string | null - Aembit Cloud Session Expiration ### IntegrationDTO Integration details for 3rd party data used by Access Conditions **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **type** *(required)*: string * **syncFrequencySeconds** *(required)*: integer (int32) * **lastSync** *(optional)*: string (date-time) | null * **lastSyncStatus** *(optional)*: string | null * **endpoint** *(required)*: string * **integrationJSON** *(required)*: object * **accessConditionsCount** *(optional)*: integer (int32) ### IntegrationDTOIntegrationListDTO Page of Integrations **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP Status Code of the response * **recordsTotal** *(optional)*: integer (int32) - Total number of Integrations * **integrations** *(optional)*: Array | null - Page of Integrations ### IntegrationPatchDTO Patch request for an individual Integration **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity ### IntegrationV2DTO Integration details for 3rd party data used by Access Conditions **Type:** object **Properties:** * **integrationType** *(required)*: string | null * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **type** *(required)*: string * **syncFrequencySeconds** *(required)*: integer (int32) * **lastSync** *(optional)*: string (date-time) | null * **lastSyncStatus** *(optional)*: string | null * **endpoint** *(required)*: string * **accessConditionsCount** *(optional)*: integer (int32) ### IntegrationV2DTOIntegrationListDTO Page of Integrations **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP Status Code of the response * **recordsTotal** *(optional)*: integer (int32) - Total number of Integrations * **integrations** *(optional)*: Array\ | null - Page of Integrations ### JWTClaimDTO **Type:** object **Properties:** * **key** *(optional)*: string | null * **value** *(optional)*: string | null * **valueType** *(optional)*: string | null ### JsonNode **Type:** object **Properties:** * **options** *(optional)*: JsonNodeOptions * **parent** *(optional)*: JsonNode * **root** *(optional)*: JsonNode ### JsonNodeOptions **Type:** object **Properties:** * **propertyNameCaseInsensitive** *(optional)*: boolean ### ListCredentialProviderIntegrationDTO Page of Credential Provider Integrations **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **url** *(optional)*: string | null * **type** *(optional)*: CredentialProviderIntegrationType * **status** *(optional)*: string | null * **lastOperationTimestamp** *(optional)*: string (date-time) | null ### ListCredentialProviderIntegrationDTOListDTO **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Current page number of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP StatusCode for the current result * **recordsTotal** *(optional)*: integer (int32) - Total number of entities available * **entities** *(optional)*: Array | null - Page of entities for this request ### LogStreamAWSS3DestinationDTO Individual Log Stream **Extends:** LogStreamDTO **Type:** object **Properties:** * **type** *(required)*: LogStreamDestinationType - Log Stream Destination Type * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **id** *(optional)*: integer (int32) * **dataType** *(required)*: string - Log Stream Data Type (e.g. AuditLogs, etc.) * **inProgTransactionCount** *(optional)*: integer (int32) - Log Stream In Progress Transaction Count * **completedTransactionCount** *(optional)*: integer (int32) - Log Stream Completed Transaction Count * **erroredTransactionCount** *(optional)*: integer (int32) - Log Stream Errored Transaction Count * **s3BucketRegion** *(required)*: string * **s3BucketName** *(required)*: string * **s3PathPrefix** *(optional)*: string | null ### LogStreamCrowdstrikeDestinationDTO Individual Log Stream **Extends:** LogStreamDTO **Type:** object **Properties:** * **type** *(required)*: LogStreamDestinationType - Log Stream Destination Type * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **id** *(optional)*: integer (int32) * **dataType** *(required)*: string - Log Stream Data Type (e.g. AuditLogs, etc.) * **inProgTransactionCount** *(optional)*: integer (int32) - Log Stream In Progress Transaction Count * **completedTransactionCount** *(optional)*: integer (int32) - Log Stream Completed Transaction Count * **erroredTransactionCount** *(optional)*: integer (int32) - Log Stream Errored Transaction Count * **hecHostPort** *(required)*: string * **apiKey** *(required)*: string * **hecSourceName** *(required)*: string * **tls** *(optional)*: boolean * **tlsVerification** *(optional)*: string | null ### LogStreamDTO Individual Log Stream **Type:** object **Properties:** * **type** *(required)*: LogStreamDestinationType - Log Stream Destination Type * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **id** *(optional)*: integer (int32) * **dataType** *(required)*: string - Log Stream Data Type (e.g. AuditLogs, etc.) * **inProgTransactionCount** *(optional)*: integer (int32) - Log Stream In Progress Transaction Count * **completedTransactionCount** *(optional)*: integer (int32) - Log Stream Completed Transaction Count * **erroredTransactionCount** *(optional)*: integer (int32) - Log Stream Errored Transaction Count ### LogStreamDestinationType **Type:** string **Possible values:** `AwsS3Bucket`, `GcsBucket`, `SplunkHttpEventCollector`, `CrowdstrikeHttpEventCollector` ### LogStreamGCSBucketDestinationDTO Individual Log Stream **Extends:** LogStreamDTO **Type:** object **Properties:** * **type** *(required)*: LogStreamDestinationType - Log Stream Destination Type * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **id** *(optional)*: integer (int32) * **dataType** *(required)*: string - Log Stream Data Type (e.g. AuditLogs, etc.) * **inProgTransactionCount** *(optional)*: integer (int32) - Log Stream In Progress Transaction Count * **completedTransactionCount** *(optional)*: integer (int32) - Log Stream Completed Transaction Count * **erroredTransactionCount** *(optional)*: integer (int32) - Log Stream Errored Transaction Count * **gcsBucketName** *(optional)*: string | null * **gcsPathPrefix** *(optional)*: string | null * **audience** *(optional)*: string | null * **serviceAccountEmail** *(optional)*: string | null * **tokenLifetime** *(optional)*: integer (int32) ### LogStreamListDTO Page of Log Streams **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP Status Code of the response * **recordsTotal** *(optional)*: integer (int32) - Total number of Log Streams * **logStreams** *(optional)*: Array\ | null - Page of Log Streams ### LogStreamPatchDTO Patch Request for an individual of Log Stream **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity ### LogStreamSplunkDestinationDTO Individual Log Stream **Extends:** LogStreamDTO **Type:** object **Properties:** * **type** *(required)*: LogStreamDestinationType - Log Stream Destination Type * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **id** *(optional)*: integer (int32) * **dataType** *(required)*: string - Log Stream Data Type (e.g. AuditLogs, etc.) * **inProgTransactionCount** *(optional)*: integer (int32) - Log Stream In Progress Transaction Count * **completedTransactionCount** *(optional)*: integer (int32) - Log Stream Completed Transaction Count * **erroredTransactionCount** *(optional)*: integer (int32) - Log Stream Errored Transaction Count * **hecHostPort** *(required)*: string * **authenticationToken** *(required)*: string * **hecSourceName** *(required)*: string * **tls** *(optional)*: boolean * **tlsVerification** *(optional)*: string | null ### MFASignInPolicyDTO **Type:** object **Properties:** * **mfaRequired** *(optional)*: boolean ### NetworkDTO **Type:** object **Properties:** * **sourceIP** *(required)*: string * **sourcePort** *(required)*: integer (int32) * **transportProtocol** *(required)*: string * **proxyPort** *(required)*: integer (int32) * **targetHost** *(optional)*: string | null * **targetPort** *(optional)*: integer (int32) ### OidcClientAuthType **Type:** string **Possible values:** `KeyPair`, `ClientSecret` ### OidcIdentityProviderDTO Individual SSO Identity Provider **Extends:** SSOIdentityProviderDTO **Type:** object **Properties:** * **type** *(required)*: string | null - Type of the remote SSO Identity Provider (e.g. SAMLv2 (default) or OIDCv1) * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **ssoStatementRoleMappings** *(optional)*: Array | null - Collection of mappings of SAML attributes to Aembit roles * **userAccessEnabled** *(optional)*: boolean - Whether user access via this Identity Provider is enabled * **oidcBaseURL** *(required)*: string * **clientId** *(required)*: string * **scopes** *(required)*: string * **authType** *(required)*: OidcClientAuthType * **clientSecret** *(optional)*: string | null * **pkceRequired** *(optional)*: boolean * **aembitRedirectUrl** *(optional)*: string | null * **aembitJwksUrl** *(optional)*: string | null ### PatchPolicyV2DTO Patch request for an Access Policy **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity * **clientWorkload** *(optional)*: string (uuid) - Client Workload associated with this Access Policy * **serverWorkload** *(optional)*: string (uuid) - Server Workload associated with this Access Policy * **credentialProviders** *(optional)*: Array | null - Credential Providers associated with this Access Policy * **trustProviders** *(optional)*: Array\ | null - Trust Providers associated with this Access Policy * **accessConditions** *(optional)*: Array\ | null - Access Conditions associated with this Access Policy * **contentSecurity** *(optional)*: Array\ | null - Content Security associated with this Access Policy ### PermissionDTO Individual Permission details **Type:** object **Properties:** * **name** *(optional)*: string | null - Name of the Permission Target * **read** *(optional)*: boolean - True if this permission allows access to Read the Permission Target, False otherwise * **write** *(optional)*: boolean - True if this permission allows access to Write the Permission Target, False otherwise * **isWritable** *(optional)*: boolean - True if this permission allows access to Write the Permission Target, False otherwise * **isReadable** *(optional)*: boolean - True if this permission allows access to Read the Permission Target, False otherwise * **accessLevel** *(optional)*: string | null - Description of the Permission level ### PolicyCredentialMappingDTO Access Policy Credential Mappings **Type:** object **Properties:** * **credentialProviderId** *(required)*: string (uuid) - CredentialProviderId * **mappingType** *(required)*: PolicyCredentialProviderMappingTypes - Mapping Type * **accessKeyId** *(optional)*: string | null - AWS Access Key Id * **accountName** *(optional)*: string | null - Snowflake Username * **headerName** *(optional)*: string | null - Header Name * **headerValue** *(optional)*: string | null - Header Value * **httpbodyFieldPath** *(optional)*: string | null - HttpBody Field Path * **httpbodyFieldValue** *(optional)*: string | null - HttpBody Field Value ### PolicyCredentialProviderMappingTypes **Type:** string **Possible values:** `None`, `AccountName`, `HttpHeader`, `HttpBody`, `AccessKeyId` ### PolicyDTO Individual Access Policy **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **credentialProvider** *(optional)*: string (uuid) | null - Credential Provider associated with this Access Policy * **trustProviders** *(optional)*: Array\ | null - Trust Providers associated with this Access Policy * **accessConditions** *(optional)*: Array\ | null - Access Conditions associated with this Access Policy * **contentSecurity** *(optional)*: Array\ | null - Content Security associated with this Access Policy * **clientWorkload** *(required)*: string (uuid) - Client Workload associated with this Access Policy * **serverWorkload** *(required)*: string (uuid) - Server Workload associated with this Access Policy * **clientWorkloadDetails** *(optional)*: WorkloadExternalDTO - Details of the Client Workload associated with this Access Policy * **serverWorkloadDetails** *(optional)*: WorkloadExternalDTO - Details of the Server Workload associated with this Access Policy * **policyNotes** *(optional)*: Array | null - Policy Notes for this Access Policy ### PolicyExternalDTO Individual Access Policy **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **clientWorkload** *(optional)*: ClientWorkloadExternalDTO - Details of the Client Workload associated with this Access Policy * **trustProviders** *(optional)*: Array | null - Details of the Trust Providers associated with this Access Policy * **accessConditions** *(optional)*: Array | null - Details of the Access Conditions associated with this Access Policy * **contentSecurity** *(optional)*: Array\ | null - Details of the Content Security associated with this Access Policy * **credentialProvider** *(optional)*: CredentialProviderDTO - Credential Provider associated with this Access Policy * **serverWorkload** *(optional)*: ServerWorkloadExternalDTO - Details of the Server Workload associated with this Access Policy * **policyNotes** *(optional)*: Array | null - Policy Notes for this Access Policy ### PolicyListDTO Page of Access Policies **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP Status Code of the response * **recordsTotal** *(optional)*: integer (int32) - Total number of Access Policies * **accessPolicies** *(optional)*: Array | null - Page of Access Policies ### PolicyNoteDTO Individual Note created for an Access Policy **Type:** object **Properties:** * **note** *(required)*: string - Note added to an Access Policy by a User * **createdAt** *(optional)*: string (date-time) - Timestamp the Note was created * **createdBy** *(optional)*: string | null - Email address of the User who created the Access Policy Note ### PolicyNoteDTOListDTO **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Current page number of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP StatusCode for the current result * **recordsTotal** *(optional)*: integer (int32) - Total number of entities available * **entities** *(optional)*: Array | null - Page of entities for this request ### PolicyPatchDTO Patch request for an Access Policy **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity * **clientWorkload** *(optional)*: string (uuid) - Client Workload associated with this Access Policy * **serverWorkload** *(optional)*: string (uuid) - Server Workload associated with this Access Policy * **credentialProvider** *(optional)*: string (uuid) | null - Credential Provider associated with this Access Policy * **trustProviders** *(optional)*: Array\ | null - Trust Providers associated with this Access Policy * **accessConditions** *(optional)*: Array\ | null - Access Conditions associated with this Access Policy * **contentSecurity** *(optional)*: Array\ | null - Content Security associated with this Access Policy ### PublicKeyValidationDTO Response to a request for Public Key Validation **Type:** object **Properties:** * **isValidContent** *(optional)*: boolean - True if the Public Key was valid, False otherwise * **thumbprint** *(optional)*: string | null - Thumbprint of the Public Key * **expirationDate** *(optional)*: string (date-time) | null - Expiration of the Public Key Certificate * **expirationDateString** *(optional)*: string | null - Expiration of the Public Key Certificate in String Format * **certificateSubject** *(optional)*: string | null - Subject of the Public Key Certificate * **serialNumber** *(optional)*: string | null - Serial Number of the Public Key Certificate * **message** *(optional)*: string | null - Message describing why the Public Key was not valid if IsValidContent is False * **pemType** *(optional)*: string | null - Certificate or Public Key ### RequestMetadaAembitDTO **Type:** object **Properties:** * **clientId** *(optional)*: string | null ### RequestMetadaAwsDTO **Type:** object **Properties:** * **accountId** *(optional)*: string | null * **instanceId** *(optional)*: string | null * **region** *(optional)*: string | null * **ecs** *(optional)*: RequestMetadaEcsDTO * **lambda** *(optional)*: RequestMetadaLambdaDTO ### RequestMetadaAzureDTO **Type:** object **Properties:** * **vmId** *(optional)*: string | null * **subscriptionId** *(optional)*: string | null ### RequestMetadaEcsDTO **Type:** object **Properties:** * **taskFamily** *(optional)*: string | null * **serviceName** *(optional)*: string | null ### RequestMetadaGcpDTO **Type:** object **Properties:** * **serviceAccount** *(optional)*: string | null ### RequestMetadaGithubDTO **Type:** object **Properties:** * **repository** *(optional)*: string | null * **subject** *(optional)*: string | null ### RequestMetadaGitlabDTO **Type:** object **Properties:** * **namespacePath** *(optional)*: string | null * **projectPath** *(optional)*: string | null * **refPath** *(optional)*: string | null * **subject** *(optional)*: string | null ### RequestMetadaHostDTO **Type:** object **Properties:** * **hostname** *(optional)*: string | null ### RequestMetadaKubernetesDTO **Type:** object **Properties:** * **namespace** *(optional)*: string | null * **podName** *(optional)*: string | null * **serviceAccountName** *(optional)*: string | null * **serviceAccountUID** *(optional)*: string | null ### RequestMetadaLambdaDTO **Type:** object **Properties:** * **arn** *(optional)*: string | null ### RequestMetadaNetworkDTO **Type:** object **Properties:** * **sourceIP** *(optional)*: string | null ### RequestMetadaOAuthDTO **Type:** object **Properties:** * **redirectUri** *(optional)*: string | null ### RequestMetadaProcessDTO **Type:** object **Properties:** * **name** *(optional)*: string | null * **userName** *(optional)*: string | null * **exePath** *(optional)*: string | null * **commandLine** *(optional)*: string | null ### RequestMetadaTerraformDTO **Type:** object **Properties:** * **workspaceId** *(optional)*: string | null * **organizationId** *(optional)*: string | null * **projectId** *(optional)*: string | null ### RequestMetadataOidcDTO **Type:** object **Properties:** * **sub** *(optional)*: string | null * **aud** *(optional)*: string | null * **iss** *(optional)*: string | null ### ResourceSetDTO Individual Resource Set **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **serverWorkloadCount** *(optional)*: integer (int32) | null - Server Workloads associated with this Resource Set * **clientWorkloadCount** *(optional)*: integer (int32) | null - Client Workloads associated with this Resource Set * **accessPolicyCount** *(optional)*: integer (int32) | null - Access Policies associated with this Resource Set * **trustProviderCount** *(optional)*: integer (int32) | null - Trust Providers associated with this Resource Set * **accessConditionCount** *(optional)*: integer (int32) | null - Access Conditions associated with this Resource Set * **credentialProviderCount** *(optional)*: integer (int32) | null - Credential Providers associated with this Resource Set * **roles** *(optional)*: Array\ | null - Roles associated with this Resource Set * **rolesDetails** *(optional)*: Array | null - Details of the Roles associated with this Resource Set * **users** *(optional)*: Array | null - Users associated with this Resource Set * **standaloneCertificateAuthority** *(optional)*: string (uuid) | null - Standalone Certificate Authority associated with this Resource Set ### ResourceSetDTOListDTO **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Current page number of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP StatusCode for the current result * **recordsTotal** *(optional)*: integer (int32) - Total number of entities available * **entities** *(optional)*: Array | null - Page of entities for this request ### ResourceSetPatchDTO Patch Request for an Individual Resource Set **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity ### RoleDTO Individual Role **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **usersCount** *(optional)*: integer (int32) - Number of Users associated with this Role * **credentialProvidersCount** *(optional)*: integer (int32) - Number of Credential Providers associated with this Role * **isSystem** *(optional)*: boolean - True if this is a system included Role (e.g. SuperAdmin or Auditor) * **permissions** *(optional)*: Array | null - Permissions assigned to this Role * **resourceSets** *(optional)*: Array | null - Resource Sets assigned to this Role ### RoleListDTO Page of Roles **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP Status Code of the response * **recordsTotal** *(optional)*: integer (int32) - Total number of Roles * **roles** *(optional)*: Array | null - Page of Roles ### RolePatchDTO Patch request for an individual Role **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity ### RoutingDTO Individual Routing **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSetId** *(required)*: string (uuid) - ID of the Resource Set related to routing * **proxyUrl** *(required)*: string - URL of the proxy. The format is http(s)://server:port ### RoutingDTOListDTO **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Current page number of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP StatusCode for the current result * **recordsTotal** *(optional)*: integer (int32) - Total number of entities available * **entities** *(optional)*: Array | null - Page of entities for this request ### RoutingPatchDTO Patch request for an individual Routing **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity ### SSOIdentityProviderDTO Individual SSO Identity Provider **Type:** object **Properties:** * **type** *(required)*: string - Type of the remote SSO Identity Provider (e.g. SAMLv2 (default) or OIDCv1) * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **ssoStatementRoleMappings** *(optional)*: Array | null - Collection of mappings of SAML attributes to Aembit roles * **userAccessEnabled** *(optional)*: boolean - Whether user access via this Identity Provider is enabled ### SSOIdentityProviderDTOListDTO **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Current page number of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP StatusCode for the current result * **recordsTotal** *(optional)*: integer (int32) - Total number of entities available * **entities** *(optional)*: Array\ | null - Page of entities for this request ### SSOIdentityProviderPatchDTO Patch request for an individual SSO Identity Provider **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity ### SSOSignInPolicyDTO **Type:** object **Properties:** * **ssoRequired** *(optional)*: boolean ### SamlIdentityProviderDTO Individual SSO Identity Provider **Extends:** SSOIdentityProviderDTO **Type:** object **Properties:** * **type** *(required)*: string - Type of the remote SSO Identity Provider (e.g. SAMLv2 (default) or OIDCv1) * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **ssoStatementRoleMappings** *(optional)*: Array | null - Collection of mappings of SAML attributes to Aembit roles * **userAccessEnabled** *(optional)*: boolean - Whether user access via this Identity Provider is enabled * **entityId** *(optional)*: string | null - SAML Entity ID of the remote SSO Identity Provider * **metadataUrl** *(optional)*: string | null - Metadata URL of the remote SSO Identity Provider * **metadataXml** *(optional)*: string | null - Metadata XML content of the remote SSO Identity Provider * **serviceProviderEntityId** *(optional)*: string | null * **serviceProviderSsoUrl** *(optional)*: string | null ### ServerWorkloadExternalDTO Individual Server Workload **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **serviceEndpoint** *(required)*: WorkloadServiceEndpointDTO - Service Endpoint of the Server Workload * **type** *(optional)*: string | null - Type of Server Workload * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Server Workload ### ServerWorkloadListDTO Page of Server Workloads **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) * **recordsTotal** *(optional)*: integer (int32) * **serverWorkloads** *(optional)*: Array | null ### SettingDTO **Type:** object **Properties:** * **name** *(required)*: string * **value** *(required)*: string ### SsoStatementRoleMappingDTO Represents a mapping of an SSO attribute to an Aembit role **Type:** object **Properties:** * **attributeName** *(optional)*: string | null - SSO Attribute name * **attributeValue** *(optional)*: string | null - SSO Attribute value * **roleExternalId** *(optional)*: string (uuid) - Aembit Role ID ### StandaloneCertificatePatchDTO Patch Request for an Individual Standalone Certificate Authority **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity * **leafLifetime** *(optional)*: integer (int32) | null ### StandaloneCertificateRequestDTO Individual Standalone Certificate Authority **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **leafLifetime** *(required)*: integer (int32) - Leaf certificate lifetime value for this Standalone Certificate Authority ### StandaloneCertificateResponseDTO Individual Standalone Certificate Authority **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **leafLifetime** *(required)*: integer (int32) - Leaf certificate lifetime value for this Standalone Certificate Authority * **notBefore** *(optional)*: string (date-time) - Not before value of the Root CA for this Standalone Certificate Authority * **notAfter** *(optional)*: string (date-time) - Not after value of the Root CA for this Standalone Certificate Authority * **clientWorkloadCount** *(optional)*: integer (int32) | null - Client Workloads associated with this Standalone Certificate Authority ### StandaloneCertificateResponseDTOListDTO **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Current page number of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP StatusCode for the current result * **recordsTotal** *(optional)*: integer (int32) - Total number of entities available * **entities** *(optional)*: Array | null - Page of entities for this request ### StringStringKeyValuePair **Type:** object **Properties:** * **key** *(optional)*: string | null * **value** *(optional)*: string | null ### TagDTO Aembit Entity Tag Details **Type:** object **Properties:** * **key** *(required)*: string - Tag Key * **value** *(required)*: string - Tag Key Value ### TimeAccessConditionDTO **Extends:** AccessConditionV2DTO **Type:** object **Properties:** * **integrationType** *(required)*: string | null * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **integrationID** *(optional)*: string (uuid) - ID of the Integration Entity used by this Access Condition * **integration** *(optional)*: IntegrationV2DTO | CrowdStrikeIntegrationDTO | WizIntegrationDTO | GeoIPIntegrationDTO | TimeIntegrationDTO | null - Integration Entity used by this Access Condition * **maxLastSeenSeconds** *(optional)*: integer (int32) * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Access Condition * **schedule** *(optional)*: Array | null * **timezone** *(optional)*: TimeAccessConditionTimezoneDTO ### TimeAccessConditionScheduleDTO **Type:** object **Properties:** * **startTime** *(optional)*: string (date-span) * **endTime** *(optional)*: string (date-span) * **weekDay** *(optional)*: WeekDayDTO ### TimeAccessConditionTimezoneDTO **Type:** object **Properties:** * **group** *(optional)*: string | null * **label** *(optional)*: string | null * **timezone** *(optional)*: string | null ### TimeIntegrationDTO Integration details for 3rd party data used by Access Conditions **Extends:** IntegrationV2DTO **Type:** object **Properties:** * **integrationType** *(required)*: string | null * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **type** *(required)*: string * **syncFrequencySeconds** *(required)*: integer (int32) * **lastSync** *(optional)*: string (date-time) | null * **lastSyncStatus** *(optional)*: string | null * **endpoint** *(required)*: string * **accessConditionsCount** *(optional)*: integer (int32) ### TrustProviderDTO Individual Trust Provider **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **id** *(optional)*: integer (int32) - Trust Provider Id * **provider** *(required)*: string - Trust Provider Type * **matchRules** *(optional)*: Array | null - Trust Provider Match Rules * **certificate** *(optional)*: string | null - Trust Provider Certificate or Public Key for cryptographic attestation * **jwks** *(optional)*: string | null - Jwks Content for cryptographic attestation * **publicKeyValidation** *(optional)*: PublicKeyValidationDTO - Response to a request for Public Key Validation * **oidcUrl** *(optional)*: string | null - OIDC URL to use for retrieving JWKS Public Keys * **pemType** *(optional)*: string | null - PEM Input Type * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Trust Provider * **agentControllersCount** *(optional)*: integer (int32) - Agent Controllers associated with this Trust Provider * **agentControllerIds** *(optional)*: Array\ | null - Agent Controller IDs associated with this Trust Provider * **isAembitTenantOidcToken** *(optional)*: boolean * **metadataUrl** *(optional)*: string | null - Metadata URL of the remote SSO Identity Provider * **metadataXml** *(optional)*: string | null - Metadata XML content of the remote SSO Identity Provider ### TrustProviderItemDTO **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(optional)*: string | null ### TrustProviderListDTO Page of Trust Providers **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP Status Code of the response * **recordsTotal** *(optional)*: integer (int32) - Total number of Trust Providers * **trustProviders** *(optional)*: Array | null - Page of Trust Providers ### TrustProviderMatchRuleDTO Individual Match Rule to enforce during Trust Provider attestation **Type:** object **Properties:** * **attribute** *(required)*: string - Match Rule Attribute * **value** *(required)*: string - Match Rule Attribute Value * **key** *(optional)*: string | null - Match Rule Attribute Key ### TrustProviderPatchDTO Patch request for an individual Trust Provider **Type:** object **Properties:** * **name** *(optional)*: string | null - New Name for the identified entity * **description** *(optional)*: string | null - New Description for the identified entity * **isActive** *(optional)*: boolean (boolean) | null - New Status for the identified entity * **tags** *(optional)*: Array | null - New Tags for the identified entity * **provider** *(optional)*: string | null - Trust Provider Type * **matchRules** *(optional)*: Array | null - Trust Provider Match Rules * **oidcUrl** *(optional)*: string | null - OIDC URL to use for retrieving JWKS Public Keys * **pemType** *(optional)*: string | null - PEM Input Type * **certificate** *(optional)*: string | null - Trust Provider Certificate or Public Key for cryptographic attestation * **jwks** *(optional)*: string | null - Jwks Content for cryptographic attestation * **symmetricKey** *(optional)*: string | null - Symmetric Key * **publicKeyValidation** *(optional)*: PublicKeyValidationDTO - Response to a request for Public Key Validation * **metadataUrl** *(optional)*: string | null - Metadata URL of the remote SSO Identity Provider * **metadataXml** *(optional)*: string | null - Metadata XML content of the remote SSO Identity Provider ### TrustProviderSecretDTO **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(optional)*: string | null * **type** *(optional)*: string | null * **subject** *(optional)*: string | null * **expiresAt** *(optional)*: string (date-time) | null ### TrustProviderSecretDTOListDTO **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Current page number of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) - HTTP StatusCode for the current result * **recordsTotal** *(optional)*: integer (int32) - Total number of entities available * **entities** *(optional)*: Array | null - Page of entities for this request ### TrustProviderSecretSlimDTO **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **secret** *(required)*: string * **type** *(optional)*: TrustProviderSecretType ### TrustProviderSecretType **Type:** string **Possible values:** `Certificate`, `SymmetricKey` ### UserAgentDTO DTO for the HTTP User Agent of an individual Aembit Audit Log **Type:** object **Properties:** * **browser** *(optional)*: string | null - The browser as determined from the HTTP User Agent * **operatingSystem** *(optional)*: string | null - The operating system as determined from the HTTP User Agent * **raw** *(optional)*: string | null - The raw HTTP User Agent ### UserDTO **Type:** object **Properties:** * **email** *(required)*: string (email) * **externalId** *(optional)*: string (uuid) * **roles** *(optional)*: Array\ | null * **rolesDetails** *(optional)*: Array | null * **firstName** *(required)*: string * **lastName** *(required)*: string * **phoneNumber** *(optional)*: string | null * **createdAt** *(optional)*: string (date-time) * **isActive** *(optional)*: boolean * **twoFactorEnabled** *(optional)*: boolean * **isLocked** *(optional)*: boolean * **tags** *(optional)*: Array | null * **userTokens** *(optional)*: Array | null ### UserListDTO **Type:** object **Properties:** * **page** *(optional)*: integer (int32) - Page of entities * **perPage** *(optional)*: integer (int32) - Number of entities requested for the current page * **order** *(optional)*: string | null - Ordering criteria used for the current page * **statusCode** *(optional)*: integer (int32) * **recordsTotal** *(optional)*: integer (int32) * **users** *(optional)*: Array | null ### UserPatchDTO **Type:** object **Properties:** * **email** *(optional)*: string | null * **firstName** *(optional)*: string | null * **lastName** *(optional)*: string | null * **phoneNumber** *(optional)*: string | null * **isActive** *(optional)*: boolean | null ### UserTokensDTO **Type:** object **Properties:** * **id** *(optional)*: string (uuid) * **name** *(optional)*: string | null * **verified** *(optional)*: boolean * **createdAt** *(optional)*: string (date-time) ### WeekDayDTO **Type:** object **Properties:** * **name** *(optional)*: string | null * **ordinal** *(optional)*: integer (int32) ### WizAccessConditionDTO **Extends:** AccessConditionV2DTO **Type:** object **Properties:** * **integrationType** *(required)*: string | null * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **integrationID** *(optional)*: string (uuid) - ID of the Integration Entity used by this Access Condition * **integration** *(optional)*: IntegrationV2DTO | CrowdStrikeIntegrationDTO | WizIntegrationDTO | GeoIPIntegrationDTO | TimeIntegrationDTO | null - Integration Entity used by this Access Condition * **maxLastSeenSeconds** *(optional)*: integer (int32) * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Access Condition * **serverless** *(optional)*: boolean * **containerClusterConnected** *(optional)*: boolean ### WizIntegrationDTO Integration details for 3rd party data used by Access Conditions **Extends:** IntegrationV2DTO **Type:** object **Properties:** * **integrationType** *(required)*: string | null * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **type** *(required)*: string * **syncFrequencySeconds** *(required)*: integer (int32) * **lastSync** *(optional)*: string (date-time) | null * **lastSyncStatus** *(optional)*: string | null * **endpoint** *(required)*: string * **accessConditionsCount** *(optional)*: integer (int32) * **clientId** *(optional)*: string | null * **tokenUrl** *(optional)*: string | null * **clientSecret** *(optional)*: string | null * **audience** *(optional)*: string | null ### WorkloadExternalDTO **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(required)*: string - Name of the Entity * **description** *(optional)*: string | null - Description of the Entity * **isActive** *(required)*: boolean (boolean) - True/False value that determines if this entity is Active or Disabled * **tags** *(optional)*: Array | null * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **resourceSet** *(required)*: string (uuid) - ID of the Resource Set in which this Access Entity exists * **trustProviders** *(optional)*: Array | null * **credentialProviderId** *(optional)*: string (uuid) | null * **credentialProviderText** *(optional)*: string | null * **workloadServiceEndpoints** *(optional)*: Array\ | null * **serviceEndpoint** *(optional)*: WorkloadServiceEndpointDTO - Service Endpoint for a Server Workload * **type** *(optional)*: string | null ### WorkloadServiceAuthenticationDTO Authentication configuration for a Server Workload **Type:** object **Properties:** * **method** *(required)*: string - Authentication Method * **scheme** *(required)*: string - Authentication Scheme * **config** *(optional)*: string | null - Authentication Configuration ### WorkloadServiceEndpointDTO Service Endpoint for a Server Workload **Type:** object **Properties:** * **externalId** *(optional)*: string | null - External ID of the Service Endpoint * **id** *(optional)*: integer (int32) - ID of the Service Endpoint * **host** *(required)*: string - Hostname or IP Address * **appProtocol** *(required)*: string - Application Protocol * **transportProtocol** *(required)*: string - Transport Protocol (e.g. TCP) * **requestedPort** *(required)*: integer (int32) - The target port as specified by the Client Workload * **requestedTls** *(required)*: boolean - The TLS encryption configuration of the Client Workload * **port** *(required)*: integer (int32) - The target port to which the Agent/Proxy will communicate * **tls** *(required)*: boolean - The TLS encryption configuration which will be used by the Agent/Proxy * **workloadServiceAuthentication** *(optional)*: WorkloadServiceAuthenticationDTO - Authentication configuration * **tlsVerification** *(required)*: string - TLS Verification configuration for the Agent/Proxy to Server Workload connection * **urlPath** *(optional)*: string | null - URL Path configuration for the Client Workload to Server Workload request * **httpHeaders** *(optional)*: Array | null - Static HTTP Headers to include for transmission to the Server Workload