PolicyExternalDTO

Individual Access Policy

externalIduuid

namestringrequired

Name of the Entity

Possible values: non-empty and <= 128 characters

descriptionstringnullable

Description of the Entity

isActivebooleanrequired

True/False value that determines if this entity is Active or Disabled

tags object[]nullable

Array [

keystringrequired

Tag Key

Possible values: non-empty

valuestringrequired

Tag Key Value

Possible values: non-empty

]

createdAtdate-time

modifiedAtdate-timenullable

createdBystringnullable

modifiedBystringnullable

resourceSetuuidrequired

ID of the Resource Set in which this Access Entity exists

clientWorkload object

externalIduuid

namestringrequired

Name of the Entity

Possible values: non-empty and <= 128 characters

descriptionstringnullable

Description of the Entity

isActivebooleanrequired

True/False value that determines if this entity is Active or Disabled

tags object[]nullable

Array [

keystringrequired

Tag Key

Possible values: non-empty

valuestringrequired

Tag Key Value

Possible values: non-empty

]

createdAtdate-time

modifiedAtdate-timenullable

createdBystringnullable

modifiedBystringnullable

resourceSetuuidrequired

ID of the Resource Set in which this Access Entity exists

identities object[]nullable

Array [

typestringnullable

Possible values: <= 255 characters

valuestringrequired

Possible values: non-empty and <= 255 characters

]

standaloneCertificateAuthorityuuidnullable

Standalone Certificate Authority associated with this Client Workload

typestringnullable

accessPolicyCountint32

Access Policies associated with this Client Workload

trustProviders object[]nullable

Details of the Trust Providers associated with this Access Policy

Array [

externalIduuid

namestringrequired

Name of the Entity

Possible values: non-empty and <= 128 characters

descriptionstringnullable

Description of the Entity

isActivebooleanrequired

True/False value that determines if this entity is Active or Disabled

tags object[]nullable

Array [

keystringrequired

Tag Key

Possible values: non-empty

valuestringrequired

Tag Key Value

Possible values: non-empty

]

createdAtdate-time

modifiedAtdate-timenullable

createdBystringnullable

modifiedBystringnullable

resourceSetuuidrequired

ID of the Resource Set in which this Access Entity exists

idint32

Trust Provider Id

providerstringrequired

Trust Provider Type

Possible values: non-empty

matchRules object[]nullable

Trust Provider Match Rules

Array [

attributestringrequired

Match Rule Attribute

Possible values: non-empty

valuestringrequired

Match Rule Attribute Value

Possible values: non-empty

]

certificatestringnullable

Trust Provider Certificate or Public Key for cryptographic attestation

publicKeyValidation object

Response to a request for Public Key Validation

isValidContentboolean

True if the Public Key was valid, False otherwise

thumbprintstringnullable

Thumbprint of the Public Key

expirationDatestringnullable

Expiration of the Public Key Certificate

certificateSubjectstringnullable

Subject of the Public Key Certificate

messagestringnullable

Message describing why the Public Key was not valid if IsValidContent is False

oidcUrlstringnullable

OIDC URL to use for retrieving JWKS Public Keys

pemTypestringnullable

PEM Input Type

accessPolicyCountint32

Access Policies associated with this Trust Provider

agentControllersCountint32

Agent Controllers associated with this Trust Provider

agentControllerIdsuuid[]nullable

Agent Controller IDs associated with this Trust Provider

]

accessConditions object[]nullable

Details of the Access Conditions associated with this Access Policy

Array [

externalIduuid

namestringrequired

Name of the Entity

Possible values: non-empty and <= 128 characters

descriptionstringnullable

Description of the Entity

isActivebooleanrequired

True/False value that determines if this entity is Active or Disabled

tags object[]nullable

Array [

keystringrequired

Tag Key

Possible values: non-empty

valuestringrequired

Tag Key Value

Possible values: non-empty

]

createdAtdate-time

modifiedAtdate-timenullable

createdBystringnullable

modifiedBystringnullable

resourceSetuuidrequired

ID of the Resource Set in which this Access Entity exists

integrationIDuuid

ID of the Integration Entity used by this Access Condition

integration object

Integration details for 3rd party data used by Access Conditions

externalIduuid

namestringrequired

Name of the Entity

Possible values: non-empty and <= 128 characters

descriptionstringnullable

Description of the Entity

isActivebooleanrequired

True/False value that determines if this entity is Active or Disabled

tags object[]nullable

Array [

keystringrequired

Tag Key

Possible values: non-empty

valuestringrequired

Tag Key Value

Possible values: non-empty

]

createdAtdate-time

modifiedAtdate-timenullable

createdBystringnullable

modifiedBystringnullable

resourceSetuuidrequired

ID of the Resource Set in which this Access Entity exists

typestringrequired

Possible values: non-empty

syncFrequencySecondsint32required

Possible values: >= 300 and <= 3600

lastSyncdate-timenullable

lastSyncStatusstringnullable

endpointstringrequired

Possible values: non-empty

integrationJSON objectrequired

property name* JsonNode

options object

propertyNameCaseInsensitiveboolean

parent

root

accessConditionsCountint32

conditions objectrequired

Rules which are enforced by the Access Condition

property name* JsonNode

options object

propertyNameCaseInsensitiveboolean

parent

root

accessPolicyCountint32

Access Policies associated with this Access Condition

]

credentialProvider object

Individual Credential Provider

externalIduuid

namestringrequired

Name of the Entity

Possible values: non-empty and <= 128 characters

descriptionstringnullable

Description of the Entity

isActivebooleanrequired

True/False value that determines if this entity is Active or Disabled

tags object[]nullable

Array [

keystringrequired

Tag Key

Possible values: non-empty

valuestringrequired

Tag Key Value

Possible values: non-empty

]

createdAtdate-time

modifiedAtdate-timenullable

createdBystringnullable

modifiedBystringnullable

resourceSetuuidrequired

ID of the Resource Set in which this Access Entity exists

typestringrequired

Credential Provider Type (e.g. oauth-client-credential, username-password, etc.)

Possible values: non-empty

roleIduuidnullable

Credential Provider Role for use with Aembit Access Token type Credential Providers

lifetimeTimeSpanSecondsint32

The Lifetime of a Credential Provider's credential value

lifetimeExpirationdate-timenullable

The expiration timestamp for a Credential Provider's credential value

providerDetailJSONstringnullable

JSON representation of the Credential Provider configuration details

accessPolicyCountint32

Access Policies associated with this Credential Provider

serverWorkload object

Individual Server Workload

externalIduuid

namestringrequired

Name of the Entity

Possible values: non-empty and <= 128 characters

descriptionstringnullable

Description of the Entity

isActivebooleanrequired

True/False value that determines if this entity is Active or Disabled

tags object[]nullable

Array [

keystringrequired

Tag Key

Possible values: non-empty

valuestringrequired

Tag Key Value

Possible values: non-empty

]

createdAtdate-time

modifiedAtdate-timenullable

createdBystringnullable

modifiedBystringnullable

resourceSetuuidrequired

ID of the Resource Set in which this Access Entity exists

serviceEndpoint objectrequired

Service Endpoint for a Server Workload

externalIdstringnullable

External ID of the Service Endpoint

idint32

ID of the Service Endpoint

hoststringrequired

Hostname or IP Address

Possible values: non-empty

appProtocolstringrequired

Application Protocol

Possible values: non-empty

transportProtocolstringrequired

Transport Protocol (e.g. TCP)

Possible values: <= 3 characters

requestedPortint32required

The target port as specified by the Client Workload

Possible values: >= 1 and <= 65535

requestedTlsbooleanrequired

The TLS encryption configuration of the Client Workload

portint32required

The target port to which the Agent/Proxy will communicate

Possible values: >= 1 and <= 65535

tlsbooleanrequired

The TLS encryption configuration which will be used by the Agent/Proxy

workloadServiceAuthentication object

Authentication configuration for a Server Workload

methodstringrequired

Authentication Method

Possible values: non-empty

schemestringrequired

Authentication Scheme

Possible values: non-empty

configstringnullable

Authentication Configuration

tlsVerificationstringrequired

TLS Verification configuration for the Agent/Proxy to Server Workload connection

Possible values: non-empty

httpHeaders object[]nullable

Static HTTP Headers to include for transmission to the Server Workload

Array [

keystringnullable

valuestringnullable

]

typestringnullable

Type of Server Workload

accessPolicyCountint32

Access Policies associated with this Server Workload

policyNotes object[]nullable

Policy Notes for this Access Policy

Array [

notestringrequired

Note added to an Access Policy by a User

Possible values: non-empty and <= 1024 characters

createdAtdate-time

Timestamp the Note was created

createdBystringnullable

Email address of the User who created the Access Policy Note

]

PolicyExternalDTO

{
  "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "isActive": true,
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "createdAt": "2024-07-29T15:51:28.071Z",
  "modifiedAt": "2024-07-29T15:51:28.071Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "resourceSet": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientWorkload": {
    "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "isActive": true,
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "createdAt": "2024-07-29T15:51:28.071Z",
    "modifiedAt": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "resourceSet": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "identities": [
      {
        "type": "string",
        "value": "string"
      }
    ],
    "standaloneCertificateAuthority": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string",
    "accessPolicyCount": 0
  },
  "trustProviders": [
    {
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "isActive": true,
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "createdAt": "2024-07-29T15:51:28.071Z",
      "modifiedAt": "2024-07-29T15:51:28.071Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "resourceSet": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "id": 0,
      "provider": "string",
      "matchRules": [
        {
          "attribute": "string",
          "value": "string"
        }
      ],
      "certificate": "string",
      "publicKeyValidation": {
        "isValidContent": true,
        "thumbprint": "string",
        "expirationDate": "string",
        "certificateSubject": "string",
        "message": "string"
      },
      "oidcUrl": "string",
      "pemType": "string",
      "accessPolicyCount": 0,
      "agentControllersCount": 0,
      "agentControllerIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ]
    }
  ],
  "accessConditions": [
    {
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "isActive": true,
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "createdAt": "2024-07-29T15:51:28.071Z",
      "modifiedAt": "2024-07-29T15:51:28.071Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "resourceSet": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "integrationID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "integration": {
        "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string",
        "isActive": true,
        "tags": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "createdAt": "2024-07-29T15:51:28.071Z",
        "modifiedAt": "2024-07-29T15:51:28.071Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "resourceSet": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "string",
        "syncFrequencySeconds": 0,
        "lastSync": "2024-07-29T15:51:28.071Z",
        "lastSyncStatus": "string",
        "endpoint": "string",
        "integrationJSON": {},
        "accessConditionsCount": 0
      },
      "conditions": {},
      "accessPolicyCount": 0
    }
  ],
  "credentialProvider": {
    "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "isActive": true,
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "createdAt": "2024-07-29T15:51:28.071Z",
    "modifiedAt": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "resourceSet": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string",
    "roleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "lifetimeTimeSpanSeconds": 0,
    "lifetimeExpiration": "2024-07-29T15:51:28.071Z",
    "providerDetailJSON": "string",
    "accessPolicyCount": 0
  },
  "serverWorkload": {
    "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "isActive": true,
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "createdAt": "2024-07-29T15:51:28.071Z",
    "modifiedAt": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "resourceSet": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "serviceEndpoint": {
      "externalId": "string",
      "id": 0,
      "host": "string",
      "appProtocol": "string",
      "transportProtocol": "string",
      "requestedPort": 0,
      "requestedTls": true,
      "port": 0,
      "tls": true,
      "workloadServiceAuthentication": {
        "method": "string",
        "scheme": "string",
        "config": "string"
      },
      "tlsVerification": "string",
      "httpHeaders": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    },
    "type": "string",
    "accessPolicyCount": 0
  },
  "policyNotes": [
    {
      "note": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "createdBy": "string"
    }
  ]
}