Skip to content

Latest commit

 

History

History
596 lines (380 loc) · 17.8 KB

SecretDataManagementApi.md

File metadata and controls

596 lines (380 loc) · 17.8 KB

\SecretDataManagementApi

All URIs are relative to https://localhost

Method HTTP request Description
RegisterSecretCloudCredential Post /iso/dsm/v2/secrets/{secret_id}/credentials/cloud Register a Cloud Credential on a Secret
RegisterSecretKV Post /iso/dsm/v2/secrets/{secret_id}/kv Create a Key/Value Pair on a Secret
RegisterSecretPAMCredential Post /iso/dsm/v2/secrets/{secret_id}/credentials/pam Register PAM Credentials on a Secret
RegisterSecretSSHKey Post /iso/dsm/v2/secrets/{secret_id}/keys Register SSH Keys on a Secret
RemoveSecretCloudCredential Delete /iso/dsm/v2/secrets/{secret_id}/credentials/cloud/{cloud_credential_id} Remove a Cloud Credential from a Secret
RemoveSecretKV Delete /iso/dsm/v2/secrets/{secret_id}/kv/{key_identifier} Remove a Key/Value Pair on a Secret
RemoveSecretPAMCredential Delete /iso/dsm/v2/secrets/{secret_id}/credentials/pam/{pam_credential_id} Remove a PAM Credential from a Secret
RemoveSecretSSHKey Delete /iso/dsm/v2/secrets/{secret_id}/keys/{key_id} Remove a SSH Key from a Secret

RegisterSecretCloudCredential

SecretResponse RegisterSecretCloudCredential(ctx, secretId).SecretCloudCredentialRequest(secretCloudCredentialRequest).Execute()

Register a Cloud Credential on a Secret

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    secretId := int32(56) // int32 | Secret ID generated by senhasegura
    secretCloudCredentialRequest := *openapiclient.NewSecretCloudCredentialRequest(int32(1)) // SecretCloudCredentialRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SecretDataManagementApi.RegisterSecretCloudCredential(context.Background(), secretId).SecretCloudCredentialRequest(secretCloudCredentialRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SecretDataManagementApi.RegisterSecretCloudCredential``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RegisterSecretCloudCredential`: SecretResponse
    fmt.Fprintf(os.Stdout, "Response from `SecretDataManagementApi.RegisterSecretCloudCredential`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
secretId int32 Secret ID generated by senhasegura

Other Parameters

Other parameters are passed through a pointer to a apiRegisterSecretCloudCredentialRequest struct via the builder pattern

Name Type Description Notes

secretCloudCredentialRequest | SecretCloudCredentialRequest | |

Return type

SecretResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RegisterSecretKV

SecretResponse RegisterSecretKV(ctx, secretId).RequestBody(requestBody).Execute()

Create a Key/Value Pair on a Secret

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    secretId := int32(56) // int32 | Secret ID generated by senhasegura
    requestBody := map[string]string{"key": "Inner_example"} // map[string]string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SecretDataManagementApi.RegisterSecretKV(context.Background(), secretId).RequestBody(requestBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SecretDataManagementApi.RegisterSecretKV``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RegisterSecretKV`: SecretResponse
    fmt.Fprintf(os.Stdout, "Response from `SecretDataManagementApi.RegisterSecretKV`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
secretId int32 Secret ID generated by senhasegura

Other Parameters

Other parameters are passed through a pointer to a apiRegisterSecretKVRequest struct via the builder pattern

Name Type Description Notes

requestBody | map[string]string | |

Return type

SecretResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RegisterSecretPAMCredential

SecretResponse RegisterSecretPAMCredential(ctx, secretId).SecretPAMCredentialRequest(secretPAMCredentialRequest).Execute()

Register PAM Credentials on a Secret

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    secretId := int32(56) // int32 | Secret ID generated by senhasegura
    secretPAMCredentialRequest := *openapiclient.NewSecretPAMCredentialRequest(int32(1)) // SecretPAMCredentialRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SecretDataManagementApi.RegisterSecretPAMCredential(context.Background(), secretId).SecretPAMCredentialRequest(secretPAMCredentialRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SecretDataManagementApi.RegisterSecretPAMCredential``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RegisterSecretPAMCredential`: SecretResponse
    fmt.Fprintf(os.Stdout, "Response from `SecretDataManagementApi.RegisterSecretPAMCredential`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
secretId int32 Secret ID generated by senhasegura

Other Parameters

Other parameters are passed through a pointer to a apiRegisterSecretPAMCredentialRequest struct via the builder pattern

Name Type Description Notes

secretPAMCredentialRequest | SecretPAMCredentialRequest | |

Return type

SecretResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RegisterSecretSSHKey

SecretResponse RegisterSecretSSHKey(ctx, secretId).SecretPAMSSHKeyRequest(secretPAMSSHKeyRequest).Execute()

Register SSH Keys on a Secret

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    secretId := int32(56) // int32 | Secret ID generated by senhasegura
    secretPAMSSHKeyRequest := *openapiclient.NewSecretPAMSSHKeyRequest(int32(1)) // SecretPAMSSHKeyRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SecretDataManagementApi.RegisterSecretSSHKey(context.Background(), secretId).SecretPAMSSHKeyRequest(secretPAMSSHKeyRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SecretDataManagementApi.RegisterSecretSSHKey``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RegisterSecretSSHKey`: SecretResponse
    fmt.Fprintf(os.Stdout, "Response from `SecretDataManagementApi.RegisterSecretSSHKey`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
secretId int32 Secret ID generated by senhasegura

Other Parameters

Other parameters are passed through a pointer to a apiRegisterSecretSSHKeyRequest struct via the builder pattern

Name Type Description Notes

secretPAMSSHKeyRequest | SecretPAMSSHKeyRequest | |

Return type

SecretResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveSecretCloudCredential

Response RemoveSecretCloudCredential(ctx, secretId, cloudCredentialId).Execute()

Remove a Cloud Credential from a Secret

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    secretId := int32(56) // int32 | Secret ID generated by senhasegura
    cloudCredentialId := int32(56) // int32 | Cloud Credential ID generated by senhasegura

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SecretDataManagementApi.RemoveSecretCloudCredential(context.Background(), secretId, cloudCredentialId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SecretDataManagementApi.RemoveSecretCloudCredential``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RemoveSecretCloudCredential`: Response
    fmt.Fprintf(os.Stdout, "Response from `SecretDataManagementApi.RemoveSecretCloudCredential`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
secretId int32 Secret ID generated by senhasegura
cloudCredentialId int32 Cloud Credential ID generated by senhasegura

Other Parameters

Other parameters are passed through a pointer to a apiRemoveSecretCloudCredentialRequest struct via the builder pattern

Name Type Description Notes

Return type

Response

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveSecretKV

Response RemoveSecretKV(ctx, secretId, keyIdentifier).Execute()

Remove a Key/Value Pair on a Secret

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    secretId := int32(56) // int32 | Secret ID generated by senhasegura
    keyIdentifier := int32(56) // int32 | Key Identifier registered on senhasegura

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SecretDataManagementApi.RemoveSecretKV(context.Background(), secretId, keyIdentifier).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SecretDataManagementApi.RemoveSecretKV``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RemoveSecretKV`: Response
    fmt.Fprintf(os.Stdout, "Response from `SecretDataManagementApi.RemoveSecretKV`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
secretId int32 Secret ID generated by senhasegura
keyIdentifier int32 Key Identifier registered on senhasegura

Other Parameters

Other parameters are passed through a pointer to a apiRemoveSecretKVRequest struct via the builder pattern

Name Type Description Notes

Return type

Response

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveSecretPAMCredential

Response RemoveSecretPAMCredential(ctx, secretId, pamCredentialId).Execute()

Remove a PAM Credential from a Secret

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    secretId := int32(56) // int32 | Secret ID generated by senhasegura
    pamCredentialId := int32(56) // int32 | Credential ID generated by senhasegura

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SecretDataManagementApi.RemoveSecretPAMCredential(context.Background(), secretId, pamCredentialId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SecretDataManagementApi.RemoveSecretPAMCredential``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RemoveSecretPAMCredential`: Response
    fmt.Fprintf(os.Stdout, "Response from `SecretDataManagementApi.RemoveSecretPAMCredential`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
secretId int32 Secret ID generated by senhasegura
pamCredentialId int32 Credential ID generated by senhasegura

Other Parameters

Other parameters are passed through a pointer to a apiRemoveSecretPAMCredentialRequest struct via the builder pattern

Name Type Description Notes

Return type

Response

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveSecretSSHKey

Response RemoveSecretSSHKey(ctx, secretId, keyId).Execute()

Remove a SSH Key from a Secret

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    secretId := int32(56) // int32 | Secret ID generated by senhasegura
    keyId := "keyId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SecretDataManagementApi.RemoveSecretSSHKey(context.Background(), secretId, keyId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SecretDataManagementApi.RemoveSecretSSHKey``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RemoveSecretSSHKey`: Response
    fmt.Fprintf(os.Stdout, "Response from `SecretDataManagementApi.RemoveSecretSSHKey`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
secretId int32 Secret ID generated by senhasegura
keyId string

Other Parameters

Other parameters are passed through a pointer to a apiRemoveSecretSSHKeyRequest struct via the builder pattern

Name Type Description Notes

Return type

Response

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]