Cloud-API-Guide-Full: step-by-step tutorial for how to build a new project # Aembit.API - Full Reference > Complete API reference including endpoints and schemas for Aembit.API # Aembit.API [Section titled “Aembit.API”](#aembitapi) **Version:** v1 ## Base URL [Section titled “Base URL”](#base-url) https\://{tenant}.aembit.io *** # Aembit.API - API Endpoints [Section titled “Aembit.API - API Endpoints”](#aembitapi---api-endpoints) **Version:** v1 **Base URL:** https\://{tenant}.aembit.io ## Access Condition [Section titled “Access Condition”](#access-condition) ### GET /api/v1/access-conditions [Section titled “GET /api/v1/access-conditions”](#get-apiv1access-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** (undefined) *(optional)*: any * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Access Conditions * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/access-conditions" ``` ### POST /api/v1/access-conditions [Section titled “POST /api/v1/access-conditions”](#post-apiv1access-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** (undefined) *(optional)*: any **Request Body:** AccessConditionDTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Successfully created Access Condition * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/access-conditions" ``` ### PUT /api/v1/access-conditions [Section titled “PUT /api/v1/access-conditions”](#put-apiv1access-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** (undefined) *(optional)*: any **Request Body:** AccessConditionDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Successfully updated Access Condition * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/access-conditions" ``` ### GET ‘/api/v1/access-conditions/{id}’ [Section titled “GET ‘/api/v1/access-conditions/{id}’”](#get-apiv1access-conditionsid) **Summary:** Get the identified Access Condition **Description:** Get the Access Condition identified by its ID. **Operation ID:** get-access-condition **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Access Condition * Content-Type: application/json * Schema: any * **‘204’**: Access Condition Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/access-conditions/{id}'" ``` ### DELETE ‘/api/v1/access-conditions/{id}’ [Section titled “DELETE ‘/api/v1/access-conditions/{id}’”](#delete-apiv1access-conditionsid) **Summary:** Delete a single Access Condition **Description:** Delete a specific Access Condition identified by its ID. **Operation ID:** delete-access-condition **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘204’**: Deleted the Access Condition * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘404’**: Not Found * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/access-conditions/{id}'" ``` ### PATCH ‘/api/v1/access-conditions/{id}’ [Section titled “PATCH ‘/api/v1/access-conditions/{id}’”](#patch-apiv1access-conditionsid) **Summary:** Patch a single Access Condition **Description:** Patch a specific Access Condition identified by its ID. **Operation ID:** patch-access-condition **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** AccessConditionPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Successfully updated Access Condition * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io'/api/v1/access-conditions/{id}'" ``` ## Access Policy (Deprecated) [Section titled “Access Policy (Deprecated)”](#access-policy-deprecated) ### GET ‘/api/v1/access-policies/{id}’ [Section titled “GET ‘/api/v1/access-policies/{id}’”](#get-apiv1access-policiesid) **Summary:** Get the identified Access Policy **Description:** Get the Access Policy identified by its ID. **Operation ID:** get-access-policy **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Access Policy * Content-Type: application/json * Schema: any * **‘204’**: Access Policy Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/access-policies/{id}'" ``` ### DELETE ‘/api/v1/access-policies/{id}’ [Section titled “DELETE ‘/api/v1/access-policies/{id}’”](#delete-apiv1access-policiesid) **Summary:** Delete an Access Policy **Description:** Delete an Access Policy. **Operation ID:** delete-access-policy **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘204’**: Deleted the Access Policy * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/access-policies/{id}'" ``` ### PATCH ‘/api/v1/access-policies/{id}’ [Section titled “PATCH ‘/api/v1/access-policies/{id}’”](#patch-apiv1access-policiesid) **Summary:** Patch an Access Policy **Description:** Patch an Access Policy. **Operation ID:** patch-access-policy **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** PolicyPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched Access Policy * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PATCH \ -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}’ [Section titled “GET ‘/api/v1/access-policies/getByWorkloadIds/{clientWorkloadId}/{serverWorkloadId}’”](#get-apiv1access-policiesgetbyworkloadidsclientworkloadidserverworkloadid) **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** (undefined) *(optional)*: any * **serverWorkloadId** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Access Policy * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/access-policies/getByWorkloadIds/{clientWorkloadId}/{serverWorkloadId}'" ``` ### GET /api/v1/access-policies [Section titled “GET /api/v1/access-policies”](#get-apiv1access-policies) **Summary:** Get a page of Access Policies **Description:** Retrieve a page of Access Policies. **Operation ID:** get-access-policies **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Access Policies * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/access-policies" ``` ### POST /api/v1/access-policies [Section titled “POST /api/v1/access-policies”](#post-apiv1access-policies) **Summary:** Create an Access Policy **Description:** Create an Access Policy. **Operation ID:** post-access-policy **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** PolicyDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Created Access Policy * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/access-policies" ``` ### PUT /api/v1/access-policies [Section titled “PUT /api/v1/access-policies”](#put-apiv1access-policies) **Summary:** Update an Access Policy **Description:** Update an Access Policy. **Operation ID:** put-access-policy **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** PolicyDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Updated Access Policy * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/access-policies" ``` ### POST ‘/api/v1/access-policies/{id}/notes’ [Section titled “POST ‘/api/v1/access-policies/{id}/notes’”](#post-apiv1access-policiesidnotes) **Summary:** Add a note to an Access Policy **Description:** Add a note to an Access Policy. **Operation ID:** post-access-policy-note **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** PolicyNoteDTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Note added to an Access Policy * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io'/api/v1/access-policies/{id}/notes'" ``` ## Access Policy v2 [Section titled “Access Policy v2”](#access-policy-v2) ### GET ‘/api/v2/access-policies/{id}’ [Section titled “GET ‘/api/v2/access-policies/{id}’”](#get-apiv2access-policiesid) **Summary:** Get the identified Access Policy **Description:** Get the Access Policy identified by its ID. **Operation ID:** get-access-policy-v2 **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘200’**: Access Policy * Content-Type: application/json * Schema: any * **‘204’**: Access Policy Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v2/access-policies/{id}'" ``` ### DELETE ‘/api/v2/access-policies/{id}’ [Section titled “DELETE ‘/api/v2/access-policies/{id}’”](#delete-apiv2access-policiesid) **Summary:** Delete an Access Policy **Description:** Delete an Access Policy. **Operation ID:** delete-access-policy-v2 **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘204’**: Deleted the Access Policy * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘404’**: Not Found * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v2/access-policies/{id}'" ``` ### PATCH ‘/api/v2/access-policies/{id}’ [Section titled “PATCH ‘/api/v2/access-policies/{id}’”](#patch-apiv2access-policiesid) **Summary:** Patch an Access Policy **Description:** Patch an Access Policy. **Operation ID:** patch-access-policy-v2 **Parameters:** * **id** (undefined) *(optional)*: any **Request Body:** PatchPolicyV2DTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched Access Policy * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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}’ [Section titled “GET ‘/api/v2/access-policies/getByWorkloadIds/{clientWorkloadId}/{serverWorkloadId}’”](#get-apiv2access-policiesgetbyworkloadidsclientworkloadidserverworkloadid) **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** (undefined) *(optional)*: any * **serverWorkloadId** (undefined) *(optional)*: any **Responses:** * **‘200’**: Access Policy * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v2/access-policies/getByWorkloadIds/{clientWorkloadId}/{serverWorkloadId}'" ``` ### GET /api/v2/access-policies [Section titled “GET /api/v2/access-policies”](#get-apiv2access-policies) **Summary:** Get a page of Access Policies **Description:** Retrieve a page of Access Policies. **Operation ID:** get-access-policies-v2 **Parameters:** * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Access Policies * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v2/access-policies" ``` ### POST /api/v2/access-policies [Section titled “POST /api/v2/access-policies”](#post-apiv2access-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: any **Responses:** * **‘200’**: Created Access Policy * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “PUT /api/v2/access-policies”](#put-apiv2access-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: any **Responses:** * **‘200’**: Updated Access Policy * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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’ [Section titled “POST ‘/api/v2/access-policies/{id}/notes’”](#post-apiv2access-policiesidnotes) **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** (undefined) *(optional)*: any **Request Body:** PolicyNoteDTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Note added to an Access Policy * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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’ [Section titled “GET ‘/api/v2/access-policies/{id}/notes’”](#get-apiv2access-policiesidnotes) **Summary:** Gets a notes of Access Policy **Description:** Retrieves notes of Access Policy. **Operation ID:** get-access-policy-notes-v2 **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Access Policy Notes * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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’ [Section titled “GET ‘/api/v2/access-policies/{id}/credential-mappings’”](#get-apiv2access-policiesidcredential-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** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Credential Mappings * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v2/access-policies/{id}/credential-mappings'" ``` ## Agent Controller [Section titled “Agent Controller”](#agent-controller) ### GET /api/v1/agent-controllers [Section titled “GET /api/v1/agent-controllers”](#get-apiv1agent-controllers) **Summary:** Get a page of Agent Controllers **Description:** Get a page of Agent Controllers. **Operation ID:** get-agent-controllers **Parameters:** * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any * **check-tls-type** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Agent Controllers * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/agent-controllers" ``` ### POST /api/v1/agent-controllers [Section titled “POST /api/v1/agent-controllers”](#post-apiv1agent-controllers) **Summary:** Create an Agent Controller **Description:** Create an Agent Controller. **Operation ID:** post-agent-controller **Request Body:** AgentControllerDTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Created Agent Controller * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “PUT /api/v1/agent-controllers”](#put-apiv1agent-controllers) **Summary:** Update an Agent Controller **Description:** Update an Agent Controller. **Operation ID:** put-agent-controller **Request Body:** AgentControllerDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Updated Agent Controller * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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}’ [Section titled “GET ‘/api/v1/agent-controllers/{id}’”](#get-apiv1agent-controllersid) **Summary:** Get an Agent Controller **Description:** Get an Agent Controller identified by its ID. **Operation ID:** get-agent-controller **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘200’**: Agent Controller * Content-Type: application/json * Schema: any * **‘204’**: Agent Controller Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/agent-controllers/{id}'" ``` ### PATCH ‘/api/v1/agent-controllers/{id}’ [Section titled “PATCH ‘/api/v1/agent-controllers/{id}’”](#patch-apiv1agent-controllersid) **Summary:** Patch an Agent Controller **Description:** Patch an Agent Controller identified by its ID. **Operation ID:** patch-agent-controller **Parameters:** * **id** (undefined) *(optional)*: any **Request Body:** AgentControllerPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched Agent Controller * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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}’ [Section titled “DELETE ‘/api/v1/agent-controllers/{id}’”](#delete-apiv1agent-controllersid) **Summary:** Delete an Agent Controller **Description:** Delete an Agent Controller identified by its ID. **Operation ID:** delete-agent-controller **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘201’**: Successfully deleted Agent Controller * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/agent-controllers/{id}'" ``` ### POST ‘/api/v1/agent-controllers/{agentControllerExternalId}/device-code’ [Section titled “POST ‘/api/v1/agent-controllers/{agentControllerExternalId}/device-code’”](#post-apiv1agent-controllersagentcontrollerexternaliddevice-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** (undefined) *(optional)*: any **Responses:** * **‘201’**: Agent Controller Device Code * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X POST \ "https://your-tenant.aembit.io'/api/v1/agent-controllers/{agentControllerExternalId}/device-code'" ``` ## Audit Log [Section titled “Audit Log”](#audit-log) ### GET /api/v1/audit-logs [Section titled “GET /api/v1/audit-logs”](#get-apiv1audit-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** (undefined) *(optional)*: any * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **search** (undefined) *(optional)*: any * **span-last-days** (undefined) *(optional)*: any * **category** (undefined) *(optional)*: any * **severity** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Audit Logs * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/audit-logs" ``` ### GET ‘/api/v1/audit-logs/{id}’ [Section titled “GET ‘/api/v1/audit-logs/{id}’”](#get-apiv1audit-logsid) **Summary:** Get an Audit Log event **Description:** Get an Audit Log event identified by its ID. **Operation ID:** get-audit-log **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Audit Log * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/audit-logs/{id}'" ``` ## Access Authorization Event [Section titled “Access Authorization Event”](#access-authorization-event) ### GET /api/v1/authorization-events [Section titled “GET /api/v1/authorization-events”](#get-apiv1authorization-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** (undefined) *(optional)*: any * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **search** (undefined) *(optional)*: any * **span-last-hours** (undefined) *(optional)*: any * **severity** (undefined) *(optional)*: any * **event-type** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Access Authorization Events * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/authorization-events" ``` ### GET ‘/api/v1/authorization-events/{id}’ [Section titled “GET ‘/api/v1/authorization-events/{id}’”](#get-apiv1authorization-eventsid) **Summary:** Get an Access Authorization Event **Description:** Get an Access Authorization Event identified by its ID. **Operation ID:** get-access-authorization-event **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Access Authorization Event * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/authorization-events/{id}'" ``` ## Credential Provider (Deprecated) [Section titled “Credential Provider (Deprecated)”](#credential-provider-deprecated) ### GET ‘/api/v1/credential-providers/{id}’ [Section titled “GET ‘/api/v1/credential-providers/{id}’”](#get-apiv1credential-providersid) **Summary:** Get a Credential Provider **Description:** Get a Credential Provider identified by its ID. **Operation ID:** get-credential-provider **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Credential Provider * Content-Type: application/json * Schema: any * **‘204’**: Credential Provider Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/credential-providers/{id}'" ``` ### DELETE ‘/api/v1/credential-providers/{id}’ [Section titled “DELETE ‘/api/v1/credential-providers/{id}’”](#delete-apiv1credential-providersid) **Summary:** Delete a Credential Provider **Description:** Delete a Credential Provider identified by its ID. **Operation ID:** delete-credential-provider **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘204’**: Deleted Credential Provider * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/credential-providers/{id}'" ``` ### PATCH ‘/api/v1/credential-providers/{id}’ [Section titled “PATCH ‘/api/v1/credential-providers/{id}’”](#patch-apiv1credential-providersid) **Summary:** Patch a Credential Provider **Description:** Patch a Credential Provider. **Operation ID:** patch-credential-provider **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** CredentialProviderPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Patched Credential Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PATCH \ -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’ [Section titled “GET ‘/api/v1/credential-providers/{id}/authorize’”](#get-apiv1credential-providersidauthorize) **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** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘302’**: Redirects to the Credential Provider Authorization URL * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/credential-providers/{id}/authorize'" ``` ### GET /api/v1/credential-providers [Section titled “GET /api/v1/credential-providers”](#get-apiv1credential-providers) **Summary:** Get a page of Credential Providers **Description:** Get a page of Credential Providers. **Operation ID:** get-credential-providers **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Credential Providers * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/credential-providers" ``` ### POST /api/v1/credential-providers [Section titled “POST /api/v1/credential-providers”](#post-apiv1credential-providers) **Summary:** Create a Credential Provider **Description:** Create a Credential Provider. **Operation ID:** post-credential-provider **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** CredentialProviderDTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Created Credential Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/credential-providers" ``` ### PUT /api/v1/credential-providers [Section titled “PUT /api/v1/credential-providers”](#put-apiv1credential-providers) **Summary:** Update a Credential Provider **Description:** Update a Credential Provider. **Operation ID:** put-credential-provider **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** CredentialProviderDTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Updated Credential Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/credential-providers" ``` ### GET ‘/api/v1/credential-providers/{id}/verification’ [Section titled “GET ‘/api/v1/credential-providers/{id}/verification’”](#get-apiv1credential-providersidverification) **Summary:** Verify the Credential Provider **Description:** Verify the Credential Provider will successfully return a credential. **Operation ID:** get-credential-provider-verification **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Details on the verification of a Credential Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/credential-providers/{id}/verification'" ``` ## Credential Provider Integration [Section titled “Credential Provider Integration”](#credential-provider-integration) ### GET ‘/api/v1/credential-integrations/{id}’ [Section titled “GET ‘/api/v1/credential-integrations/{id}’”](#get-apiv1credential-integrationsid) **Summary:** Get a Credential Provider Integration **Description:** Get a Credential Provider Integration identified by its ID. **Operation ID:** get-credential-provider-integration **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘200’**: Credential Provider Integration * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/credential-integrations/{id}'" ``` ### DELETE ‘/api/v1/credential-integrations/{id}’ [Section titled “DELETE ‘/api/v1/credential-integrations/{id}’”](#delete-apiv1credential-integrationsid) **Summary:** Delete a Credential Provider Integration **Description:** Delete a Credential Provider Integration identified by its ID. **Operation ID:** delete-credential-provider-integration **Parameters:** * **id** (undefined) *(optional)*: any **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: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/credential-integrations/{id}'" ``` ### PATCH ‘/api/v1/credential-integrations/{id}’ [Section titled “PATCH ‘/api/v1/credential-integrations/{id}’”](#patch-apiv1credential-integrationsid) **Summary:** Patch a Credential Provider Integration **Description:** Patch a Credential Provider Integration identified by its ID. **Operation ID:** patch-credential-provider-integration **Parameters:** * **id** (undefined) *(optional)*: any **Request Body:** CredentialProviderIntegrationPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched Credential Provider Integration * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “GET /api/v1/credential-integrations”](#get-apiv1credential-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** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Credential Provider Integrations * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/credential-integrations" ``` ### POST /api/v1/credential-integrations [Section titled “POST /api/v1/credential-integrations”](#post-apiv1credential-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: any **Responses:** * **‘201’**: Created Credential Provider Integration * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “PUT /api/v1/credential-integrations”](#put-apiv1credential-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: any **Responses:** * **‘200’**: Updated Credential Provider Integration * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘404’**: Not Found * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/credential-integrations" ``` ## Credential Provider v2 [Section titled “Credential Provider v2”](#credential-provider-v2) ### POST /api/v2/credential-providers [Section titled “POST /api/v2/credential-providers”](#post-apiv2credential-providers) **Summary:** Create a Credential Provider **Description:** Create a Credential Provider. **Operation ID:** post-credential-provider2 **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** CredentialProviderV2DTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Created Credential Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/credential-providers" ``` ### PUT /api/v2/credential-providers [Section titled “PUT /api/v2/credential-providers”](#put-apiv2credential-providers) **Summary:** Update a Credential Provider **Description:** Update a Credential Provider. **Operation ID:** put-credential-provider2 **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** CredentialProviderV2DTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Updated Credential Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v2/credential-providers" ``` ### GET /api/v2/credential-providers [Section titled “GET /api/v2/credential-providers”](#get-apiv2credential-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** (undefined) *(optional)*: any * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Credential Providers * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v2/credential-providers" ``` ### GET ‘/api/v2/credential-providers/{id}’ [Section titled “GET ‘/api/v2/credential-providers/{id}’”](#get-apiv2credential-providersid) **Summary:** Get a Credential Provider **Description:** Get a Credential Provider identified by its ID. **Operation ID:** get-credential-provider2 **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Credential Provider * Content-Type: application/json * Schema: any * **‘204’**: Credential Provider Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v2/credential-providers/{id}'" ``` ### DELETE ‘/api/v2/credential-providers/{id}’ [Section titled “DELETE ‘/api/v2/credential-providers/{id}’”](#delete-apiv2credential-providersid) **Summary:** Delete a Credential Provider **Description:** Delete a Credential Provider identified by its ID. **Operation ID:** delete-credential-provider2 **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘204’**: Deleted Credential Provider * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘404’**: Not Found * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v2/credential-providers/{id}'" ``` ### PATCH ‘/api/v2/credential-providers/{id}’ [Section titled “PATCH ‘/api/v2/credential-providers/{id}’”](#patch-apiv2credential-providersid) **Summary:** Patch a Credential Provider **Description:** Patch a Credential Provider. **Operation ID:** patch-credential-provider-v2 **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** CredentialProviderPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched Credential Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PATCH \ -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’ [Section titled “GET ‘/api/v2/credential-providers/{id}/verification’”](#get-apiv2credential-providersidverification) **Summary:** Verify the Credential Provider **Description:** Verify the Credential Provider will successfully return a credential. **Operation ID:** get-credential-provider-verification-v2 **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Details on the verification of a Credential Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v2/credential-providers/{id}/verification'" ``` ### GET ‘/api/v2/credential-providers/{id}/authorize’ [Section titled “GET ‘/api/v2/credential-providers/{id}/authorize’”](#get-apiv2credential-providersidauthorize) **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** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘302’**: Redirects to the Credential Provider Authorization URL * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v2/credential-providers/{id}/authorize'" ``` ## DiscoveryIntegration [Section titled “DiscoveryIntegration”](#discoveryintegration) ### GET /api/v1/discovery-integrations [Section titled “GET /api/v1/discovery-integrations”](#get-apiv1discovery-integrations) **Summary:** Get a page of Integrations **Description:** Get a page of Integrations. **Operation ID:** get-discovery-integrations **Parameters:** * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Integrations * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/discovery-integrations" ``` ### POST /api/v1/discovery-integrations [Section titled “POST /api/v1/discovery-integrations”](#post-apiv1discovery-integrations) **Summary:** Create an Integration **Description:** Create an Integration. **Operation ID:** post-discovery-integration **Request Body:** DiscoveryIntegrationDTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Created Integration * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “PUT /api/v1/discovery-integrations”](#put-apiv1discovery-integrations) **Summary:** Update an Integration **Description:** Update an Integration. **Operation ID:** put-discovery-integration **Request Body:** DiscoveryIntegrationDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Updated Integration * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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}’ [Section titled “GET ‘/api/v1/discovery-integrations/{id}’”](#get-apiv1discovery-integrationsid) **Summary:** Get an Integration **Description:** Get an Integration. **Operation ID:** get-discovery-integration **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘200’**: Integration * Content-Type: application/json * Schema: any * **‘204’**: Integration Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/discovery-integrations/{id}'" ``` ### DELETE ‘/api/v1/discovery-integrations/{id}’ [Section titled “DELETE ‘/api/v1/discovery-integrations/{id}’”](#delete-apiv1discovery-integrationsid) **Summary:** Delete an Integration **Description:** Delete an Integration as identified by its ID. **Operation ID:** delete-discovery-integration **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘200’**: Successfully deleted Integration * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/discovery-integrations/{id}'" ``` ### PATCH ‘/api/v1/discovery-integrations/{id}’ [Section titled “PATCH ‘/api/v1/discovery-integrations/{id}’”](#patch-apiv1discovery-integrationsid) **Summary:** Patch an Integration **Description:** Patch an Integration as identified by its ID. **Operation ID:** patch-discovery-integration **Parameters:** * **id** (undefined) *(optional)*: any **Request Body:** DiscoveryIntegrationPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched Integration * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io'/api/v1/discovery-integrations/{id}'" ``` ## Workload Event [Section titled “Workload Event”](#workload-event) ### GET /api/v1/workload-events [Section titled “GET /api/v1/workload-events”](#get-apiv1workload-events) **Summary:** Get a page of Workload Events **Description:** Get a page of Workload Events. **Operation ID:** get-workload-events **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **search** (undefined) *(optional)*: any * **span-last-hours** (undefined) *(optional)*: any * **application-protocol** (undefined) *(optional)*: any * **severity** (undefined) *(optional)*: any * **source-workload** (undefined) *(optional)*: any * **target-workload** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Workload Events * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/workload-events" ``` ### GET ‘/api/v1/workload-events/{id}’ [Section titled “GET ‘/api/v1/workload-events/{id}’”](#get-apiv1workload-eventsid) **Summary:** Get a Workload Event **Description:** Get a Workload Event. **Operation ID:** get-workload-event **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Workload Event * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/workload-events/{id}'" ``` ## Health [Section titled “Health”](#health) ### GET /api/v1/health [Section titled “GET /api/v1/health”](#get-apiv1health) **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: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/health" ``` ## Integration [Section titled “Integration”](#integration) ### GET /api/v1/integrations [Section titled “GET /api/v1/integrations”](#get-apiv1integrations) **Summary:** Get a page of Integrations **Description:** Get a page of Integrations. **Operation ID:** get-integrations **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Integrations * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/integrations" ``` ### POST /api/v1/integrations [Section titled “POST /api/v1/integrations”](#post-apiv1integrations) **Summary:** Create an Integration **Description:** Create an Integration. **Operation ID:** post-integration **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** IntegrationDTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Created Integration * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/integrations" ``` ### PUT /api/v1/integrations [Section titled “PUT /api/v1/integrations”](#put-apiv1integrations) **Summary:** Update an Integration **Description:** Update an Integration. **Operation ID:** put-integration **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** IntegrationDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Updated Integration * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/integrations" ``` ### GET ‘/api/v1/integrations/{id}’ [Section titled “GET ‘/api/v1/integrations/{id}’”](#get-apiv1integrationsid) **Summary:** Get an Integration **Description:** Get an Integration. **Operation ID:** get-integration **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Integration * Content-Type: application/json * Schema: any * **‘204’**: Integration Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/integrations/{id}'" ``` ### DELETE ‘/api/v1/integrations/{id}’ [Section titled “DELETE ‘/api/v1/integrations/{id}’”](#delete-apiv1integrationsid) **Summary:** Delete an Integration **Description:** Delete an Integration as identified by its ID. **Operation ID:** delete-integration **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Successfully deleted Integration * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/integrations/{id}'" ``` ### PATCH ‘/api/v1/integrations/{id}’ [Section titled “PATCH ‘/api/v1/integrations/{id}’”](#patch-apiv1integrationsid) **Summary:** Patch an Integration **Description:** Patch an Integration as identified by its ID. **Operation ID:** patch-integration **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** IntegrationPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched Integration * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io'/api/v1/integrations/{id}'" ``` ## Log Stream [Section titled “Log Stream”](#log-stream) ### GET /api/v1/log-streams [Section titled “GET /api/v1/log-streams”](#get-apiv1log-streams) **Summary:** Get a page of Log Streams **Description:** Get a page of Log Streams. **Operation ID:** get-log-streams **Parameters:** * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Log Streams * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/log-streams" ``` ### POST /api/v1/log-streams [Section titled “POST /api/v1/log-streams”](#post-apiv1log-streams) **Summary:** Create a Log Stream **Description:** Create a Log Stream. **Operation ID:** post-log-stream **Request Body:** LogStreamDTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Created Log Stream * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “PUT /api/v1/log-streams”](#put-apiv1log-streams) **Summary:** Update a Log Stream **Description:** Update a Log Stream. **Operation ID:** put-log-stream **Request Body:** LogStreamDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Updated Log Stream * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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}’ [Section titled “GET ‘/api/v1/log-streams/{id}’”](#get-apiv1log-streamsid) **Summary:** Get a Log Stream **Description:** Get a Log Stream identified by its ID. **Operation ID:** get-log-stream **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘200’**: Log Stream * Content-Type: application/json * Schema: any * **‘204’**: Log Stream Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/log-streams/{id}'" ``` ### DELETE ‘/api/v1/log-streams/{id}’ [Section titled “DELETE ‘/api/v1/log-streams/{id}’”](#delete-apiv1log-streamsid) **Summary:** Delete a Log Stream **Description:** Delete a Log Stream identified by its ID. **Operation ID:** delete-log-stream **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘204’**: Successfully deleted Log Stream * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/log-streams/{id}'" ``` ### PATCH ‘/api/v1/log-streams/{id}’ [Section titled “PATCH ‘/api/v1/log-streams/{id}’”](#patch-apiv1log-streamsid) **Summary:** Patch a Log Stream **Description:** Patch a Log Stream identified by its ID. **Operation ID:** patch-log-stream **Parameters:** * **id** (undefined) *(optional)*: any **Request Body:** LogStreamPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched Log Stream * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “Resource Set”](#resource-set) ### GET ‘/api/v1/resource-sets/{id}’ [Section titled “GET ‘/api/v1/resource-sets/{id}’”](#get-apiv1resource-setsid) **Summary:** Get a Resource Set **Description:** Get a Resource Set identified by its ID. **Operation ID:** get-resource-set **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘200’**: Resource Set * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/resource-sets/{id}'" ``` ### PATCH ‘/api/v1/resource-sets/{id}’ [Section titled “PATCH ‘/api/v1/resource-sets/{id}’”](#patch-apiv1resource-setsid) **Summary:** Patch a Resource Set **Description:** Patch a Resource Set identified by its ID. **Operation ID:** patch-resource-set **Parameters:** * **id** (undefined) *(optional)*: any **Request Body:** ResourceSetPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched Resource Set * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io'/api/v1/resource-sets/{id}'" ``` ### GET /api/v1/resource-sets [Section titled “GET /api/v1/resource-sets”](#get-apiv1resource-sets) **Summary:** Get a page of Resource Sets **Description:** Get a page of Resource Sets. **Operation ID:** get-resource-sets **Parameters:** * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Resource Sets * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/resource-sets" ``` ### POST /api/v1/resource-sets [Section titled “POST /api/v1/resource-sets”](#post-apiv1resource-sets) **Summary:** Create a Resource Set **Description:** Create a Resource Set. **Operation ID:** post-resource-set **Request Body:** ResourceSetDTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Created Resource Set * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “PUT /api/v1/resource-sets”](#put-apiv1resource-sets) **Summary:** Update a Resource Set **Description:** Update a Resource Set. **Operation ID:** put-resource-set **Request Body:** ResourceSetDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Updated Resource Set * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/resource-sets" ``` ## Role [Section titled “Role”](#role) ### GET /api/v1/roles [Section titled “GET /api/v1/roles”](#get-apiv1roles) **Summary:** Get a page of Roles **Description:** Get a page of Roles. **Operation ID:** get-roles **Parameters:** * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Roles * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/roles" ``` ### POST /api/v1/roles [Section titled “POST /api/v1/roles”](#post-apiv1roles) **Summary:** Create a new Role **Description:** Create a new Role. **Operation ID:** post-role **Request Body:** RoleDTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Created Role * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “PUT /api/v1/roles”](#put-apiv1roles) **Summary:** Update a Role **Description:** Update a Role. **Operation ID:** put-role **Request Body:** RoleDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Updated Role * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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}’ [Section titled “GET ‘/api/v1/roles/{id}’”](#get-apiv1rolesid) **Summary:** Get a Role **Description:** Get a Role identified by its ID. **Operation ID:** get-role **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘200’**: Role * Content-Type: application/json * Schema: any * **‘204’**: Role Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/roles/{id}'" ``` ### DELETE ‘/api/v1/roles/{id}’ [Section titled “DELETE ‘/api/v1/roles/{id}’”](#delete-apiv1rolesid) **Summary:** Delete a Role **Description:** Delete a Role identified by its ID. **Operation ID:** delete-role **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘204’**: Successfully deleted Role * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/roles/{id}'" ``` ### PATCH ‘/api/v1/roles/{id}’ [Section titled “PATCH ‘/api/v1/roles/{id}’”](#patch-apiv1rolesid) **Summary:** Patch a Role **Description:** Patch a Role identified by its ID. **Operation ID:** patch-role **Parameters:** * **id** (undefined) *(optional)*: any **Request Body:** RolePatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patch Role * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io'/api/v1/roles/{id}'" ``` ## Routing [Section titled “Routing”](#routing) ### GET ‘/api/v1/routings/{id}’ [Section titled “GET ‘/api/v1/routings/{id}’”](#get-apiv1routingsid) **Summary:** Get a Routing **Description:** Get a Routing identified by its ID. **Operation ID:** get-routing **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘200’**: Routing * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘403’**: Forbidden * **‘404’**: Not Found * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/routings/{id}'" ``` ### PATCH ‘/api/v1/routings/{id}’ [Section titled “PATCH ‘/api/v1/routings/{id}’”](#patch-apiv1routingsid) **Summary:** Patch a Routing **Description:** Patch a Routing identified by its ID. **Operation ID:** patch-routing **Parameters:** * **id** (undefined) *(optional)*: any **Request Body:** RoutingPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched Routing * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “GET /api/v1/routings”](#get-apiv1routings) **Summary:** Get a page of Routings **Description:** Get a page of Routings. **Operation ID:** get-routings **Parameters:** * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Routings * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/routings" ``` ### POST /api/v1/routings [Section titled “POST /api/v1/routings”](#post-apiv1routings) **Summary:** Create a Routing **Description:** Create a Routing. **Operation ID:** post-routing **Request Body:** RoutingDTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Created Routing * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘403’**: Forbidden * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “PUT /api/v1/routings”](#put-apiv1routings) **Summary:** Update a Routing **Description:** Update a Routing. **Operation ID:** put-routing **Request Body:** RoutingDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Updated Routing * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/routings" ``` ## SignOn Policy [Section titled “SignOn Policy”](#signon-policy) ### GET /api/v1/signin-policies [Section titled “GET /api/v1/signin-policies”](#get-apiv1signin-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: any * **‘204’**: SignOn Policy Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/signin-policies" ``` ## MFA SignOn Policy [Section titled “MFA SignOn Policy”](#mfa-signon-policy) ### PUT /api/v1/signin-policies/mfa [Section titled “PUT /api/v1/signin-policies/mfa”](#put-apiv1signin-policiesmfa) **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: any **Responses:** * **‘200’**: Updated MFA SignOn Policy * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘403’**: Forbidden * Content-Type: application/json * Schema: any * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “SSO SignOn Policy”](#sso-signon-policy) ### PUT /api/v1/signin-policies/sso [Section titled “PUT /api/v1/signin-policies/sso”](#put-apiv1signin-policiessso) **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: any **Responses:** * **‘200’**: Updated SSO SignOn Policy * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “SSO Identity Provider”](#sso-identity-provider) ### GET ‘/api/v1/sso-idps/{id}/verification’ [Section titled “GET ‘/api/v1/sso-idps/{id}/verification’”](#get-apiv1sso-idpsidverification) **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** (undefined) *(optional)*: any **Responses:** * **‘200’**: SSO Identity Provider verification * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/sso-idps/{id}/verification'" ``` ### GET ‘/api/v1/sso-idps/{id}’ [Section titled “GET ‘/api/v1/sso-idps/{id}’”](#get-apiv1sso-idpsid) **Summary:** Get a SSO Identity Provider **Description:** Get a SSO Identity Provider identified by its ID. **Operation ID:** get-identity-provider **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘200’**: SSO Identity Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/sso-idps/{id}'" ``` ### DELETE ‘/api/v1/sso-idps/{id}’ [Section titled “DELETE ‘/api/v1/sso-idps/{id}’”](#delete-apiv1sso-idpsid) **Summary:** Delete a SSO Identity Provider **Description:** Delete a SSO Identity Provider identified by its ID. **Operation ID:** delete-identity-provider **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘204’**: Successfully deleted SSO Identity Provider * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/sso-idps/{id}'" ``` ### PATCH ‘/api/v1/sso-idps/{id}’ [Section titled “PATCH ‘/api/v1/sso-idps/{id}’”](#patch-apiv1sso-idpsid) **Summary:** Patch a SSO Identity Provider **Description:** Patch a SSO Identity Provider identified by its ID. **Operation ID:** patch-identity-provider **Parameters:** * **id** (undefined) *(optional)*: any **Request Body:** SSOIdentityProviderPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched SSO Identity Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “GET /api/v1/sso-idps”](#get-apiv1sso-idps) **Summary:** Get a page of SSO Identity Providers **Description:** Get a page of SSO Identity Providers. **Operation ID:** get-identity-providers **Parameters:** * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of SSO Identity Providers * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/sso-idps" ``` ### POST /api/v1/sso-idps [Section titled “POST /api/v1/sso-idps”](#post-apiv1sso-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: any **Responses:** * **‘201’**: Created SSO Identity Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “PUT /api/v1/sso-idps”](#put-apiv1sso-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: any **Responses:** * **‘200’**: Updated SSO Identity Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “Standalone Certificate Authority”](#standalone-certificate-authority) ### DELETE ‘/api/v1/certificate-authorities/{id}’ [Section titled “DELETE ‘/api/v1/certificate-authorities/{id}’”](#delete-apiv1certificate-authoritiesid) **Summary:** Delete a Standalone Certificate Authority **Description:** Delete a Standalone Certificate Authority identified by its ID. **Operation ID:** delete-standalone-certificate-authority **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘204’**: Successfully deleted Standalone Certificate Authority * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/certificate-authorities/{id}'" ``` ### GET ‘/api/v1/certificate-authorities/{id}’ [Section titled “GET ‘/api/v1/certificate-authorities/{id}’”](#get-apiv1certificate-authoritiesid) **Summary:** Get a Standalone Certificate Authority **Description:** Get a Standalone Certificate Authority identified by its ID. **Operation ID:** get-standalone-certificate-authority **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘200’**: Standalone Certificate Authority * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/certificate-authorities/{id}'" ``` ### PATCH ‘/api/v1/certificate-authorities/{id}’ [Section titled “PATCH ‘/api/v1/certificate-authorities/{id}’”](#patch-apiv1certificate-authoritiesid) **Summary:** Patch a Standalone Certificate Authority **Description:** Patch a Standalone Certificate Authority identified by its ID. **Operation ID:** patch-standalone-certificate-authority **Parameters:** * **id** (undefined) *(optional)*: any **Request Body:** StandaloneCertificatePatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched Standalone Certificate Authority * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “GET /api/v1/certificate-authorities”](#get-apiv1certificate-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** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Standalone Certificate Authorities * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/certificate-authorities" ``` ### POST /api/v1/certificate-authorities [Section titled “POST /api/v1/certificate-authorities”](#post-apiv1certificate-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: any **Responses:** * **‘201’**: Created Standalone Certificate Authority * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “PUT /api/v1/certificate-authorities”](#put-apiv1certificate-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: any **Responses:** * **‘200’**: Updated Standalone Certificate Authority * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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 [Section titled “Standalone TLS Decrypt”](#standalone-tls-decrypt) ### GET ‘/api/v1/certificate-authorities/{id}/root-ca’ [Section titled “GET ‘/api/v1/certificate-authorities/{id}/root-ca’”](#get-apiv1certificate-authoritiesidroot-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** (undefined) *(optional)*: any **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 [Section titled “TLS Decrypt”](#tls-decrypt) ### GET /api/v1/root-ca [Section titled “GET /api/v1/root-ca”](#get-apiv1root-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 [Section titled “Trust Provider”](#trust-provider) ### GET /api/v1/trust-providers [Section titled “GET /api/v1/trust-providers”](#get-apiv1trust-providers) **Summary:** Get a page of Trust Providers **Description:** Get a page of Trust Providers. **Operation ID:** get-trust-providers **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any * **active** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Trust Providers * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/trust-providers" ``` ### POST /api/v1/trust-providers [Section titled “POST /api/v1/trust-providers”](#post-apiv1trust-providers) **Summary:** Create a Trust Provider **Description:** Create a Trust Provider. **Operation ID:** post-trust-provider **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** TrustProviderDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Created Trust Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/trust-providers" ``` ### PUT /api/v1/trust-providers [Section titled “PUT /api/v1/trust-providers”](#put-apiv1trust-providers) **Summary:** Update a Trust Provider **Description:** Update a Trust Provider. **Operation ID:** put-trust-provider **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** TrustProviderDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Updated Trust Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/trust-providers" ``` ### GET ‘/api/v1/trust-providers/{id}’ [Section titled “GET ‘/api/v1/trust-providers/{id}’”](#get-apiv1trust-providersid) **Summary:** Get a Trust Provider **Description:** Get a Trust Provider identified by its ID. **Operation ID:** get-trust-provider **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Trust Provider * Content-Type: application/json * Schema: any * **‘204’**: Trust Provider Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/trust-providers/{id}'" ``` ### DELETE ‘/api/v1/trust-providers/{id}’ [Section titled “DELETE ‘/api/v1/trust-providers/{id}’”](#delete-apiv1trust-providersid) **Summary:** Delete a Trust Provider **Description:** Delete a Trust Provider identified by its ID. **Operation ID:** delete-trust-provider **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘204’**: Successfully deleted Trust Provider * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘404’**: Not Found * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/trust-providers/{id}'" ``` ### PATCH ‘/api/v1/trust-providers/{id}’ [Section titled “PATCH ‘/api/v1/trust-providers/{id}’”](#patch-apiv1trust-providersid) **Summary:** Patch a Trust Provider **Description:** Patch a Trust Provider. **Operation ID:** patch-trust-provider **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** TrustProviderPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched Trust Provider * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io'/api/v1/trust-providers/{id}'" ``` ## User [Section titled “User”](#user) ### GET /api/v1/users [Section titled “GET /api/v1/users”](#get-apiv1users) **Summary:** Get a page of Users **Description:** Get a page of Users. **Operation ID:** get-users **Parameters:** * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Users * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/users" ``` ### POST /api/v1/users [Section titled “POST /api/v1/users”](#post-apiv1users) **Summary:** Create a User **Description:** Create a User. **Operation ID:** post-user **Request Body:** UserDTO * Content-Type: application/json * Schema: any **Responses:** * **‘201’**: Created User * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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}’ [Section titled “PATCH ‘/api/v1/users/{id}’”](#patch-apiv1usersid) **Summary:** Patch a User **Description:** Patch a User identified by its ID. **Operation ID:** patch-user **Parameters:** * **id** (undefined) *(optional)*: any **Request Body:** UserPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched User * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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}’ [Section titled “GET ‘/api/v1/users/{id}’”](#get-apiv1usersid) **Summary:** Get a User **Description:** Get a User identified by its ID. **Operation ID:** get-user **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘201’**: User * Content-Type: application/json * Schema: any * **‘204’**: User Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/users/{id}'" ``` ### PUT ‘/api/v1/users/{id}’ [Section titled “PUT ‘/api/v1/users/{id}’”](#put-apiv1usersid) **Summary:** Update a User **Description:** Update a User. **Operation ID:** put-user **Parameters:** * **id** (undefined) *(optional)*: any **Request Body:** UserDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: User * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **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}’ [Section titled “DELETE ‘/api/v1/users/{id}’”](#delete-apiv1usersid) **Summary:** Delete a User **Description:** Delete a User identified by its ID. **Operation ID:** delete-user **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘204’**: Successfully deleted User * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/users/{id}'" ``` ### POST ‘/api/v1/users/{id}/unlock’ [Section titled “POST ‘/api/v1/users/{id}/unlock’”](#post-apiv1usersidunlock) **Summary:** Unlock a User **Description:** Unlock a User identified by its ID. **Operation ID:** post-user-unlock **Parameters:** * **id** (undefined) *(optional)*: any **Responses:** * **‘200’**: Successfully unlocked User * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X POST \ "https://your-tenant.aembit.io'/api/v1/users/{id}/unlock'" ``` ## Server Workload [Section titled “Server Workload”](#server-workload) ### POST /api/v1/server-workloads [Section titled “POST /api/v1/server-workloads”](#post-apiv1server-workloads) **Summary:** Create a Server Workload **Description:** Create a Server Workload. **Operation ID:** post-server-workload **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** ServerWorkloadExternalDTO * Content-Type: application/json * Schema: any **Responses:** * **‘204’**: Created Server Workload * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/server-workloads" ``` ### PUT /api/v1/server-workloads [Section titled “PUT /api/v1/server-workloads”](#put-apiv1server-workloads) **Summary:** Update a Server Workload **Description:** Update a Server Workload. **Operation ID:** put-server-workload **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** ServerWorkloadExternalDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Updated Server Workload * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/server-workloads" ``` ### GET /api/v1/server-workloads [Section titled “GET /api/v1/server-workloads”](#get-apiv1server-workloads) **Summary:** Get a page of Server Workloads **Description:** Get a page of Server Workloads. **Operation ID:** get-server-workloads **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Server Workloads * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/server-workloads" ``` ### PATCH ‘/api/v1/server-workloads/{id}’ [Section titled “PATCH ‘/api/v1/server-workloads/{id}’”](#patch-apiv1server-workloadsid) **Summary:** Patch a Server Workload **Description:** Patch a Server Workload. **Operation ID:** patch-server-workload **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** EntityPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched Server Workload * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io'/api/v1/server-workloads/{id}'" ``` ### GET ‘/api/v1/server-workloads/{id}’ [Section titled “GET ‘/api/v1/server-workloads/{id}’”](#get-apiv1server-workloadsid) **Summary:** Get a Server Workload **Description:** Get a Server Workload identified by its ID. **Operation ID:** get-server-workload **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Server Workload * Content-Type: application/json * Schema: any * **‘204’**: Server Workload Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/server-workloads/{id}'" ``` ### DELETE ‘/api/v1/server-workloads/{id}’ [Section titled “DELETE ‘/api/v1/server-workloads/{id}’”](#delete-apiv1server-workloadsid) **Summary:** Delete a Server Workload **Description:** Delete a Server Workload identified by its ID. **Operation ID:** delete-server-workload **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘204’**: Successfully deleted Server Workload * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/server-workloads/{id}'" ``` ## Client Workload [Section titled “Client Workload”](#client-workload) ### POST /api/v1/client-workloads [Section titled “POST /api/v1/client-workloads”](#post-apiv1client-workloads) **Summary:** Create a Client Workload **Description:** Create a Client Workload. **Operation ID:** post-client-workload **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** ClientWorkloadExternalDTO * Content-Type: application/json * Schema: any **Responses:** * **‘204’**: Created Client Workload * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X POST \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/client-workloads" ``` ### PUT /api/v1/client-workloads [Section titled “PUT /api/v1/client-workloads”](#put-apiv1client-workloads) **Summary:** Update a Client Workload **Description:** Update a Client Workload. **Operation ID:** put-client-workload **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** ClientWorkloadExternalDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Updated Client Workload * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PUT \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io/api/v1/client-workloads" ``` ### GET /api/v1/client-workloads [Section titled “GET /api/v1/client-workloads”](#get-apiv1client-workloads) **Summary:** Get a page of Client Workloads **Description:** Get a page of Client Workloads. **Operation ID:** get-client-workloads **Parameters:** * **X-Aembit-ResourceSet** (undefined) *(optional)*: any * **page** (undefined) *(optional)*: any * **per-page** (undefined) *(optional)*: any * **filter** (undefined) *(optional)*: any * **order** (undefined) *(optional)*: any * **group-by** (undefined) *(optional)*: any **Responses:** * **‘200’**: Page of Client Workloads * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io/api/v1/client-workloads" ``` ### PATCH ‘/api/v1/client-workloads/{id}’ [Section titled “PATCH ‘/api/v1/client-workloads/{id}’”](#patch-apiv1client-workloadsid) **Summary:** Patch a Client Workload **Description:** Patch a Client Workload. **Operation ID:** patch-client-workload **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Request Body:** ClientWorkloadPatchDTO * Content-Type: application/json * Schema: any **Responses:** * **‘200’**: Patched Client Workload * Content-Type: application/json * Schema: any * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X PATCH \ -H "Content-Type: application/json" \ -d '{"example": "data"}' \ "https://your-tenant.aembit.io'/api/v1/client-workloads/{id}'" ``` ### GET ‘/api/v1/client-workloads/{id}’ [Section titled “GET ‘/api/v1/client-workloads/{id}’”](#get-apiv1client-workloadsid) **Summary:** Get a Client Workload **Description:** Get a Client Workload identified by its ID. **Operation ID:** get-client-workload **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘200’**: Client Workload * Content-Type: application/json * Schema: any * **‘204’**: Client Workload Not Found * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X GET \ "https://your-tenant.aembit.io'/api/v1/client-workloads/{id}'" ``` ### DELETE ‘/api/v1/client-workloads/{id}’ [Section titled “DELETE ‘/api/v1/client-workloads/{id}’”](#delete-apiv1client-workloadsid) **Summary:** Delete a Client Workload **Description:** Delete a Client Workload identified by its ID. **Operation ID:** delete-client-workload **Parameters:** * **id** (undefined) *(optional)*: any * **X-Aembit-ResourceSet** (undefined) *(optional)*: any **Responses:** * **‘204’**: Successfully deleted Client Workload * **‘400’**: Bad Request * **‘401’**: Not Authenticated * **‘404’**: Not Found * **‘500’**: Internal Server Error * Content-Type: application/json * Schema: any **cURL Example:** ```bash curl -X DELETE \ "https://your-tenant.aembit.io'/api/v1/client-workloads/{id}'" ``` *** # Aembit.API - Data Schemas [Section titled “Aembit.API - Data Schemas”](#aembitapi---data-schemas) **Version:** v1 ### AccessConditionDTO [Section titled “AccessConditionDTO”](#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 * **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)*: any * **conditions** *(required)*: object - Rules which are enforced by the Access Condition * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Access Condition ### AccessConditionListDTO [Section titled “AccessConditionListDTO”](#accessconditionlistdto) 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) * **recordsTotal** *(optional)*: integer (int32) * **accessConditions** *(optional)*: Array ### AccessConditionPatchDTO [Section titled “AccessConditionPatchDTO”](#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 - New Tags for the identified entity ### AgentControllerDTO [Section titled “AgentControllerDTO”](#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 - Tags assigned to the Agent Controller * **tlsCertificates** *(optional)*: Array - 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)*: any * **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 ### AgentControllerDeviceCodeDTO [Section titled “AgentControllerDeviceCodeDTO”](#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 [Section titled “AgentControllerListDTO”](#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 - Page of AgentControllers for this request ### AgentControllerPatchDTO [Section titled “AgentControllerPatchDTO”](#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 [Section titled “AgentControllerTagDTO”](#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 [Section titled “AgentControllerTlsCertificateDTO”](#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 [Section titled “AuditActorDTO”](#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 [Section titled “AuditClientDTO”](#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)*: any ### AuditLogDTO [Section titled “AuditLogDTO”](#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)*: any * **activity** *(optional)*: string | null - Activity of an Aembit Audit Log * **target** *(optional)*: string | null - Target of an Aembit Audit Log * **client** *(optional)*: any * **outcome** *(optional)*: any * **trustProvider** *(optional)*: any * **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 [Section titled “AuditLogListDTO”](#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 - Page of Aembit Audit Logs ### AuditOutcomeDTO [Section titled “AuditOutcomeDTO”](#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 [Section titled “AuthorizationEventAtttestationResultDTO”](#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 - List of matched Access Entity Identifiers * **reason** *(optional)*: string | null * **attribute** *(optional)*: string | null * **expectedValue** *(optional)*: string | null * **actualValue** *(optional)*: string | null ### AuthorizationEventCPResultDTO [Section titled “AuthorizationEventCPResultDTO”](#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 - List of matched Access Entity Identifiers * **type** *(optional)*: string | null - Credential Provider Type * **reason** *(optional)*: string | null - Credential Provider Failure Reason ### AuthorizationEventDTO [Section titled “AuthorizationEventDTO”](#authorizationeventdto) An individual Aembit Access Authorization Event **Type:** object **Properties:** * **meta** *(optional)*: any * **outcome** *(optional)*: any * **clientRequest** *(optional)*: any * **environment** *(optional)*: any * **clientWorkload** *(optional)*: any * **serverWorkload** *(optional)*: any * **accessPolicy** *(optional)*: any * **trustProviders** *(optional)*: Array - Trust Provider information for an individual Aembit Access Authorization Event * **accessConditions** *(optional)*: Array - Access Condition information for an individual Aembit Access Authorization Event * **credentialProvider** *(optional)*: any ### AuthorizationEventDataMetaDTO [Section titled “AuthorizationEventDataMetaDTO”](#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 [Section titled “AuthorizationEventEntityResultDTO”](#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 - List of matched Access Entity Identifiers ### AuthorizationEventEnvironmentDataDTO [Section titled “AuthorizationEventEnvironmentDataDTO”](#authorizationeventenvironmentdatadto) **Type:** object **Properties:** * **network** *(optional)*: any * **host** *(optional)*: any * **process** *(optional)*: any * **aembit** *(optional)*: any * **aws** *(optional)*: any * **gcp** *(optional)*: any * **azure** *(optional)*: any * **kubernetes** *(optional)*: any * **gitlab** *(optional)*: any * **github** *(optional)*: any * **terraform** *(optional)*: any ### AuthorizationEventListDTO [Section titled “AuthorizationEventListDTO”](#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 - Page of Aembit Access Authorization Events ### AuthorizationEventOutcomeDTO [Section titled “AuthorizationEventOutcomeDTO”](#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 ### CPAwsStsV2DTO [Section titled “CPAwsStsV2DTO”](#cpawsstsv2dto) ### CPGitLabManagedAccountDTO [Section titled “CPGitLabManagedAccountDTO”](#cpgitlabmanagedaccountdto) ### CPTypeAembitAccessTokenV2DTO [Section titled “CPTypeAembitAccessTokenV2DTO”](#cptypeaembitaccesstokenv2dto) ### CPTypeApiKeyUIV2DTO [Section titled “CPTypeApiKeyUIV2DTO”](#cptypeapikeyuiv2dto) ### CPTypeAzureEntraFederationV2DTO [Section titled “CPTypeAzureEntraFederationV2DTO”](#cptypeazureentrafederationv2dto) ### CPTypeGoogleWorkflowIDFederationV2DTO [Section titled “CPTypeGoogleWorkflowIDFederationV2DTO”](#cptypegoogleworkflowidfederationv2dto) ### CPTypeJWTTokenV2DTO [Section titled “CPTypeJWTTokenV2DTO”](#cptypejwttokenv2dto) ### CPTypeOAuth2AuthorizationCodeUIV2DTO [Section titled “CPTypeOAuth2AuthorizationCodeUIV2DTO”](#cptypeoauth2authorizationcodeuiv2dto) ### CPTypeOAuth2ClientCredentialsUIV2DTO [Section titled “CPTypeOAuth2ClientCredentialsUIV2DTO”](#cptypeoauth2clientcredentialsuiv2dto) ### CPTypeOAuth2CustomParameters [Section titled “CPTypeOAuth2CustomParameters”](#cptypeoauth2customparameters) **Type:** object **Properties:** * **key** *(optional)*: string | null * **value** *(optional)*: string | null * **valueType** *(optional)*: string | null ### CPTypeUsernamePasswordUIV2DTO [Section titled “CPTypeUsernamePasswordUIV2DTO”](#cptypeusernamepassworduiv2dto) ### CPTypeVaultClientTokenV2DTO [Section titled “CPTypeVaultClientTokenV2DTO”](#cptypevaultclienttokenv2dto) ### ClientRequestDTO [Section titled “ClientRequestDTO”](#clientrequestdto) **Type:** object **Properties:** * **version** *(required)*: string * **network** *(required)*: any ### ClientWorkloadExternalDTO [Section titled “ClientWorkloadExternalDTO”](#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 * **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 * **standaloneCertificateAuthority** *(optional)*: string (uuid) | null - Standalone Certificate Authority associated with this Client Workload * **type** *(optional)*: string | null * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Client Workload ### ClientWorkloadIdentityDTO [Section titled “ClientWorkloadIdentityDTO”](#clientworkloadidentitydto) **Type:** object **Properties:** * **type** *(optional)*: string | null * **value** *(required)*: string ### ClientWorkloadListDTO [Section titled “ClientWorkloadListDTO”](#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 ### ClientWorkloadPatchDTO [Section titled “ClientWorkloadPatchDTO”](#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 - New Tags for the identified entity * **identities** *(optional)*: Array ### CreatePolicyDTO [Section titled “CreatePolicyDTO”](#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 * **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 - Credential Providers associated with this Access Policy * **trustProviders** *(optional)*: Array\ - Trust Providers associated with this Access Policy * **accessConditions** *(optional)*: Array\ - Access Conditions 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 ### CredentialProviderDTO [Section titled “CredentialProviderDTO”](#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 * **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 [Section titled “CredentialProviderIntegrationDTO”](#credentialproviderintegrationdto) Individual Credential Provider Integration **Type:** object **Properties:** * **type** *(required)*: any * **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 * **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 [Section titled “CredentialProviderIntegrationPatchDTO”](#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 - New Tags for the identified entity ### CredentialProviderIntegrationType [Section titled “CredentialProviderIntegrationType”](#credentialproviderintegrationtype) **Type:** string **Possible values:** `GitLab` ### CredentialProviderPatchDTO [Section titled “CredentialProviderPatchDTO”](#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 - 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 [Section titled “CredentialProviderUIDTO”](#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 * **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 [Section titled “CredentialProviderUIDTOCredentialProviderListDTO”](#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 - Page of Credential Providers ### CredentialProviderV2DTO [Section titled “CredentialProviderV2DTO”](#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 * **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 [Section titled “CredentialProviderV2DTOCredentialProviderListDTO”](#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 - Page of Credential Providers ### DiscoveryIntegrationDTO [Section titled “DiscoveryIntegrationDTO”](#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 * **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)*: object ### DiscoveryIntegrationListDTO [Section titled “DiscoveryIntegrationListDTO”](#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 - Page of Integrations ### DiscoveryIntegrationPatchDTO [Section titled “DiscoveryIntegrationPatchDTO”](#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 - New Tags for the identified entity ### EntityMetaDTO [Section titled “EntityMetaDTO”](#entitymetadto) **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(optional)*: string | null * **tags** *(optional)*: Array ### EntityPatchDTO [Section titled “EntityPatchDTO”](#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 - New Tags for the identified entity ### EventDTO [Section titled “EventDTO”](#eventdto) **Type:** object **Properties:** * **meta** *(optional)*: any * **network** *(optional)*: any * **outcome** *(optional)*: any ### EventListDTO [Section titled “EventListDTO”](#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 ### EventMetaDTO [Section titled “EventMetaDTO”](#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 [Section titled “EventNetworkDTO”](#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 [Section titled “EventOutcomeDTO”](#eventoutcomedto) **Type:** object **Properties:** * **result** *(optional)*: string | null ### EventResultDTO [Section titled “EventResultDTO”](#eventresultdto) **Type:** object **Properties:** * **reason** *(optional)*: string | null * **attribute** *(optional)*: string | null * **expectedValue** *(optional)*: string | null * **actualValue** *(optional)*: string | null ### GenericResponseDTO [Section titled “GenericResponseDTO”](#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 ### GetPolicyDTO [Section titled “GetPolicyDTO”](#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 * **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)*: any * **serverWorkload** *(optional)*: any * **trustProviders** *(optional)*: Array - Trust Providers associated with this Access Policy * **credentialProviders** *(optional)*: Array - Credential Providers associated with this Access Policy * **accessConditions** *(optional)*: Array - Access Conditions associated with this Access Policy ### GetPolicyDTOListDTO [Section titled “GetPolicyDTOListDTO”](#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 - Page of entities for this request ### GetSignInPolicyDTO [Section titled “GetSignInPolicyDTO”](#getsigninpolicydto) **Type:** object **Properties:** * **ssoRequired** *(optional)*: boolean * **mfaRequired** *(optional)*: boolean ### GitLabCredentialProviderIntegrationDTO [Section titled “GitLabCredentialProviderIntegrationDTO”](#gitlabcredentialproviderintegrationdto) Individual Credential Provider Integration ### HealthDTO [Section titled “HealthDTO”](#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 [Section titled “IntegrationDTO”](#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 * **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) ### IntegrationListDTO [Section titled “IntegrationListDTO”](#integrationlistdto) 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 - Page of Integrations ### IntegrationPatchDTO [Section titled “IntegrationPatchDTO”](#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 - New Tags for the identified entity ### JWTClaimDTO [Section titled “JWTClaimDTO”](#jwtclaimdto) **Type:** object **Properties:** * **key** *(optional)*: string | null * **value** *(optional)*: string | null * **valueType** *(optional)*: string | null ### JsonNode [Section titled “JsonNode”](#jsonnode) **Type:** object **Properties:** * **options** *(optional)*: any * **parent** *(optional)*: any * **root** *(optional)*: any ### JsonNodeOptions [Section titled “JsonNodeOptions”](#jsonnodeoptions) **Type:** object **Properties:** * **propertyNameCaseInsensitive** *(optional)*: boolean ### ListCredentialProviderIntegrationDTO [Section titled “ListCredentialProviderIntegrationDTO”](#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 * **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)*: any * **status** *(optional)*: string | null * **lastOperationTimestamp** *(optional)*: string (date-time) | null ### ListCredentialProviderIntegrationDTOListDTO [Section titled “ListCredentialProviderIntegrationDTOListDTO”](#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 - Page of entities for this request ### LogStreamDTO [Section titled “LogStreamDTO”](#logstreamdto) Individual Log Stream **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 * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **dataType** *(required)*: string - Log Stream Data Type (e.g. AuditLogs, etc.) * **type** *(required)*: any ### LogStreamDestinationType [Section titled “LogStreamDestinationType”](#logstreamdestinationtype) **Type:** string **Possible values:** `AwsS3Bucket`, `GcsBucket` ### LogStreamListDTO [Section titled “LogStreamListDTO”](#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 - Page of Log Streams ### LogStreamPatchDTO [Section titled “LogStreamPatchDTO”](#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 - New Tags for the identified entity ### MFASignInPolicyDTO [Section titled “MFASignInPolicyDTO”](#mfasigninpolicydto) **Type:** object **Properties:** * **mfaRequired** *(optional)*: boolean ### NetworkDTO [Section titled “NetworkDTO”](#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) ### PatchPolicyV2DTO [Section titled “PatchPolicyV2DTO”](#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 - 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 - Credential Providers associated with this Access Policy * **trustProviders** *(optional)*: Array\ - Trust Providers associated with this Access Policy * **accessConditions** *(optional)*: Array\ - Access Conditions associated with this Access Policy ### PermissionDTO [Section titled “PermissionDTO”](#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 [Section titled “PolicyCredentialMappingDTO”](#policycredentialmappingdto) Access Policy Credential Mappings **Type:** object **Properties:** * **credentialProviderId** *(required)*: string (uuid) - CredentialProviderId * **mappingType** *(required)*: any * **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 [Section titled “PolicyCredentialProviderMappingTypes”](#policycredentialprovidermappingtypes) **Type:** string **Possible values:** `None`, `AccountName`, `HttpHeader`, `HttpBody` ### PolicyDTO [Section titled “PolicyDTO”](#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 * **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\ - Trust Providers associated with this Access Policy * **accessConditions** *(optional)*: Array\ - Access Conditions 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)*: any * **serverWorkloadDetails** *(optional)*: any * **policyNotes** *(optional)*: Array - Policy Notes for this Access Policy ### PolicyExternalDTO [Section titled “PolicyExternalDTO”](#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 * **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)*: any * **trustProviders** *(optional)*: Array - Details of the Trust Providers associated with this Access Policy * **accessConditions** *(optional)*: Array - Details of the Access Conditions associated with this Access Policy * **credentialProvider** *(optional)*: any * **serverWorkload** *(optional)*: any * **policyNotes** *(optional)*: Array - Policy Notes for this Access Policy ### PolicyListDTO [Section titled “PolicyListDTO”](#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 - Page of Access Policies ### PolicyNoteDTO [Section titled “PolicyNoteDTO”](#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 [Section titled “PolicyNoteDTOListDTO”](#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 - Page of entities for this request ### PolicyPatchDTO [Section titled “PolicyPatchDTO”](#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 - 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\ - Trust Providers associated with this Access Policy * **accessConditions** *(optional)*: Array\ - Access Conditions associated with this Access Policy ### PublicKeyValidationDTO [Section titled “PublicKeyValidationDTO”](#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 | null - Expiration of the Public Key Certificate * **certificateSubject** *(optional)*: string | null - Subject of the Public Key Certificate * **message** *(optional)*: string | null - Message describing why the Public Key was not valid if IsValidContent is False ### RequestMetadaAembitDTO [Section titled “RequestMetadaAembitDTO”](#requestmetadaaembitdto) **Type:** object **Properties:** * **clientId** *(optional)*: string | null ### RequestMetadaAwsDTO [Section titled “RequestMetadaAwsDTO”](#requestmetadaawsdto) **Type:** object **Properties:** * **accountId** *(optional)*: string | null * **instanceId** *(optional)*: string | null * **ecs** *(optional)*: any * **lambda** *(optional)*: any ### RequestMetadaAzureDTO [Section titled “RequestMetadaAzureDTO”](#requestmetadaazuredto) **Type:** object **Properties:** * **vmId** *(optional)*: string | null * **subscriptionId** *(optional)*: string | null ### RequestMetadaEcsDTO [Section titled “RequestMetadaEcsDTO”](#requestmetadaecsdto) **Type:** object **Properties:** * **taskFamily** *(optional)*: string | null ### RequestMetadaGcpDTO [Section titled “RequestMetadaGcpDTO”](#requestmetadagcpdto) **Type:** object **Properties:** * **serviceAccount** *(optional)*: string | null ### RequestMetadaGithubDTO [Section titled “RequestMetadaGithubDTO”](#requestmetadagithubdto) **Type:** object **Properties:** * **repository** *(optional)*: string | null * **subject** *(optional)*: string | null ### RequestMetadaGitlabDTO [Section titled “RequestMetadaGitlabDTO”](#requestmetadagitlabdto) **Type:** object **Properties:** * **namespacePath** *(optional)*: string | null * **projectPath** *(optional)*: string | null * **refPath** *(optional)*: string | null * **subject** *(optional)*: string | null ### RequestMetadaHostDTO [Section titled “RequestMetadaHostDTO”](#requestmetadahostdto) **Type:** object **Properties:** * **hostname** *(optional)*: string | null ### RequestMetadaKubernetesDTO [Section titled “RequestMetadaKubernetesDTO”](#requestmetadakubernetesdto) **Type:** object **Properties:** * **namespace** *(optional)*: string | null * **podName** *(optional)*: string | null * **serviceAccountName** *(optional)*: string | null ### RequestMetadaLambdaDTO [Section titled “RequestMetadaLambdaDTO”](#requestmetadalambdadto) **Type:** object **Properties:** * **arn** *(optional)*: string | null ### RequestMetadaNetworkDTO [Section titled “RequestMetadaNetworkDTO”](#requestmetadanetworkdto) **Type:** object **Properties:** * **sourceIP** *(optional)*: string | null ### RequestMetadaProcessDTO [Section titled “RequestMetadaProcessDTO”](#requestmetadaprocessdto) **Type:** object **Properties:** * **name** *(optional)*: string | null * **userName** *(optional)*: string | null ### RequestMetadaTerraformDTO [Section titled “RequestMetadaTerraformDTO”](#requestmetadaterraformdto) **Type:** object **Properties:** * **workspaceId** *(optional)*: string | null ### ResourceSetDTO [Section titled “ResourceSetDTO”](#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 * **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\ - Roles associated with this Resource Set * **rolesDetails** *(optional)*: Array - Details of the Roles associated with this Resource Set * **users** *(optional)*: Array - Users associated with this Resource Set * **standaloneCertificateAuthority** *(optional)*: string (uuid) | null - Standalone Certificate Authority associated with this Resource Set ### ResourceSetDTOListDTO [Section titled “ResourceSetDTOListDTO”](#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 - Page of entities for this request ### ResourceSetPatchDTO [Section titled “ResourceSetPatchDTO”](#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 - New Tags for the identified entity ### RoleDTO [Section titled “RoleDTO”](#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 * **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 - Permissions assigned to this Role * **resourceSets** *(optional)*: Array - Resource Sets assigned to this Role ### RoleListDTO [Section titled “RoleListDTO”](#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 - Page of Roles ### RolePatchDTO [Section titled “RolePatchDTO”](#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 - New Tags for the identified entity ### RoutingDTO [Section titled “RoutingDTO”](#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 * **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 [Section titled “RoutingDTOListDTO”](#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 - Page of entities for this request ### RoutingPatchDTO [Section titled “RoutingPatchDTO”](#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 - New Tags for the identified entity ### SSOIdentityProviderDTO [Section titled “SSOIdentityProviderDTO”](#ssoidentityproviderdto) Individual SSO Identity 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 * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **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 * **samlStatementRoleMappings** *(optional)*: Array - Collection of mappings of SAML attributes to Aembit roles ### SSOIdentityProviderDTOListDTO [Section titled “SSOIdentityProviderDTOListDTO”](#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 - Page of entities for this request ### SSOIdentityProviderPatchDTO [Section titled “SSOIdentityProviderPatchDTO”](#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 - New Tags for the identified entity ### SSOSignInPolicyDTO [Section titled “SSOSignInPolicyDTO”](#ssosigninpolicydto) **Type:** object **Properties:** * **ssoRequired** *(optional)*: boolean ### SamlStatementRoleMappingDTO [Section titled “SamlStatementRoleMappingDTO”](#samlstatementrolemappingdto) Represents a mapping of a SAML attribute to an Aembit role **Type:** object **Properties:** * **attributeName** *(optional)*: string | null - SAML Attribute name * **attributeValue** *(optional)*: string | null - SAML Attribute value * **roleExternalId** *(optional)*: string (uuid) - Aembit Role ID ### ServerWorkloadExternalDTO [Section titled “ServerWorkloadExternalDTO”](#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 * **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)*: any * **type** *(optional)*: string | null - Type of Server Workload * **accessPolicyCount** *(optional)*: integer (int32) - Access Policies associated with this Server Workload ### ServerWorkloadListDTO [Section titled “ServerWorkloadListDTO”](#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 ### StandaloneCertificatePatchDTO [Section titled “StandaloneCertificatePatchDTO”](#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 - New Tags for the identified entity * **leafLifetime** *(optional)*: integer (int32) | null ### StandaloneCertificateRequestDTO [Section titled “StandaloneCertificateRequestDTO”](#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 * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **leafLifetime** *(required)*: integer (int32) - Leaf certificate lifetime value for this Standalone Certificate Authority ### StandaloneCertificateResponseDTO [Section titled “StandaloneCertificateResponseDTO”](#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 * **createdAt** *(optional)*: string (date-time) * **modifiedAt** *(optional)*: string (date-time) | null * **createdBy** *(optional)*: string | null * **modifiedBy** *(optional)*: string | null * **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 [Section titled “StandaloneCertificateResponseDTOListDTO”](#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 - Page of entities for this request ### StringStringKeyValuePair [Section titled “StringStringKeyValuePair”](#stringstringkeyvaluepair) **Type:** object **Properties:** * **key** *(optional)*: string | null * **value** *(optional)*: string | null ### TagDTO [Section titled “TagDTO”](#tagdto) Aembit Entity Tag Details **Type:** object **Properties:** * **key** *(required)*: string - Tag Key * **value** *(required)*: string - Tag Key Value ### TrustProviderDTO [Section titled “TrustProviderDTO”](#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 * **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 - Trust Provider Match Rules * **certificate** *(optional)*: string | null - Trust Provider Certificate or Public Key for cryptographic attestation * **publicKeyValidation** *(optional)*: any * **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\ - Agent Controller IDs associated with this Trust Provider ### TrustProviderItemDTO [Section titled “TrustProviderItemDTO”](#trustprovideritemdto) **Type:** object **Properties:** * **externalId** *(optional)*: string (uuid) * **name** *(optional)*: string | null ### TrustProviderListDTO [Section titled “TrustProviderListDTO”](#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 - Page of Trust Providers ### TrustProviderMatchRuleDTO [Section titled “TrustProviderMatchRuleDTO”](#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 ### TrustProviderPatchDTO [Section titled “TrustProviderPatchDTO”](#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 - New Tags for the identified entity * **provider** *(optional)*: string | null - Trust Provider Type * **matchRules** *(optional)*: Array - 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 * **publicKeyValidation** *(optional)*: any ### UserAgentDTO [Section titled “UserAgentDTO”](#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 [Section titled “UserDTO”](#userdto) **Type:** object **Properties:** * **email** *(required)*: string (email) * **externalId** *(optional)*: string (uuid) * **roles** *(optional)*: Array\ * **rolesDetails** *(optional)*: Array * **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 * **userTokens** *(optional)*: Array ### UserListDTO [Section titled “UserListDTO”](#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 ### UserPatchDTO [Section titled “UserPatchDTO”](#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 [Section titled “UserTokensDTO”](#usertokensdto) **Type:** object **Properties:** * **id** *(optional)*: string (uuid) * **name** *(optional)*: string | null * **verified** *(optional)*: boolean * **createdAt** *(optional)*: string (date-time) ### WorkloadExternalDTO [Section titled “WorkloadExternalDTO”](#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 * **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 * **credentialProviderId** *(optional)*: string (uuid) | null * **credentialProviderText** *(optional)*: string | null * **workloadServiceEndpoints** *(optional)*: Array\ * **serviceEndpoint** *(optional)*: any * **type** *(optional)*: string | null ### WorkloadServiceAuthenticationDTO [Section titled “WorkloadServiceAuthenticationDTO”](#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 [Section titled “WorkloadServiceEndpointDTO”](#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)*: any * **tlsVerification** *(required)*: string - TLS Verification configuration for the Agent/Proxy to Server Workload connection * **httpHeaders** *(optional)*: Array - Static HTTP Headers to include for transmission to the Server Workload