Skip to content

UAP database policy SDK workflow

Here is an example workflow for adding a UAP DB policy alongside all needed assets via the SDK:

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
package main

import (
    "fmt"
    "github.com/cyberark/ark-sdk-golang/pkg/auth"
    authmodels "github.com/cyberark/ark-sdk-golang/pkg/models/auth"
    commonmodels "github.com/cyberark/ark-sdk-golang/pkg/models/common"
    dbsecretsmodels "github.com/cyberark/ark-sdk-golang/pkg/services/sia/secrets/db/models"
    dbmodels "github.com/cyberark/ark-sdk-golang/pkg/services/sia/workspaces/db/models"
    commonuapmodels "github.com/cyberark/ark-sdk-golang/pkg/services/uap/common/models"
    uapsia "github.com/cyberark/ark-sdk-golang/pkg/services/uap/sia/common/models"
    uapdbmodels "github.com/cyberark/ark-sdk-golang/pkg/services/uap/sia/db/models"
    "github.com/cyberark/ark-sdk-golang/pkg/services/sia"
    "github.com/cyberark/ark-sdk-golang/pkg/services/uap"
    "os"
)

func main() {
    // Perform authentication using ArkISPAuth to the platform
    // First, create an ISP authentication class
    // Afterwards, perform the authentication
    ispAuth := auth.NewArkISPAuth(false)
    _, err := ispAuth.Authenticate(
        nil,
        &authmodels.ArkAuthProfile{
            Username:           "user@cyberark.cloud.12345",
            AuthMethod:         authmodels.Identity,
            AuthMethodSettings: &authmodels.IdentityArkAuthMethodSettings{},
        },
        &authmodels.ArkSecret{
            Secret: os.Getenv("ARK_SECRET"),
        },
        false,
        false,
    )
    if err != nil {
        panic(err)
    }

    uapAPI, err := uap.NewArkUAPAPI(ispAuth.(*auth.ArkISPAuth))
    if err != nil {
        panic(err)
    }
    siaAPI, err := sia.NewArkSIAAPI(ispAuth.(*auth.ArkISPAuth))
    if err != nil {
        panic(err)
    }

    secret, err := siaAPI.SecretsDB().AddSecret(
        &dbsecretsmodels.ArkSIADBAddSecret{
            SecretType: "username_password",
            Username:   "CoolUser",
            Password:   "CoolPassword",
        },
    )
    if err != nil {
        panic(err)
    }
    fmt.Println("Secret ID:", secret.SecretID)

    // Add the database with the created secret
    database, err := siaAPI.WorkspacesDB().AddDatabase(
        &dbmodels.ArkSIADBAddDatabase{
            Name:              "MyDatabase",
            ProviderEngine:    dbmodels.EngineTypeAuroraMysql,
            ReadWriteEndpoint: "myrds.com",
            SecretID:          secret.SecretID,
        },
    )

    if err != nil {
        panic(err)
    }
    fmt.Printf("Database: %v\n", database)

    policy, err := uapAPI.Db().AddPolicy(
        &uapdbmodels.ArkUAPSIADBAccessPolicy{
            ArkUAPSIACommonAccessPolicy: uapsia.ArkUAPSIACommonAccessPolicy{
                ArkUAPCommonAccessPolicy: commonuapmodels.ArkUAPCommonAccessPolicy{
                    Metadata: commonuapmodels.ArkUAPMetadata{
                        Name:        "Example DB Access Policy",
                        Description: "This is an example of a DB access policy for SIA.",
                        Status: commonuapmodels.ArkUAPPolicyStatus{
                            Status: commonuapmodels.StatusTypeActive,
                        },
                        PolicyEntitlement: commonuapmodels.ArkUAPPolicyEntitlement{
                            TargetCategory: commonmodels.CategoryTypeDB,
                            LocationType:   commonmodels.WorkspaceTypeFQDNIP,
                            PolicyType:     commonuapmodels.PolicyTypeRecurring,
                        },
                        PolicyTags: []string{},
                    },
                    Principals: []commonuapmodels.ArkUAPPrincipal{
                        {
                            Type:                commonuapmodels.PrincipalTypeUser,
                            ID:                  "user-id",
                            Name:                "user@cyberark.cloud.12345",
                            SourceDirectoryName: "CyberArk",
                            SourceDirectoryID:   "12345",
                        },
                    },
                },
                Conditions: uapsia.ArkUAPSIACommonConditions{
                    ArkUAPConditions: commonuapmodels.ArkUAPConditions{
                        AccessWindow: commonuapmodels.ArkUAPTimeCondition{
                            DaysOfTheWeek: []int{1, 2, 3, 4, 5},
                            FromHour:      "09:00",
                            ToHour:        "17:00",
                        },
                        MaxSessionDuration: 4,
                    },
                    IdleTime: 10,
                },
            },
            Targets: map[string]uapdbmodels.ArkUAPSIADBTargets{
                commonmodels.WorkspaceTypeFQDNIP: {
                    Instances: []uapdbmodels.ArkUAPSIADBInstanceTarget{
                        {
                            InstanceName:         database.Name,
                            InstanceType:         database.ProviderDetails.Family,
                            InstanceID:           string(rune(database.ID)),
                            AuthenticationMethod: uapdbmodels.AuthMethodDBAuth,
                            DBAuthProfile: &uapdbmodels.ArkUAPSIADBDBAuthProfile{
                                Roles: []string{"db_reader", "db_writer"},
                            },
                        },
                    },
                },
            },
        },
    )
    if err != nil {
        panic(err)
    }
    fmt.Printf("Policy created successfully: %s\n", policy.Metadata.PolicyID)
}

In the script above, the following actions are defined:

  • The admin user is logged in to perform actions on the tenant
  • we then configure SIA's secret, database and UAP DB policy