Aembit Cloud API - API Endpoints

Version: v1

Base URL: https://{tenant}.aembit-eng.com

Access Condition

GET /api/v1/access-conditions

Summary: Get a page of Access Conditions

Description: Retrieve a page of Aembit Access Conditions.

Operation ID: get-access-conditions

Parameters:

X-Aembit-ResourceSet (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/access-conditions"

POST /api/v1/access-conditions

Summary: Create an Access Condition

Description: Create an Aembit Access Condition which can then be associated with an Access Policy.

Operation ID: post-access-condition

Parameters:

X-Aembit-ResourceSet (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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/access-conditions"

PUT /api/v1/access-conditions

Summary: Update a single Access Condition

Description: Update a specific Access Condition identified by its ID.

Operation ID: put-access-condition

Parameters:

X-Aembit-ResourceSet (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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/access-conditions"

GET ‘/api/v1/access-conditions/{id}’

Summary: Get the identified Access Condition

Description: Get the Access Condition identified by its ID.

Operation ID: get-access-condition

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/access-conditions/{id}'"

DELETE ‘/api/v1/access-conditions/{id}’

Summary: Delete a single Access Condition

Description: Delete a specific Access Condition identified by its ID.

Operation ID: delete-access-condition

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/access-conditions/{id}'"

PATCH ‘/api/v1/access-conditions/{id}’

Summary: Patch a single Access Condition

Description: Patch a specific Access Condition identified by its ID.

Operation ID: patch-access-condition

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/access-conditions/{id}'"

Access Policy (Deprecated)

GET ‘/api/v1/access-policies/{id}’

Summary: Get the identified Access Policy

Description: Get the Access Policy identified by its ID.

Operation ID: get-access-policy

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/access-policies/{id}'"

DELETE ‘/api/v1/access-policies/{id}’

Summary: Delete an Access Policy

Description: Delete an Access Policy.

Operation ID: delete-access-policy

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/access-policies/{id}'"

PATCH ‘/api/v1/access-policies/{id}’

Summary: Patch an Access Policy

Description: Patch an Access Policy.

Operation ID: patch-access-policy

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/access-policies/{id}'"

GET ‘/api/v1/access-policies/getByWorkloadIds/{clientWorkloadId}/{serverWorkloadId}’

Summary: Get the identified Access Policy

Description: Get the Access Policy identified by a Client and Server Workload.

Operation ID: get-access-policy-by-workloads

Parameters:

clientWorkloadId (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/access-policies/getByWorkloadIds/{clientWorkloadId}/{serverWorkloadId}'"

GET /api/v1/access-policies

Summary: Get a page of Access Policies

Description: Retrieve a page of Access Policies.

Operation ID: get-access-policies

Parameters:

X-Aembit-ResourceSet (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/access-policies"

POST /api/v1/access-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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/access-policies"

PUT /api/v1/access-policies

Summary: Update an Access Policy

Description: Update an Access Policy.

Operation ID: put-access-policy

Parameters:

X-Aembit-ResourceSet (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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/access-policies"

POST ‘/api/v1/access-policies/{id}/notes’

Summary: Add a note to an Access Policy

Description: Add a note to an Access Policy.

Operation ID: post-access-policy-note

Parameters:

id (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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/access-policies/{id}/notes'"

Access Policy v2

GET ‘/api/v2/access-policies/{id}’

Summary: Get the identified Access Policy

Description: Get the Access Policy identified by its ID.

Operation ID: get-access-policy-v2

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v2/access-policies/{id}'"

DELETE ‘/api/v2/access-policies/{id}’

Summary: Delete an Access Policy

Description: Delete an Access Policy.

Operation ID: delete-access-policy-v2

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v2/access-policies/{id}'"

PATCH ‘/api/v2/access-policies/{id}’

Summary: Patch an Access Policy

Description: Patch an Access Policy.

Operation ID: patch-access-policy-v2

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v2/access-policies/{id}'"

GET ‘/api/v2/access-policies/getByWorkloadIds/{clientWorkloadId}/{serverWorkloadId}’

Summary: Get the identified Access Policy

Description: Get the Access Policy identified by a Client and Server Workload.

Operation ID: get-access-policy-by-workloads-v2

Parameters:

clientWorkloadId (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v2/access-policies/getByWorkloadIds/{clientWorkloadId}/{serverWorkloadId}'"

GET /api/v2/access-policies

Summary: Get a page of Access Policies

Description: Retrieve a page of Access Policies.

Operation ID: get-access-policies-v2

Parameters:

page (undefined) (optional): any
per-page (undefined) (optional): any
filter (undefined) (optional): any
order (undefined) (optional): any
group-by (undefined) (optional): any
query (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v2/access-policies"

POST /api/v2/access-policies

Summary: Create an Access Policy

Description: Create an Access Policy.

Operation ID: post-access-policy-v2

Request Body: CreatePolicyDTO

Content-Type: application/json
Schema: 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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v2/access-policies"

PUT /api/v2/access-policies

Summary: Update an Access Policy

Description: Update an Access Policy.

Operation ID: put-access-policy-v2

Request Body: CreatePolicyDTO

Content-Type: application/json
Schema: 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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v2/access-policies"

POST ‘/api/v2/access-policies/{id}/notes’

Summary: Add a note to an Access Policy

Description: Add a note to an Access Policy.

Operation ID: post-access-policy-note-v2

Parameters:

id (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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v2/access-policies/{id}/notes'"

GET ‘/api/v2/access-policies/{id}/notes’

Summary: Gets notes for an Access Policy

Description: Retrieves note information for an Access Policy.

Operation ID: get-access-policy-notes-v2

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v2/access-policies/{id}/notes'"

GET ‘/api/v2/access-policies/{id}/credential-mappings’

Summary: Gets a credential mappings of Access Policy

Description: Retrieves credential mappings of Access Policy.

Operation ID: get-access-policy-credential-mappings-v2

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v2/access-policies/{id}/credential-mappings'"

Agent Controller

GET /api/v1/agent-controllers

Summary: Get a page of Agent Controllers

Description: Get a page of Agent Controllers.

Operation ID: get-agent-controllers

Parameters:

page (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/agent-controllers"

POST /api/v1/agent-controllers

Summary: Create an Agent Controller

Description: Create an Agent Controller.

Operation ID: post-agent-controller

Request Body: AgentControllerDTO

Content-Type: application/json
Schema: 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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/agent-controllers"

PUT /api/v1/agent-controllers

Summary: Update an Agent Controller

Description: Update an Agent Controller.

Operation ID: put-agent-controller

Request Body: AgentControllerDTO

Content-Type: application/json
Schema: 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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/agent-controllers"

GET ‘/api/v1/agent-controllers/{id}’

Summary: Get an Agent Controller

Description: Get an Agent Controller identified by its ID.

Operation ID: get-agent-controller

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/agent-controllers/{id}'"

PATCH ‘/api/v1/agent-controllers/{id}’

Summary: Patch an Agent Controller

Description: Patch an Agent Controller identified by its ID.

Operation ID: patch-agent-controller

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/agent-controllers/{id}'"

DELETE ‘/api/v1/agent-controllers/{id}’

Summary: Delete an Agent Controller

Description: Delete an Agent Controller identified by its ID.

Operation ID: delete-agent-controller

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/agent-controllers/{id}'"

POST ‘/api/v1/agent-controllers/{agentControllerExternalId}/device-code’

Summary: Generate a Device Code for an Agent Controller

Description: Generate a Device Code for an Agent Controller.

Operation ID: post-agent-controller-device-code

Parameters:

agentControllerExternalId (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:

curl -X POST \
  "https://your-tenant.aembit-eng.com'/api/v1/agent-controllers/{agentControllerExternalId}/device-code'"

Audit Log

GET /api/v1/audit-logs

Summary: Get a page of Audit Log events

Description: Get a page of Audit Log events.

Operation ID: get-audit-logs

Parameters:

X-Aembit-ResourceSet (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/audit-logs"

GET ‘/api/v1/audit-logs/{id}’

Summary: Get an Audit Log event

Description: Get an Audit Log event identified by its ID.

Operation ID: get-audit-log

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/audit-logs/{id}'"

Access Authorization Event

GET /api/v1/authorization-events

Summary: Get a page of Access Authorization Events

Description: Get a page of Access Authorization Events.

Operation ID: get-access-authorization-events

Parameters:

X-Aembit-ResourceSet (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/authorization-events"

GET ‘/api/v1/authorization-events/{id}’

Summary: Get an Access Authorization Event

Description: Get an Access Authorization Event identified by its ID.

Operation ID: get-access-authorization-event

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/authorization-events/{id}'"

Compliance

GET /api/v1/compliance-settings

Summary: Gets global compliance settings

Description: Gets global compliance settings which control the rules for creating access policy and other entities

Operation ID: get-compliance-settings

Responses:

‘200’: A list of compliance settings
- Content-Type: application/json
- Schema: Array
‘401’: Not Authenticated
‘500’: Internal Server Error
- Content-Type: application/json
- Schema: any

cURL Example:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/compliance-settings"

PUT /api/v1/compliance-settings

Summary: Updates a global compliance setting

Description: Updates a global compliance setting

Operation ID: update-compliance-setting

Request Body: SettingDTO

Content-Type: application/json
Schema: any

Responses:

‘200’: Successfully updated a compliance setting
- Content-Type: application/json
- Schema: any
‘400’: Bad Request
‘401’: Not Authenticated
‘500’: Internal Server Error
- Content-Type: application/json
- Schema: any

cURL Example:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/compliance-settings"

Credential Provider (Deprecated)

GET ‘/api/v1/credential-providers/{id}’

Summary: Get a Credential Provider

Description: Get a Credential Provider identified by its ID.

Operation ID: get-credential-provider

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/credential-providers/{id}'"

DELETE ‘/api/v1/credential-providers/{id}’

Summary: Delete a Credential Provider

Description: Delete a Credential Provider identified by its ID.

Operation ID: delete-credential-provider

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/credential-providers/{id}'"

PATCH ‘/api/v1/credential-providers/{id}’

Summary: Patch a Credential Provider

Description: Patch a Credential Provider.

Operation ID: patch-credential-provider

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/credential-providers/{id}'"

GET ‘/api/v1/credential-providers/{id}/authorize’

Summary: Get a Credential Provider Authorization URL

Description: Get a Credential Provider Authorization URL identified by the Credential Provider ID.

Operation ID: get-credential-provider-authorization

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/credential-providers/{id}/authorize'"

GET /api/v1/credential-providers

Summary: Get a page of Credential Providers

Description: Get a page of Credential Providers.

Operation ID: get-credential-providers

Parameters:

X-Aembit-ResourceSet (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/credential-providers"

POST /api/v1/credential-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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/credential-providers"

PUT /api/v1/credential-providers

Summary: Update a Credential Provider

Description: Update a Credential Provider.

Operation ID: put-credential-provider

Parameters:

X-Aembit-ResourceSet (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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/credential-providers"

GET ‘/api/v1/credential-providers/{id}/verification’

Summary: Verify the Credential Provider

Description: Verify the Credential Provider will successfully return a credential.

Operation ID: get-credential-provider-verification

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/credential-providers/{id}/verification'"

Credential Provider Integration

GET ‘/api/v1/credential-integrations/{id}’

Summary: Get a Credential Provider Integration

Description: Get a Credential Provider Integration identified by its ID.

Operation ID: get-credential-provider-integration

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/credential-integrations/{id}'"

DELETE ‘/api/v1/credential-integrations/{id}’

Summary: Delete a Credential Provider Integration

Description: Delete a Credential Provider Integration identified by its ID.

Operation ID: delete-credential-provider-integration

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/credential-integrations/{id}'"

PATCH ‘/api/v1/credential-integrations/{id}’

Summary: Patch a Credential Provider Integration

Description: Patch a Credential Provider Integration identified by its ID.

Operation ID: patch-credential-provider-integration

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/credential-integrations/{id}'"

GET /api/v1/credential-integrations

Summary: Get a page of Credential Provider Integrations

Description: Get a page of Credential Provider Integrations.

Operation ID: get-credential-provider-integrations

Parameters:

page (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/credential-integrations"

POST /api/v1/credential-integrations

Summary: Create a Credential Provider Integration

Description: Create a Credential Provider Integration.

Operation ID: post-credential-provider-integration

Request Body: CredentialProviderIntegrationDTO

Content-Type: application/json
Schema: 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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/credential-integrations"

PUT /api/v1/credential-integrations

Summary: Update a Credential Provider Integration

Description: Update a Credential Provider Integration.

Operation ID: put-credential-provider-integration

Request Body: CredentialProviderIntegrationDTO

Content-Type: application/json
Schema: 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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/credential-integrations"

GET ‘/api/v1/credential-integrations/list/{type}’

Summary: Get a list of Credential Provider Integrations by type

Description: Get a list of Credential Provider Integrations by type. The most common usage is to populate a dropdown or selection list in the UI.

Operation ID: get-credential-provider-integration-list

Parameters:

type (undefined) (optional): any

Responses:

‘200’: List of Credential Provider Integrations
- Content-Type: application/json
- Schema: Array
‘400’: Bad Request
‘401’: Not Authenticated
‘500’: Internal Server Error
- Content-Type: application/json
- Schema: any

cURL Example:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/credential-integrations/list/{type}'"

Credential Provider v2

POST /api/v2/credential-providers

Summary: Create a Credential Provider

Description: Create a Credential Provider.

Operation ID: post-credential-provider2

Parameters:

X-Aembit-ResourceSet (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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v2/credential-providers"

PUT /api/v2/credential-providers

Summary: Update a Credential Provider

Description: Update a Credential Provider.

Operation ID: put-credential-provider2

Parameters:

X-Aembit-ResourceSet (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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v2/credential-providers"

GET /api/v2/credential-providers

Summary: Get a page of Credential Providers

Description: Get a page of Credential Providers.

Operation ID: get-credential-providers-v2

Parameters:

X-Aembit-ResourceSet (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v2/credential-providers"

GET ‘/api/v2/credential-providers/{id}’

Summary: Get a Credential Provider

Description: Get a Credential Provider identified by its ID.

Operation ID: get-credential-provider2

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v2/credential-providers/{id}'"

DELETE ‘/api/v2/credential-providers/{id}’

Summary: Delete a Credential Provider

Description: Delete a Credential Provider identified by its ID.

Operation ID: delete-credential-provider2

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v2/credential-providers/{id}'"

PATCH ‘/api/v2/credential-providers/{id}’

Summary: Patch a Credential Provider

Description: Patch a Credential Provider.

Operation ID: patch-credential-provider-v2

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v2/credential-providers/{id}'"

GET ‘/api/v2/credential-providers/{id}/verification’

Summary: Verify the Credential Provider

Description: Verify the Credential Provider will successfully return a credential.

Operation ID: get-credential-provider-verification-v2

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v2/credential-providers/{id}/verification'"

GET ‘/api/v2/credential-providers/{id}/authorize’

Summary: Get a Credential Provider Authorization URL

Description: Get a Credential Provider Authorization URL identified by the Credential Provider ID.

Operation ID: get-credential-provider-authorization-v2

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v2/credential-providers/{id}/authorize'"

DiscoveryIntegration

GET /api/v1/discovery-integrations

Summary: Get a page of Integrations

Description: Get a page of Integrations.

Operation ID: get-discovery-integrations

Parameters:

page (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/discovery-integrations"

POST /api/v1/discovery-integrations

Summary: Create an Integration

Description: Create an Integration.

Operation ID: post-discovery-integration

Request Body: DiscoveryIntegrationDTO

Content-Type: application/json
Schema: 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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/discovery-integrations"

PUT /api/v1/discovery-integrations

Summary: Update an Integration

Description: Update an Integration.

Operation ID: put-discovery-integration

Request Body: DiscoveryIntegrationDTO

Content-Type: application/json
Schema: 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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/discovery-integrations"

GET ‘/api/v1/discovery-integrations/{id}’

Summary: Get an Integration

Description: Get an Integration.

Operation ID: get-discovery-integration

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/discovery-integrations/{id}'"

DELETE ‘/api/v1/discovery-integrations/{id}’

Summary: Delete an Integration

Description: Delete an Integration as identified by its ID.

Operation ID: delete-discovery-integration

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/discovery-integrations/{id}'"

PATCH ‘/api/v1/discovery-integrations/{id}’

Summary: Patch an Integration

Description: Patch an Integration as identified by its ID.

Operation ID: patch-discovery-integration

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/discovery-integrations/{id}'"

DiscoveryServerWorkloadDraft

GET ‘/api/alpha/server-workload-drafts/{id}’

Parameters:

id (undefined) (optional): any

Responses:

‘200’: OK

cURL Example:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/alpha/server-workload-drafts/{id}'"

Workload Event

GET /api/v1/workload-events

Summary: Get a page of Workload Events

Description: Get a page of Workload Events.

Operation ID: get-workload-events

Parameters:

X-Aembit-ResourceSet (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/workload-events"

GET ‘/api/v1/workload-events/{id}’

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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/workload-events/{id}'"

Health

GET /api/v1/health

Summary: Aembit Cloud API Health

Description: Get the health of the Aembit Cloud API.

Operation ID: get-health

Responses:

‘200’: API Health
- Content-Type: application/json
- Schema: any

cURL Example:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/health"

Integration

GET /api/v1/integrations

Summary: Get a page of Integrations

Description: Get a page of Integrations.

Operation ID: get-integrations

Parameters:

X-Aembit-ResourceSet (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/integrations"

POST /api/v1/integrations

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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/integrations"

PUT /api/v1/integrations

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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/integrations"

GET ‘/api/v1/integrations/{id}’

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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/integrations/{id}'"

DELETE ‘/api/v1/integrations/{id}’

Summary: Delete an Integration

Description: Delete an Integration as identified by its ID.

Operation ID: delete-integration

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/integrations/{id}'"

PATCH ‘/api/v1/integrations/{id}’

Summary: Patch an Integration

Description: Patch an Integration as identified by its ID.

Operation ID: patch-integration

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/integrations/{id}'"

Log Stream

GET /api/v1/log-streams

Summary: Get a page of Log Streams

Description: Get a page of Log Streams.

Operation ID: get-log-streams

Parameters:

page (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/log-streams"

POST /api/v1/log-streams

Summary: Create a Log Stream

Description: Create a Log Stream.

Operation ID: post-log-stream

Request Body: LogStreamDTO

Content-Type: application/json
Schema: 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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/log-streams"

PUT /api/v1/log-streams

Summary: Update a Log Stream

Description: Update a Log Stream.

Operation ID: put-log-stream

Request Body: LogStreamDTO

Content-Type: application/json
Schema: 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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/log-streams"

GET ‘/api/v1/log-streams/{id}’

Summary: Get a Log Stream

Description: Get a Log Stream identified by its ID.

Operation ID: get-log-stream

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/log-streams/{id}'"

DELETE ‘/api/v1/log-streams/{id}’

Summary: Delete a Log Stream

Description: Delete a Log Stream identified by its ID.

Operation ID: delete-log-stream

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/log-streams/{id}'"

PATCH ‘/api/v1/log-streams/{id}’

Summary: Patch a Log Stream

Description: Patch a Log Stream identified by its ID.

Operation ID: patch-log-stream

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/log-streams/{id}'"

Resource Set

GET ‘/api/v1/resource-sets/{id}’

Summary: Get a Resource Set

Description: Get a Resource Set identified by its ID.

Operation ID: get-resource-set

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/resource-sets/{id}'"

PATCH ‘/api/v1/resource-sets/{id}’

Summary: Patch a Resource Set

Description: Patch a Resource Set identified by its ID.

Operation ID: patch-resource-set

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/resource-sets/{id}'"

GET /api/v1/resource-sets

Summary: Get a page of Resource Sets

Description: Get a page of Resource Sets.

Operation ID: get-resource-sets

Parameters:

page (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/resource-sets"

POST /api/v1/resource-sets

Summary: Create a Resource Set

Description: Create a Resource Set.

Operation ID: post-resource-set

Request Body: ResourceSetDTO

Content-Type: application/json
Schema: 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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/resource-sets"

PUT /api/v1/resource-sets

Summary: Update a Resource Set

Description: Update a Resource Set.

Operation ID: put-resource-set

Request Body: ResourceSetDTO

Content-Type: application/json
Schema: 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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/resource-sets"

Role

GET /api/v1/roles

Summary: Get a page of Roles

Description: Get a page of Roles.

Operation ID: get-roles

Parameters:

page (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/roles"

POST /api/v1/roles

Summary: Create a new Role

Description: Create a new Role.

Operation ID: post-role

Request Body: RoleDTO

Content-Type: application/json
Schema: 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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/roles"

PUT /api/v1/roles

Summary: Update a Role

Description: Update a Role.

Operation ID: put-role

Request Body: RoleDTO

Content-Type: application/json
Schema: 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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/roles"

GET ‘/api/v1/roles/{id}’

Summary: Get a Role

Description: Get a Role identified by its ID.

Operation ID: get-role

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/roles/{id}'"

DELETE ‘/api/v1/roles/{id}’

Summary: Delete a Role

Description: Delete a Role identified by its ID.

Operation ID: delete-role

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/roles/{id}'"

PATCH ‘/api/v1/roles/{id}’

Summary: Patch a Role

Description: Patch a Role identified by its ID.

Operation ID: patch-role

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/roles/{id}'"

Routing

GET ‘/api/v1/routings/{id}’

Summary: Get a Routing

Description: Get a Routing identified by its ID.

Operation ID: get-routing

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/routings/{id}'"

PATCH ‘/api/v1/routings/{id}’

Summary: Patch a Routing

Description: Patch a Routing identified by its ID.

Operation ID: patch-routing

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/routings/{id}'"

GET /api/v1/routings

Summary: Get a page of Routings

Description: Get a page of Routings.

Operation ID: get-routings

Parameters:

page (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/routings"

POST /api/v1/routings

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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/routings"

PUT /api/v1/routings

Summary: Update a Routing

Description: Update a Routing.

Operation ID: put-routing

Request Body: RoutingDTO

Content-Type: application/json
Schema: 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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/routings"

SignOn Policy

GET /api/v1/signin-policies

Summary: Get a SignOn Policy

Description: Get a SignOn Policy by its name.

Operation ID: get-signon-policy

Responses:

‘200’: SignOn Policy
- Content-Type: application/json
- Schema: any
‘204’: SignOn Policy Not Found
‘400’: Bad Request
‘401’: Not Authenticated
‘500’: Internal Server Error
- Content-Type: application/json
- Schema: any

cURL Example:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/signin-policies"

MFA SignOn Policy

PUT /api/v1/signin-policies/mfa

Summary: Update a MFA SignOn Policy

Description: Update a MFA SignOn Policy.

Operation ID: put-mfa-signon Policy

Request Body: MFASignInPolicyDTO

Content-Type: application/json
Schema: 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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/signin-policies/mfa"

SSO SignOn Policy

PUT /api/v1/signin-policies/sso

Summary: Update a SSO SignOn Policy

Description: Update a SSO SignOn Policy.

Operation ID: put-SSO-signon Policy

Request Body: SSOSignInPolicyDTO

Content-Type: application/json
Schema: 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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/signin-policies/sso"

SSO Identity Provider

GET ‘/api/v1/sso-idps/{id}/verification’

Summary: Verify the SSO Identity Provider

Description: Verify the SSO Identity Provider has all necessary configuration data.

Operation ID: get-identity-provider-verification

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/sso-idps/{id}/verification'"

GET ‘/api/v1/sso-idps/{id}’

Summary: Get a SSO Identity Provider

Description: Get a SSO Identity Provider identified by its ID.

Operation ID: get-identity-provider

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/sso-idps/{id}'"

DELETE ‘/api/v1/sso-idps/{id}’

Summary: Delete a SSO Identity Provider

Description: Delete a SSO Identity Provider identified by its ID.

Operation ID: delete-identity-provider

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/sso-idps/{id}'"

PATCH ‘/api/v1/sso-idps/{id}’

Summary: Patch a SSO Identity Provider

Description: Patch a SSO Identity Provider identified by its ID.

Operation ID: patch-identity-provider

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/sso-idps/{id}'"

GET /api/v1/sso-idps

Summary: Get a page of SSO Identity Providers

Description: Get a page of SSO Identity Providers.

Operation ID: get-identity-providers

Parameters:

page (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/sso-idps"

POST /api/v1/sso-idps

Summary: Create a SSO Identity Provider

Description: Create a SSO Identity Provider.

Operation ID: post-identity-provider

Request Body: SSOIdentityProviderDTO

Content-Type: application/json
Schema: 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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/sso-idps"

PUT /api/v1/sso-idps

Summary: Update a SSO Identity Provider

Description: Update a SSO Identity Provider.

Operation ID: put-identity-provider

Request Body: SSOIdentityProviderDTO

Content-Type: application/json
Schema: 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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/sso-idps"

Standalone Certificate Authority

DELETE ‘/api/v1/certificate-authorities/{id}’

Summary: Delete a Standalone Certificate Authority

Description: Delete a Standalone Certificate Authority identified by its ID.

Operation ID: delete-standalone-certificate-authority

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/certificate-authorities/{id}'"

GET ‘/api/v1/certificate-authorities/{id}’

Summary: Get a Standalone Certificate Authority

Description: Get a Standalone Certificate Authority identified by its ID.

Operation ID: get-standalone-certificate-authority

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/certificate-authorities/{id}'"

PATCH ‘/api/v1/certificate-authorities/{id}’

Summary: Patch a Standalone Certificate Authority

Description: Patch a Standalone Certificate Authority identified by its ID.

Operation ID: patch-standalone-certificate-authority

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/certificate-authorities/{id}'"

GET /api/v1/certificate-authorities

Summary: Get a page of Standalone Certificate Authorities

Description: Get a page of Standalone Certificate Authorities.

Operation ID: get-standalone-certificate-authorities

Parameters:

page (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/certificate-authorities"

POST /api/v1/certificate-authorities

Summary: Create a Standalone Certificate Authority

Description: Create a Standalone Certificate Authority.

Operation ID: post-standalone-certificate-authority

Request Body: StandaloneCertificateDTO

Content-Type: application/json
Schema: 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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/certificate-authorities"

PUT /api/v1/certificate-authorities

Summary: Update a Standalone Certificate Authority

Description: Update a Standalone Certificate Authority.

Operation ID: put-standalone-certificate-authority

Request Body: StandaloneCertificateDTO

Content-Type: application/json
Schema: 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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/certificate-authorities"

Standalone TLS Decrypt

GET ‘/api/v1/certificate-authorities/{id}/root-ca’

Summary: Download Standalone Root CA Certificate

Description: Download the Standalone Root CA Certificate. This CA Certificate can be used for TLS verification when utilizing the Aembit TLS Decrypt feature.

Operation ID: standalone-root-ca

Parameters:

id (undefined) (optional): any

Responses:

‘200’: OK
- Content-Type: application/x-pem-file
- Schema: string (binary)

cURL Example:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/certificate-authorities/{id}/root-ca'"

TLS Decrypt

GET /api/v1/root-ca

Summary: Download Tenant Root CA Certificate

Description: Download the Tenant Root CA Certificate. This CA Certificate can be used for TLS verification when utilizing the Aembit TLS Decrypt feature.

Operation ID: root-ca

Responses:

‘200’: OK
- Content-Type: application/x-pem-file
- Schema: string (binary)

cURL Example:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/root-ca"

Trust Provider

GET /api/v1/trust-providers

Summary: Get a page of Trust Providers

Description: Get a page of Trust Providers.

Operation ID: get-trust-providers

Parameters:

X-Aembit-ResourceSet (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/trust-providers"

POST /api/v1/trust-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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/trust-providers"

PUT /api/v1/trust-providers

Summary: Update a Trust Provider

Description: Update a Trust Provider.

Operation ID: put-trust-provider

Parameters:

X-Aembit-ResourceSet (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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/trust-providers"

GET ‘/api/v1/trust-providers/{id}’

Summary: Get a Trust Provider

Description: Get a Trust Provider identified by its ID.

Operation ID: get-trust-provider

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/trust-providers/{id}'"

DELETE ‘/api/v1/trust-providers/{id}’

Summary: Delete a Trust Provider

Description: Delete a Trust Provider identified by its ID.

Operation ID: delete-trust-provider

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/trust-providers/{id}'"

PATCH ‘/api/v1/trust-providers/{id}’

Summary: Patch a Trust Provider

Description: Patch a Trust Provider.

Operation ID: patch-trust-provider

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/trust-providers/{id}'"

User

GET /api/v1/users

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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/users"

POST /api/v1/users

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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/users"

PATCH ‘/api/v1/users/{id}’

Summary: Patch a User

Description: Patch a User identified by its ID.

Operation ID: patch-user

Parameters:

id (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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/users/{id}'"

GET ‘/api/v1/users/{id}’

Summary: Get a User

Description: Get a User identified by its ID.

Operation ID: get-user

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/users/{id}'"

PUT ‘/api/v1/users/{id}’

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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/users/{id}'"

DELETE ‘/api/v1/users/{id}’

Summary: Delete a User

Description: Delete a User identified by its ID.

Operation ID: delete-user

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/users/{id}'"

POST ‘/api/v1/users/{id}/unlock’

Summary: Unlock a User

Description: Unlock a User identified by its ID.

Operation ID: post-user-unlock

Parameters:

id (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:

curl -X POST \
  "https://your-tenant.aembit-eng.com'/api/v1/users/{id}/unlock'"

Server Workload

POST /api/v1/server-workloads

Summary: Create a Server Workload

Description: Create a Server Workload.

Operation ID: post-server-workload

Parameters:

X-Aembit-ResourceSet (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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/server-workloads"

PUT /api/v1/server-workloads

Summary: Update a Server Workload

Description: Update a Server Workload.

Operation ID: put-server-workload

Parameters:

X-Aembit-ResourceSet (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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/server-workloads"

GET /api/v1/server-workloads

Summary: Get a page of Server Workloads

Description: Get a page of Server Workloads.

Operation ID: get-server-workloads

Parameters:

X-Aembit-ResourceSet (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/server-workloads"

PATCH ‘/api/v1/server-workloads/{id}’

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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/server-workloads/{id}'"

GET ‘/api/v1/server-workloads/{id}’

Summary: Get a Server Workload

Description: Get a Server Workload identified by its ID.

Operation ID: get-server-workload

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/server-workloads/{id}'"

DELETE ‘/api/v1/server-workloads/{id}’

Summary: Delete a Server Workload

Description: Delete a Server Workload identified by its ID.

Operation ID: delete-server-workload

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/server-workloads/{id}'"

Client Workload

POST /api/v1/client-workloads

Summary: Create a Client Workload

Description: Create a Client Workload.

Operation ID: post-client-workload

Parameters:

X-Aembit-ResourceSet (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:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/client-workloads"

PUT /api/v1/client-workloads

Summary: Update a Client Workload

Description: Update a Client Workload.

Operation ID: put-client-workload

Parameters:

X-Aembit-ResourceSet (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:

curl -X PUT \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com/api/v1/client-workloads"

GET /api/v1/client-workloads

Summary: Get a page of Client Workloads

Description: Get a page of Client Workloads.

Operation ID: get-client-workloads

Parameters:

X-Aembit-ResourceSet (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/client-workloads"

PATCH ‘/api/v1/client-workloads/{id}’

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:

curl -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}' \
  "https://your-tenant.aembit-eng.com'/api/v1/client-workloads/{id}'"

GET ‘/api/v1/client-workloads/{id}’

Summary: Get a Client Workload

Description: Get a Client Workload identified by its ID.

Operation ID: get-client-workload

Parameters:

id (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:

curl -X GET \
  "https://your-tenant.aembit-eng.com'/api/v1/client-workloads/{id}'"

DELETE ‘/api/v1/client-workloads/{id}’

Summary: Delete a Client Workload

Description: Delete a Client Workload identified by its ID.

Operation ID: delete-client-workload

Parameters:

id (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:

curl -X DELETE \
  "https://your-tenant.aembit-eng.com'/api/v1/client-workloads/{id}'"

GET /api/v1/client-workloads/identifiers

Summary: Get Client Identifier List

Description: Get list of client identifier objects

Operation ID: get-client-identifiers

Responses:

‘200’: Client Identifiers
- Content-Type: application/json
- Schema: Array
‘204’: Client Identifiers Not Found
‘400’: Bad Request
‘401’: Not Authenticated

cURL Example:

curl -X GET \
  "https://your-tenant.aembit-eng.com/api/v1/client-workloads/identifiers"