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 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803
|
// This file was automatically generated. DO NOT EDIT.
// If you have any remark or suggestion do not hesitate to open an issue.
// Package secret provides methods and message types of the secret v1beta1 API.
package secret
import (
"bytes"
"encoding/json"
"fmt"
"net"
"net/http"
"net/url"
"strings"
"time"
"github.com/scaleway/scaleway-sdk-go/errors"
"github.com/scaleway/scaleway-sdk-go/marshaler"
"github.com/scaleway/scaleway-sdk-go/namegenerator"
"github.com/scaleway/scaleway-sdk-go/parameter"
"github.com/scaleway/scaleway-sdk-go/scw"
)
// always import dependencies
var (
_ fmt.Stringer
_ json.Unmarshaler
_ url.URL
_ net.IP
_ http.Header
_ bytes.Reader
_ time.Time
_ = strings.Join
_ scw.ScalewayRequest
_ marshaler.Duration
_ scw.File
_ = parameter.AddToQuery
_ = namegenerator.GetRandomName
)
type BrowseSecretsRequestOrderBy string
const (
BrowseSecretsRequestOrderByNameAsc = BrowseSecretsRequestOrderBy("name_asc")
BrowseSecretsRequestOrderByNameDesc = BrowseSecretsRequestOrderBy("name_desc")
BrowseSecretsRequestOrderByCreatedAtAsc = BrowseSecretsRequestOrderBy("created_at_asc")
BrowseSecretsRequestOrderByCreatedAtDesc = BrowseSecretsRequestOrderBy("created_at_desc")
BrowseSecretsRequestOrderByUpdatedAtAsc = BrowseSecretsRequestOrderBy("updated_at_asc")
BrowseSecretsRequestOrderByUpdatedAtDesc = BrowseSecretsRequestOrderBy("updated_at_desc")
)
func (enum BrowseSecretsRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "name_asc"
}
return string(enum)
}
func (enum BrowseSecretsRequestOrderBy) Values() []BrowseSecretsRequestOrderBy {
return []BrowseSecretsRequestOrderBy{
"name_asc",
"name_desc",
"created_at_asc",
"created_at_desc",
"updated_at_asc",
"updated_at_desc",
}
}
func (enum BrowseSecretsRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *BrowseSecretsRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = BrowseSecretsRequestOrderBy(BrowseSecretsRequestOrderBy(tmp).String())
return nil
}
type EphemeralPolicyAction string
const (
EphemeralPolicyActionUnknownAction = EphemeralPolicyAction("unknown_action")
// The version is deleted once it expires.
EphemeralPolicyActionDelete = EphemeralPolicyAction("delete")
// The version is disabled once it expires.
EphemeralPolicyActionDisable = EphemeralPolicyAction("disable")
)
func (enum EphemeralPolicyAction) String() string {
if enum == "" {
// return default value if empty
return "unknown_action"
}
return string(enum)
}
func (enum EphemeralPolicyAction) Values() []EphemeralPolicyAction {
return []EphemeralPolicyAction{
"unknown_action",
"delete",
"disable",
}
}
func (enum EphemeralPolicyAction) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *EphemeralPolicyAction) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = EphemeralPolicyAction(EphemeralPolicyAction(tmp).String())
return nil
}
type ListSecretsRequestOrderBy string
const (
ListSecretsRequestOrderByNameAsc = ListSecretsRequestOrderBy("name_asc")
ListSecretsRequestOrderByNameDesc = ListSecretsRequestOrderBy("name_desc")
ListSecretsRequestOrderByCreatedAtAsc = ListSecretsRequestOrderBy("created_at_asc")
ListSecretsRequestOrderByCreatedAtDesc = ListSecretsRequestOrderBy("created_at_desc")
ListSecretsRequestOrderByUpdatedAtAsc = ListSecretsRequestOrderBy("updated_at_asc")
ListSecretsRequestOrderByUpdatedAtDesc = ListSecretsRequestOrderBy("updated_at_desc")
)
func (enum ListSecretsRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "name_asc"
}
return string(enum)
}
func (enum ListSecretsRequestOrderBy) Values() []ListSecretsRequestOrderBy {
return []ListSecretsRequestOrderBy{
"name_asc",
"name_desc",
"created_at_asc",
"created_at_desc",
"updated_at_asc",
"updated_at_desc",
}
}
func (enum ListSecretsRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListSecretsRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListSecretsRequestOrderBy(ListSecretsRequestOrderBy(tmp).String())
return nil
}
type Product string
const (
ProductUnknownProduct = Product("unknown_product")
ProductEdgeServices = Product("edge_services")
)
func (enum Product) String() string {
if enum == "" {
// return default value if empty
return "unknown_product"
}
return string(enum)
}
func (enum Product) Values() []Product {
return []Product{
"unknown_product",
"edge_services",
}
}
func (enum Product) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *Product) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = Product(Product(tmp).String())
return nil
}
type SecretStatus string
const (
SecretStatusUnknownStatus = SecretStatus("unknown_status")
SecretStatusReady = SecretStatus("ready")
SecretStatusLocked = SecretStatus("locked")
)
func (enum SecretStatus) String() string {
if enum == "" {
// return default value if empty
return "unknown_status"
}
return string(enum)
}
func (enum SecretStatus) Values() []SecretStatus {
return []SecretStatus{
"unknown_status",
"ready",
"locked",
}
}
func (enum SecretStatus) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *SecretStatus) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = SecretStatus(SecretStatus(tmp).String())
return nil
}
type SecretType string
const (
SecretTypeUnknownType = SecretType("unknown_type")
// Default type.
SecretTypeOpaque = SecretType("opaque")
// List of concatenated PEM blocks. They can contain certificates, private keys or any other PEM block types.
SecretTypeCertificate = SecretType("certificate")
// Flat JSON that allows you to set as many first level keys and scalar types as values (string, numeric, boolean) as you need.
SecretTypeKeyValue = SecretType("key_value")
// Flat JSON that allows you to set a username and a password.
SecretTypeBasicCredentials = SecretType("basic_credentials")
// Flat JSON that allows you to set an engine, username, password, host, database name, and port.
SecretTypeDatabaseCredentials = SecretType("database_credentials")
// Flat JSON that allows you to set an SSH key.
SecretTypeSSHKey = SecretType("ssh_key")
)
func (enum SecretType) String() string {
if enum == "" {
// return default value if empty
return "unknown_type"
}
return string(enum)
}
func (enum SecretType) Values() []SecretType {
return []SecretType{
"unknown_type",
"opaque",
"certificate",
"key_value",
"basic_credentials",
"database_credentials",
"ssh_key",
}
}
func (enum SecretType) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *SecretType) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = SecretType(SecretType(tmp).String())
return nil
}
type SecretVersionStatus string
const (
SecretVersionStatusUnknownStatus = SecretVersionStatus("unknown_status")
SecretVersionStatusEnabled = SecretVersionStatus("enabled")
SecretVersionStatusDisabled = SecretVersionStatus("disabled")
SecretVersionStatusDeleted = SecretVersionStatus("deleted")
)
func (enum SecretVersionStatus) String() string {
if enum == "" {
// return default value if empty
return "unknown_status"
}
return string(enum)
}
func (enum SecretVersionStatus) Values() []SecretVersionStatus {
return []SecretVersionStatus{
"unknown_status",
"enabled",
"disabled",
"deleted",
}
}
func (enum SecretVersionStatus) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *SecretVersionStatus) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = SecretVersionStatus(SecretVersionStatus(tmp).String())
return nil
}
// EphemeralPolicy: ephemeral policy.
type EphemeralPolicy struct {
// TimeToLive: time frame, from one second and up to one year, during which the secret's versions are valid.
TimeToLive *scw.Duration `json:"time_to_live"`
// ExpiresOnceAccessed: returns `true` if the version expires after a single user access.
ExpiresOnceAccessed *bool `json:"expires_once_accessed"`
// Action: see the `EphemeralPolicy.Action` enum for a description of values.
// Default value: unknown_action
Action EphemeralPolicyAction `json:"action"`
}
// BrowseSecretsResponseItemFolderDetails: browse secrets response item folder details.
type BrowseSecretsResponseItemFolderDetails struct {
}
// BrowseSecretsResponseItemSecretDetails: browse secrets response item secret details.
type BrowseSecretsResponseItemSecretDetails struct {
ID string `json:"id"`
Tags []string `json:"tags"`
VersionCount uint32 `json:"version_count"`
Protected bool `json:"protected"`
EphemeralPolicy *EphemeralPolicy `json:"ephemeral_policy"`
// Type: default value: unknown_type
Type SecretType `json:"type"`
}
// EphemeralProperties: ephemeral properties.
type EphemeralProperties struct {
// ExpiresAt: (Optional.) If not specified, the version does not have an expiration date.
ExpiresAt *time.Time `json:"expires_at"`
// ExpiresOnceAccessed: (Optional.) If not specified, the version can be accessed an unlimited amount of times.
ExpiresOnceAccessed *bool `json:"expires_once_accessed"`
// Action: see `EphemeralPolicy.Action` enum for a description of values.
// Default value: unknown_action
Action EphemeralPolicyAction `json:"action"`
}
// BrowseSecretsResponseItem: browse secrets response item.
type BrowseSecretsResponseItem struct {
Name string `json:"name"`
CreatedAt *time.Time `json:"created_at"`
UpdatedAt *time.Time `json:"updated_at"`
// Precisely one of Secret, Folder must be set.
Secret *BrowseSecretsResponseItemSecretDetails `json:"secret,omitempty"`
// Precisely one of Secret, Folder must be set.
Folder *BrowseSecretsResponseItemFolderDetails `json:"folder,omitempty"`
}
// SecretVersion: secret version.
type SecretVersion struct {
// Revision: the first version of the secret is numbered 1, and all subsequent revisions augment by 1.
Revision uint32 `json:"revision"`
// SecretID: ID of the secret.
SecretID string `json:"secret_id"`
// Status: * `unknown_status`: the version is in an invalid state.
// * `enabled`: the version is accessible.
// * `disabled`: the version is not accessible but can be enabled.
// * `deleted`: the version is permanently deleted. It is not possible to recover it.
// Default value: unknown_status
Status SecretVersionStatus `json:"status"`
// CreatedAt: date and time of the version's creation.
CreatedAt *time.Time `json:"created_at"`
// UpdatedAt: last update of the version.
UpdatedAt *time.Time `json:"updated_at"`
// DeletedAt: date and time of the version's deletion.
DeletedAt *time.Time `json:"deleted_at"`
// Description: description of the version.
Description *string `json:"description"`
// Latest: returns `true` if the version is the latest.
Latest bool `json:"latest"`
// EphemeralProperties: returns the version's expiration date, whether it expires after being accessed once, and the action to perform (disable or delete) once the version expires.
EphemeralProperties *EphemeralProperties `json:"ephemeral_properties"`
}
// Secret: secret.
type Secret struct {
// ID: ID of the secret.
ID string `json:"id"`
// ProjectID: ID of the Project containing the secret.
ProjectID string `json:"project_id"`
// Name: name of the secret.
Name string `json:"name"`
// Status: * `ready`: the secret can be read, modified and deleted.
// * `locked`: no action can be performed on the secret. This status can only be applied and removed by Scaleway.
// Default value: unknown_status
Status SecretStatus `json:"status"`
// CreatedAt: date and time of the secret's creation.
CreatedAt *time.Time `json:"created_at"`
// UpdatedAt: last update of the secret.
UpdatedAt *time.Time `json:"updated_at"`
// Tags: list of the secret's tags.
Tags []string `json:"tags"`
// VersionCount: number of versions for this secret.
VersionCount uint32 `json:"version_count"`
// Description: updated description of the secret.
Description *string `json:"description"`
// Managed: returns `true` for secrets that are managed by another product.
Managed bool `json:"managed"`
// Protected: returns `true` for protected secrets that cannot be deleted.
Protected bool `json:"protected"`
// Type: see the `Secret.Type` enum for a description of values.
// Default value: unknown_type
Type SecretType `json:"type"`
// Path: location of the secret in the directory structure.
Path string `json:"path"`
// EphemeralPolicy: (Optional.) Policy that defines whether/when a secret's versions expire. By default, the policy is applied to all the secret's versions.
EphemeralPolicy *EphemeralPolicy `json:"ephemeral_policy"`
// UsedBy: list of Scaleway resources that can access and manage the secret.
UsedBy []Product `json:"used_by"`
// Region: region of the secret.
Region scw.Region `json:"region"`
}
// AccessSecretVersionByPathRequest: access secret version by path request.
type AccessSecretVersionByPathRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// Revision: the first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either:
// - an integer (the revision number)
// - "latest" (the latest revision)
// - "latest_enabled" (the latest enabled revision).
Revision string `json:"-"`
// SecretPath: secret's path.
SecretPath string `json:"-"`
// SecretName: secret's name.
SecretName string `json:"-"`
// ProjectID: ID of the Project to target.
ProjectID string `json:"-"`
}
// AccessSecretVersionRequest: access secret version request.
type AccessSecretVersionRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// SecretID: ID of the secret.
SecretID string `json:"-"`
// Revision: the first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either:
// - a number (the revision number)
// - "latest" (the latest revision)
// - "latest_enabled" (the latest enabled revision).
Revision string `json:"-"`
}
// AccessSecretVersionResponse: access secret version response.
type AccessSecretVersionResponse struct {
// SecretID: ID of the secret.
SecretID string `json:"secret_id"`
// Revision: the first version of the secret is numbered 1, and all subsequent revisions augment by 1.
Revision uint32 `json:"revision"`
// Data: the base64-encoded secret payload of the version.
Data []byte `json:"data"`
// DataCrc32: this field is only available if a CRC32 was supplied during the creation of the version.
DataCrc32 *uint32 `json:"data_crc32"`
// Type: see the `Secret.Type` enum for a description of values.
// Default value: unknown_type
Type SecretType `json:"type"`
}
// AddSecretOwnerRequest: add secret owner request.
type AddSecretOwnerRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// SecretID: ID of the secret.
SecretID string `json:"-"`
// Product: see `Product` enum for description of values.
// Default value: unknown_product
Product Product `json:"product"`
}
// BasicCredentials: basic credentials.
type BasicCredentials struct {
// Username: the username or identifier associated with the credentials.
Username string `json:"username"`
// Password: the password associated with the credentials.
Password string `json:"password"`
}
// BrowseSecretsRequest: browse secrets request.
type BrowseSecretsRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// ProjectID: filter by Project ID (optional).
ProjectID *string `json:"-"`
// OrderBy: default value: name_asc
OrderBy BrowseSecretsRequestOrderBy `json:"-"`
// Prefix: filter secrets and folders for a given prefix (default /).
Prefix string `json:"-"`
Page *int32 `json:"-"`
PageSize *uint32 `json:"-"`
// Tags: filter secrets by tags.
Tags []string `json:"-"`
// Type: filter by secret type (optional).
// Default value: unknown_type
Type SecretType `json:"-"`
}
// BrowseSecretsResponse: browse secrets response.
type BrowseSecretsResponse struct {
// Items: repeated item of type secret or folder, sorted by the request parameter.
Items []*BrowseSecretsResponseItem `json:"items"`
// CurrentPath: current path for the given prefix.
CurrentPath string `json:"current_path"`
// TotalCount: count of all secrets and folders matching the requested criteria.
TotalCount uint64 `json:"total_count"`
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *BrowseSecretsResponse) UnsafeGetTotalCount() uint64 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *BrowseSecretsResponse) UnsafeAppend(res interface{}) (uint64, error) {
results, ok := res.(*BrowseSecretsResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Items = append(r.Items, results.Items...)
r.TotalCount += uint64(len(results.Items))
return uint64(len(results.Items)), nil
}
// CreateSecretRequest: create secret request.
type CreateSecretRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// ProjectID: ID of the Project containing the secret.
ProjectID string `json:"project_id"`
// Name: name of the secret.
Name string `json:"name"`
// Tags: list of the secret's tags.
Tags []string `json:"tags"`
// Description: description of the secret.
Description *string `json:"description,omitempty"`
// Type: (Optional.) See the `Secret.Type` enum for a description of values. If not specified, the type is `Opaque`.
// Default value: unknown_type
Type SecretType `json:"type"`
// Path: (Optional.) Location of the secret in the directory structure. If not specified, the path is `/`.
Path *string `json:"path,omitempty"`
// EphemeralPolicy: (Optional.) Policy that defines whether/when a secret's versions expire. By default, the policy is applied to all the secret's versions.
EphemeralPolicy *EphemeralPolicy `json:"ephemeral_policy,omitempty"`
// Protected: a protected secret cannot be deleted.
Protected bool `json:"protected"`
}
// CreateSecretVersionRequest: create secret version request.
type CreateSecretVersionRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// SecretID: ID of the secret.
SecretID string `json:"-"`
// Data: the base64-encoded secret payload of the version.
Data []byte `json:"data"`
// Description: description of the version.
Description *string `json:"description,omitempty"`
// DisablePrevious: (Optional.) If there is no previous version or if the previous version was already disabled, does nothing.
DisablePrevious *bool `json:"disable_previous,omitempty"`
// DataCrc32: if specified, Secret Manager will verify the integrity of the data received against the given CRC32 checksum. An error is returned if the CRC32 does not match. If, however, the CRC32 matches, it will be stored and returned along with the SecretVersion on future access requests.
DataCrc32 *uint32 `json:"data_crc32,omitempty"`
}
// DatabaseCredentials: database credentials.
type DatabaseCredentials struct {
// Engine: supported database engines are: 'postgres', 'mysql', 'other'.
Engine string `json:"engine"`
// Username: the username used to authenticate to the database server.
Username string `json:"username"`
// Password: the password used to authenticate to the database server.
Password string `json:"password"`
// Host: the hostname or resolvable DNS name of the database server.
Host string `json:"host"`
// Dbname: the name of the database to connect to.
Dbname string `json:"dbname"`
// Port: the port must be an integer ranging from 0 to 65535.
Port string `json:"port"`
}
// DeleteSecretRequest: delete secret request.
type DeleteSecretRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// SecretID: ID of the secret.
SecretID string `json:"-"`
}
// DeleteSecretVersionRequest: delete secret version request.
type DeleteSecretVersionRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// SecretID: ID of the secret.
SecretID string `json:"-"`
// Revision: the first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either:
// - a number (the revision number)
// - "latest" (the latest revision)
// - "latest_enabled" (the latest enabled revision).
Revision string `json:"-"`
}
// DisableSecretVersionRequest: disable secret version request.
type DisableSecretVersionRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// SecretID: ID of the secret.
SecretID string `json:"-"`
// Revision: the first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either:
// - a number (the revision number)
// - "latest" (the latest revision)
// - "latest_enabled" (the latest enabled revision).
Revision string `json:"-"`
}
// EnableSecretVersionRequest: enable secret version request.
type EnableSecretVersionRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// SecretID: ID of the secret.
SecretID string `json:"-"`
// Revision: the first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either:
// - a number (the revision number)
// - "latest" (the latest revision)
// - "latest_enabled" (the latest enabled revision).
Revision string `json:"-"`
}
// GetSecretRequest: get secret request.
type GetSecretRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// SecretID: ID of the secret.
SecretID string `json:"-"`
}
// GetSecretVersionRequest: get secret version request.
type GetSecretVersionRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// SecretID: ID of the secret.
SecretID string `json:"-"`
// Revision: the first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either:
// - a number (the revision number)
// - "latest" (the latest revision)
// - "latest_enabled" (the latest enabled revision).
Revision string `json:"-"`
}
// ListSecretTypesRequest: list secret types request.
type ListSecretTypesRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// ProjectID: ID of the Project to target.
ProjectID string `json:"-"`
Page *int32 `json:"-"`
PageSize *uint32 `json:"-"`
}
// ListSecretTypesResponse: list secret types response.
type ListSecretTypesResponse struct {
// Types: list of secret types.
Types []SecretType `json:"types"`
// TotalCount: count of all secret types matching the requested criteria.
TotalCount uint64 `json:"total_count"`
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListSecretTypesResponse) UnsafeGetTotalCount() uint64 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListSecretTypesResponse) UnsafeAppend(res interface{}) (uint64, error) {
results, ok := res.(*ListSecretTypesResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Types = append(r.Types, results.Types...)
r.TotalCount += uint64(len(results.Types))
return uint64(len(results.Types)), nil
}
// ListSecretVersionsRequest: list secret versions request.
type ListSecretVersionsRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// SecretID: ID of the secret.
SecretID string `json:"-"`
Page *int32 `json:"-"`
PageSize *uint32 `json:"-"`
// Status: filter results by status.
Status []SecretVersionStatus `json:"-"`
}
// ListSecretVersionsResponse: list secret versions response.
type ListSecretVersionsResponse struct {
// Versions: single page of versions.
Versions []*SecretVersion `json:"versions"`
// TotalCount: number of versions.
TotalCount uint64 `json:"total_count"`
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListSecretVersionsResponse) UnsafeGetTotalCount() uint64 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListSecretVersionsResponse) UnsafeAppend(res interface{}) (uint64, error) {
results, ok := res.(*ListSecretVersionsResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Versions = append(r.Versions, results.Versions...)
r.TotalCount += uint64(len(results.Versions))
return uint64(len(results.Versions)), nil
}
// ListSecretsRequest: list secrets request.
type ListSecretsRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// OrganizationID: filter by Organization ID (optional).
OrganizationID *string `json:"-"`
// ProjectID: filter by Project ID (optional).
ProjectID *string `json:"-"`
// OrderBy: default value: name_asc
OrderBy ListSecretsRequestOrderBy `json:"-"`
Page *int32 `json:"-"`
PageSize *uint32 `json:"-"`
// Tags: list of tags to filter on (optional).
Tags []string `json:"-"`
// Name: filter by secret name (optional).
Name *string `json:"-"`
// Path: filter by exact path (optional).
Path *string `json:"-"`
// Ephemeral: filter by ephemeral / not ephemeral (optional).
Ephemeral *bool `json:"-"`
// Type: filter by secret type (optional).
// Default value: unknown_type
Type SecretType `json:"-"`
}
// ListSecretsResponse: list secrets response.
type ListSecretsResponse struct {
// Secrets: single page of secrets matching the requested criteria.
Secrets []*Secret `json:"secrets"`
// TotalCount: count of all secrets matching the requested criteria.
TotalCount uint64 `json:"total_count"`
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListSecretsResponse) UnsafeGetTotalCount() uint64 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListSecretsResponse) UnsafeAppend(res interface{}) (uint64, error) {
results, ok := res.(*ListSecretsResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Secrets = append(r.Secrets, results.Secrets...)
r.TotalCount += uint64(len(results.Secrets))
return uint64(len(results.Secrets)), nil
}
// ListTagsRequest: list tags request.
type ListTagsRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// ProjectID: ID of the Project to target.
ProjectID string `json:"-"`
Page *int32 `json:"-"`
PageSize *uint32 `json:"-"`
}
// ListTagsResponse: list tags response.
type ListTagsResponse struct {
// Tags: list of tags.
Tags []string `json:"tags"`
// TotalCount: count of all tags matching the requested criteria.
TotalCount uint64 `json:"total_count"`
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListTagsResponse) UnsafeGetTotalCount() uint64 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListTagsResponse) UnsafeAppend(res interface{}) (uint64, error) {
results, ok := res.(*ListTagsResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Tags = append(r.Tags, results.Tags...)
r.TotalCount += uint64(len(results.Tags))
return uint64(len(results.Tags)), nil
}
// ProtectSecretRequest: protect secret request.
type ProtectSecretRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// SecretID: ID of the secret to enable secret protection for.
SecretID string `json:"-"`
}
// SSHKey: ssh key.
type SSHKey struct {
// SSHPrivateKey: the private SSH key.
SSHPrivateKey string `json:"ssh_private_key"`
}
// UnprotectSecretRequest: unprotect secret request.
type UnprotectSecretRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// SecretID: ID of the secret to disable secret protection for.
SecretID string `json:"-"`
}
// UpdateSecretRequest: update secret request.
type UpdateSecretRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// SecretID: ID of the secret.
SecretID string `json:"-"`
// Name: secret's updated name (optional).
Name *string `json:"name,omitempty"`
// Tags: secret's updated list of tags (optional).
Tags *[]string `json:"tags,omitempty"`
// Description: description of the secret.
Description *string `json:"description,omitempty"`
// Path: (Optional.) Location of the folder in the directory structure. If not specified, the path is `/`.
Path *string `json:"path,omitempty"`
// EphemeralPolicy: (Optional.) Policy that defines whether/when a secret's versions expire.
EphemeralPolicy *EphemeralPolicy `json:"ephemeral_policy,omitempty"`
}
// UpdateSecretVersionRequest: update secret version request.
type UpdateSecretVersionRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
// SecretID: ID of the secret.
SecretID string `json:"-"`
// Revision: the first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either:
// - a number (the revision number)
// - "latest" (the latest revision)
// - "latest_enabled" (the latest enabled revision).
Revision string `json:"-"`
// Description: description of the version.
Description *string `json:"description,omitempty"`
// EphemeralProperties: (Optional.) Properties that defines the version's expiration date, whether it expires after being accessed once, and the action to perform (disable or delete) once the version expires.
EphemeralProperties *EphemeralProperties `json:"ephemeral_properties,omitempty"`
}
// This API allows you to manage your Secret Manager services, for storing, accessing and sharing sensitive data such as passwords, API keys and certificates.
type API struct {
client *scw.Client
}
// NewAPI returns a API object from a Scaleway client.
func NewAPI(client *scw.Client) *API {
return &API{
client: client,
}
}
func (s *API) Regions() []scw.Region {
return []scw.Region{scw.RegionFrPar, scw.RegionNlAms, scw.RegionPlWaw}
}
// CreateSecret: Create a secret in a given region specified by the `region` parameter.
func (s *API) CreateSecret(req *CreateSecretRequest, opts ...scw.RequestOption) (*Secret, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if req.ProjectID == "" {
defaultProjectID, _ := s.client.GetDefaultProjectID()
req.ProjectID = defaultProjectID
}
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets",
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Secret
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// GetSecret: Retrieve the metadata of a secret specified by the `region` and `secret_id` parameters.
func (s *API) GetSecret(req *GetSecretRequest, opts ...scw.RequestOption) (*Secret, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.SecretID) == "" {
return nil, errors.New("field SecretID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "",
}
var resp Secret
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// UpdateSecret: Edit a secret's metadata such as name, tag(s), description and ephemeral policy. The secret to update is specified by the `secret_id` and `region` parameters.
func (s *API) UpdateSecret(req *UpdateSecretRequest, opts ...scw.RequestOption) (*Secret, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.SecretID) == "" {
return nil, errors.New("field SecretID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "PATCH",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "",
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Secret
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// DeleteSecret: Delete a given secret specified by the `region` and `secret_id` parameters.
func (s *API) DeleteSecret(req *DeleteSecretRequest, opts ...scw.RequestOption) error {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if fmt.Sprint(req.Region) == "" {
return errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.SecretID) == "" {
return errors.New("field SecretID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "DELETE",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "",
}
err = s.client.Do(scwReq, nil, opts...)
if err != nil {
return err
}
return nil
}
// ListSecrets: Retrieve the list of secrets created within an Organization and/or Project. You must specify either the `organization_id` or the `project_id` and the `region`.
func (s *API) ListSecrets(req *ListSecretsRequest, opts ...scw.RequestOption) (*ListSecretsResponse, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "organization_id", req.OrganizationID)
parameter.AddToQuery(query, "project_id", req.ProjectID)
parameter.AddToQuery(query, "order_by", req.OrderBy)
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "tags", req.Tags)
parameter.AddToQuery(query, "name", req.Name)
parameter.AddToQuery(query, "path", req.Path)
parameter.AddToQuery(query, "ephemeral", req.Ephemeral)
parameter.AddToQuery(query, "type", req.Type)
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets",
Query: query,
}
var resp ListSecretsResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// BrowseSecrets: Retrieve the list of secrets and folders for the given prefix. You must specify either the `organization_id` or the `project_id` and the `region`.
func (s *API) BrowseSecrets(req *BrowseSecretsRequest, opts ...scw.RequestOption) (*BrowseSecretsResponse, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "project_id", req.ProjectID)
parameter.AddToQuery(query, "order_by", req.OrderBy)
parameter.AddToQuery(query, "prefix", req.Prefix)
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "tags", req.Tags)
parameter.AddToQuery(query, "type", req.Type)
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/browse",
Query: query,
}
var resp BrowseSecretsResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// ProtectSecret: Enable secret protection for a given secret specified by the `secret_id` parameter. Enabling secret protection means that your secret can be read and modified, but it cannot be deleted.
func (s *API) ProtectSecret(req *ProtectSecretRequest, opts ...scw.RequestOption) (*Secret, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.SecretID) == "" {
return nil, errors.New("field SecretID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "/protect",
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Secret
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// UnprotectSecret: Disable secret protection for a given secret specified by the `secret_id` parameter. Disabling secret protection means that your secret can be read, modified and deleted.
func (s *API) UnprotectSecret(req *UnprotectSecretRequest, opts ...scw.RequestOption) (*Secret, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.SecretID) == "" {
return nil, errors.New("field SecretID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "/unprotect",
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Secret
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// AddSecretOwner: Allow a product to use the secret.
func (s *API) AddSecretOwner(req *AddSecretOwnerRequest, opts ...scw.RequestOption) error {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if fmt.Sprint(req.Region) == "" {
return errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.SecretID) == "" {
return errors.New("field SecretID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "/add-owner",
}
err = scwReq.SetBody(req)
if err != nil {
return err
}
err = s.client.Do(scwReq, nil, opts...)
if err != nil {
return err
}
return nil
}
// CreateSecretVersion: Create a version of a given secret specified by the `region` and `secret_id` parameters.
func (s *API) CreateSecretVersion(req *CreateSecretVersionRequest, opts ...scw.RequestOption) (*SecretVersion, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.SecretID) == "" {
return nil, errors.New("field SecretID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "/versions",
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp SecretVersion
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// GetSecretVersion: Retrieve the metadata of a secret's given version specified by the `region`, `secret_id` and `revision` parameters.
func (s *API) GetSecretVersion(req *GetSecretVersionRequest, opts ...scw.RequestOption) (*SecretVersion, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.SecretID) == "" {
return nil, errors.New("field SecretID cannot be empty in request")
}
if fmt.Sprint(req.Revision) == "" {
return nil, errors.New("field Revision cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "/versions/" + fmt.Sprint(req.Revision) + "",
}
var resp SecretVersion
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// UpdateSecretVersion: Edit the metadata of a secret's given version, specified by the `region`, `secret_id` and `revision` parameters.
func (s *API) UpdateSecretVersion(req *UpdateSecretVersionRequest, opts ...scw.RequestOption) (*SecretVersion, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.SecretID) == "" {
return nil, errors.New("field SecretID cannot be empty in request")
}
if fmt.Sprint(req.Revision) == "" {
return nil, errors.New("field Revision cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "PATCH",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "/versions/" + fmt.Sprint(req.Revision) + "",
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp SecretVersion
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// DeleteSecretVersion: Delete a secret's version and the sensitive data contained in it. Deleting a version is permanent and cannot be undone.
func (s *API) DeleteSecretVersion(req *DeleteSecretVersionRequest, opts ...scw.RequestOption) error {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if fmt.Sprint(req.Region) == "" {
return errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.SecretID) == "" {
return errors.New("field SecretID cannot be empty in request")
}
if fmt.Sprint(req.Revision) == "" {
return errors.New("field Revision cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "DELETE",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "/versions/" + fmt.Sprint(req.Revision) + "",
}
err = s.client.Do(scwReq, nil, opts...)
if err != nil {
return err
}
return nil
}
// ListSecretVersions: Retrieve the list of a given secret's versions specified by the `secret_id` and `region` parameters.
func (s *API) ListSecretVersions(req *ListSecretVersionsRequest, opts ...scw.RequestOption) (*ListSecretVersionsResponse, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "status", req.Status)
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.SecretID) == "" {
return nil, errors.New("field SecretID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "/versions",
Query: query,
}
var resp ListSecretVersionsResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// AccessSecretVersion: Access sensitive data in a secret's version specified by the `region`, `secret_id` and `revision` parameters.
func (s *API) AccessSecretVersion(req *AccessSecretVersionRequest, opts ...scw.RequestOption) (*AccessSecretVersionResponse, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.SecretID) == "" {
return nil, errors.New("field SecretID cannot be empty in request")
}
if fmt.Sprint(req.Revision) == "" {
return nil, errors.New("field Revision cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "/versions/" + fmt.Sprint(req.Revision) + "/access",
}
var resp AccessSecretVersionResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// AccessSecretVersionByPath: Access sensitive data in a secret's version specified by the `region`, `secret_name`, `secret_path` and `revision` parameters.
func (s *API) AccessSecretVersionByPath(req *AccessSecretVersionByPathRequest, opts ...scw.RequestOption) (*AccessSecretVersionResponse, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if req.ProjectID == "" {
defaultProjectID, _ := s.client.GetDefaultProjectID()
req.ProjectID = defaultProjectID
}
query := url.Values{}
parameter.AddToQuery(query, "secret_path", req.SecretPath)
parameter.AddToQuery(query, "secret_name", req.SecretName)
parameter.AddToQuery(query, "project_id", req.ProjectID)
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.Revision) == "" {
return nil, errors.New("field Revision cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets-by-path/versions/" + fmt.Sprint(req.Revision) + "/access",
Query: query,
}
var resp AccessSecretVersionResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// EnableSecretVersion: Make a specific version accessible. You must specify the `region`, `secret_id` and `revision` parameters.
func (s *API) EnableSecretVersion(req *EnableSecretVersionRequest, opts ...scw.RequestOption) (*SecretVersion, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.SecretID) == "" {
return nil, errors.New("field SecretID cannot be empty in request")
}
if fmt.Sprint(req.Revision) == "" {
return nil, errors.New("field Revision cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "/versions/" + fmt.Sprint(req.Revision) + "/enable",
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp SecretVersion
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// DisableSecretVersion: Make a specific version inaccessible. You must specify the `region`, `secret_id` and `revision` parameters.
func (s *API) DisableSecretVersion(req *DisableSecretVersionRequest, opts ...scw.RequestOption) (*SecretVersion, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
if fmt.Sprint(req.SecretID) == "" {
return nil, errors.New("field SecretID cannot be empty in request")
}
if fmt.Sprint(req.Revision) == "" {
return nil, errors.New("field Revision cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secrets/" + fmt.Sprint(req.SecretID) + "/versions/" + fmt.Sprint(req.Revision) + "/disable",
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp SecretVersion
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// ListTags: List all tags associated with secrets within a given Project.
func (s *API) ListTags(req *ListTagsRequest, opts ...scw.RequestOption) (*ListTagsResponse, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if req.ProjectID == "" {
defaultProjectID, _ := s.client.GetDefaultProjectID()
req.ProjectID = defaultProjectID
}
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "project_id", req.ProjectID)
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "page_size", req.PageSize)
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/tags",
Query: query,
}
var resp ListTagsResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// ListSecretTypes: List all secret types created within a given Project.
func (s *API) ListSecretTypes(req *ListSecretTypesRequest, opts ...scw.RequestOption) (*ListSecretTypesResponse, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if req.ProjectID == "" {
defaultProjectID, _ := s.client.GetDefaultProjectID()
req.ProjectID = defaultProjectID
}
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "project_id", req.ProjectID)
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "page_size", req.PageSize)
if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/secret-manager/v1beta1/regions/" + fmt.Sprint(req.Region) + "/secret-types",
Query: query,
}
var resp ListSecretTypesResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
|