Skip to main content

CreatePolicyDTO

Create/Update 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

    credentialProviders object[]nullable

    Credential Providers associated with this Access Policy

  • Array [
  • credentialProviderIduuidrequired

    CredentialProviderId

    mappingTypePolicyCredentialProviderMappingTypes (string)required

    Possible values: [None, AccountName, HttpHeader, HttpBody]

    accountNamestringnullable

    Snowflake Username

    Possible values: <= 256 characters, Value must match regular expression ^[\p{L}a-zA-Z0-9][\p{L}a-zA-Z0-9._-]*$

    headerNamestringnullable

    Header Name

    Possible values: <= 256 characters, Value must match regular expression ^[\p{L}a-zA-Z0-9][\p{L}a-zA-Z0-9._-]*$

    headerValuestringnullable

    Header Value

    Possible values: <= 256 characters, Value must match regular expression ^[\p{L}a-zA-Z0-9][\p{L}a-zA-Z0-9._-]*$

    httpbodyFieldPathstringnullable

    HttpBody Field Path

    Possible values: <= 256 characters, Value must match regular expression ^[\p{L}a-zA-Z0-9][\p{L}a-zA-Z0-9._-]*$

    httpbodyFieldValuestringnullable

    HttpBody Field Value

    Possible values: <= 256 characters, Value must match regular expression ^[\p{L}a-zA-Z0-9][\p{L}a-zA-Z0-9._-]*$

  • ]
  • trustProvidersuuid[]nullable

    Trust Providers associated with this Access Policy

    accessConditionsuuid[]nullable

    Access Conditions associated with this Access Policy

    clientWorkloaduuidrequired

    Client Workload associated with this Access Policy

    serverWorkloaduuidrequired

    Server Workload associated with this Access Policy

    CreatePolicyDTO
    {
    "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",
    "credentialProviders": [
    {
    "credentialProviderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "mappingType": "None",
    "accountName": "string",
    "headerName": "string",
    "headerValue": "string",
    "httpbodyFieldPath": "string",
    "httpbodyFieldValue": "string"
    }
    ],
    "trustProviders": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "accessConditions": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "clientWorkload": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "serverWorkload": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }