117 lines
5.1 KiB
Protocol Buffer
117 lines
5.1 KiB
Protocol Buffer
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
syntax = "proto3";
|
|
|
|
package controller.api.services.v1;
|
|
|
|
import "controller/api/resources/credentiallibraries/v1/credential_library.proto";
|
|
import "controller/custom_options/v1/options.proto";
|
|
import "google/api/annotations.proto";
|
|
import "google/protobuf/field_mask.proto";
|
|
import "protoc-gen-openapiv2/options/annotations.proto";
|
|
|
|
option go_package = "github.com/hashicorp/boundary/internal/gen/controller/api/services;services";
|
|
option (custom_options.v1.domain) = "credential";
|
|
|
|
service CredentialLibraryService {
|
|
// GetCredentialLibrary returns a stored Credential Library if present. The provided request
|
|
// must include the Credential Store id. If missing, malformed or referencing a
|
|
// non existing resource an error is returned.
|
|
rpc GetCredentialLibrary(GetCredentialLibraryRequest) returns (GetCredentialLibraryResponse) {
|
|
option (google.api.http) = {
|
|
get: "/v1/credential-libraries/{id}"
|
|
response_body: "item"
|
|
};
|
|
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Gets a single Credential Library."};
|
|
}
|
|
|
|
// ListCredentialLibraries returns a list of stored Credential Libraries which are in the
|
|
// provided scope. The request must include the Credential Store id and if missing,
|
|
// malformed, or referencing a non existing scope, an error is returned.
|
|
rpc ListCredentialLibraries(ListCredentialLibrariesRequest) returns (ListCredentialLibrariesResponse) {
|
|
option (google.api.http) = {get: "/v1/credential-libraries"};
|
|
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Lists all Credential Library."};
|
|
}
|
|
|
|
// CreateCredentialLibrary creates and stores an Credential Library in boundary. The
|
|
// provided request must include the scope in which the Credential Library will be
|
|
// created. If the scope id is missing, malformed or referencing a
|
|
// non existing resource an error is returned. If a name is provided that is
|
|
// in use in another Credential Library in the same scope, an error is returned.
|
|
rpc CreateCredentialLibrary(CreateCredentialLibraryRequest) returns (CreateCredentialLibraryResponse) {
|
|
option (google.api.http) = {
|
|
post: "/v1/credential-libraries"
|
|
body: "item"
|
|
response_body: "item"
|
|
};
|
|
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Creates a single Credential Library."};
|
|
}
|
|
|
|
// UpdateCredentialLibrary updates an existing Credential Library in boundary. The provided
|
|
// Credential Library must not have any read only fields set. The update mask must be
|
|
// included in the request and contain at least 1 mutable field. To unset
|
|
// a field's value, include the field in the update mask and don't set it
|
|
// in the provided user. An error is returned if the Credential Library id is missing
|
|
// or reference a non existing resource. An error is also returned if the
|
|
// request attempts to update the name to one that is already in use by
|
|
// another Credential Library in the parent scope.
|
|
rpc UpdateCredentialLibrary(UpdateCredentialLibraryRequest) returns (UpdateCredentialLibraryResponse) {
|
|
option (google.api.http) = {
|
|
patch: "/v1/credential-libraries/{id}"
|
|
body: "item"
|
|
response_body: "item"
|
|
};
|
|
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Updates a Credential Library."};
|
|
}
|
|
|
|
// DeleteCredentialLibrary removes an Credential Library from Boundary. If the Credential Library id
|
|
// is malformed or not provided an error is returned.
|
|
rpc DeleteCredentialLibrary(DeleteCredentialLibraryRequest) returns (DeleteCredentialLibraryResponse) {
|
|
option (google.api.http) = {delete: "/v1/credential-libraries/{id}"};
|
|
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Deletes a Credential Library"};
|
|
}
|
|
}
|
|
|
|
message GetCredentialLibraryRequest {
|
|
string id = 1; // @gotags: `class:"public"`
|
|
}
|
|
|
|
message GetCredentialLibraryResponse {
|
|
resources.credentiallibraries.v1.CredentialLibrary item = 1;
|
|
}
|
|
|
|
message ListCredentialLibrariesRequest {
|
|
string credential_store_id = 1 [json_name = "scope_id"]; // @gotags: `class:"public"`
|
|
string filter = 30 [json_name = "filter"]; // @gotags: `class:"public"`
|
|
}
|
|
|
|
message ListCredentialLibrariesResponse {
|
|
repeated resources.credentiallibraries.v1.CredentialLibrary items = 1;
|
|
}
|
|
|
|
message CreateCredentialLibraryRequest {
|
|
resources.credentiallibraries.v1.CredentialLibrary item = 1;
|
|
}
|
|
|
|
message CreateCredentialLibraryResponse {
|
|
string uri = 1; // @gotags: `class:"public"`
|
|
resources.credentiallibraries.v1.CredentialLibrary item = 2;
|
|
}
|
|
|
|
message UpdateCredentialLibraryRequest {
|
|
string id = 1; // @gotags: `class:"public"`
|
|
resources.credentiallibraries.v1.CredentialLibrary item = 2;
|
|
google.protobuf.FieldMask update_mask = 3 [json_name = "update_mask"];
|
|
}
|
|
|
|
message UpdateCredentialLibraryResponse {
|
|
resources.credentiallibraries.v1.CredentialLibrary item = 1;
|
|
}
|
|
|
|
message DeleteCredentialLibraryRequest {
|
|
string id = 1; // @gotags: `class:"public"`
|
|
}
|
|
|
|
message DeleteCredentialLibraryResponse {}
|