boundary/internal/proto/controller/api/services/v1/credential_service.proto

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

syntax = "proto3";

package controller.api.services.v1;

import "controller/api/resources/credentials/v1/credential.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 CredentialService {
  option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_tag) = {
    name: "Credential service"
    description:
      "A credential is a data structure that contains one or more secrets that bind an "
      "identity to a set of permissions or capabilities on a host for a session. "
      "The credential service provides endpoints for managing credentials in Boundary. "
    external_docs: {
      url: "https://developer.hashicorp.com/boundary/docs/concepts/domain-model/credentials";
      description: "Read about credentials in the Boundary domain model";
    }
  };

  // GetCredential returns a stored Credential 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 GetCredential(GetCredentialRequest) returns (GetCredentialResponse) {
    option (google.api.http) = {
      get: "/v1/credentials/{id}"
      response_body: "item"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Gets a single Credential."};
  }

  // ListCredentials returns a list of stored Credentials which are in the
  // provided store. The request must include the Credential Store id and if missing,
  // malformed, or referencing a non existing scope, an error is returned.
  rpc ListCredentials(ListCredentialsRequest) returns (ListCredentialsResponse) {
    option (google.api.http) = {get: "/v1/credentials"};
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Lists all Credentials."};
  }

  // CreateCredential creates and stores an Credential in boundary.  The
  // provided request must include the credential_store_id in which the Credential
  // will be created. If the store 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 in the same store, an error is returned.
  rpc CreateCredential(CreateCredentialRequest) returns (CreateCredentialResponse) {
    option (google.api.http) = {
      post: "/v1/credentials"
      body: "item"
      response_body: "item"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Creates a single Credential."};
  }

  // UpdateCredential updates an existing Credential in boundary.  The provided
  // Credential 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 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 in the parent scope.
  rpc UpdateCredential(UpdateCredentialRequest) returns (UpdateCredentialResponse) {
    option (google.api.http) = {
      patch: "/v1/credentials/{id}"
      body: "item"
      response_body: "item"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Updates a Credential."};
  }

  // DeleteCredential removes an Credential from Boundary. If the Credential id
  // is malformed or not provided an error is returned.
  rpc DeleteCredential(DeleteCredentialRequest) returns (DeleteCredentialResponse) {
    option (google.api.http) = {delete: "/v1/credentials/{id}"};
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Deletes a Credential"};
  }
}

message GetCredentialRequest {
  string id = 1; // @gotags: `class:"public"`
}

message GetCredentialResponse {
  resources.credentials.v1.Credential item = 1;
}

message ListCredentialsRequest {
  string credential_store_id = 1 [json_name = "scope_id"]; // @gotags: `class:"public"`
  // You can specify that the filter should only return items that match.
  // Refer to [filter expressions](https://developer.hashicorp.com/boundary/docs/concepts/filtering) for more information.
  string filter = 30 [json_name = "filter"]; // @gotags: `class:"public"`
  // An opaque token that Boundary uses to continue an existing iteration or
  // request updated items. If you do not specify a token, pagination
  // starts from the beginning. To learn more about list pagination
  // in Boundary, refer to [list pagination](https://developer.hashicorp.com/boundary/docs/api-clients/api/pagination).
  string list_token = 40 [json_name = "list_token"]; // @gotags: `class:"public"`
  // The maximum size of a page in this iteration.
  // If you do not set a page size, Boundary uses the configured default page size.
  // If the page_size is greater than the default page size configured,
  // Boundary truncates the page size to this number.
  uint32 page_size = 50 [json_name = "page_size"]; // @gotags: `class:"public"`
}

message ListCredentialsResponse {
  // The items returned in this page.
  repeated resources.credentials.v1.Credential items = 1;
  // The type of response, either "delta" or "complete".
  // Delta signifies that this is part of a paginated result
  // or an update to a previously completed pagination.
  // Complete signifies that it is the last page.
  string response_type = 2 [json_name = "response_type"]; // @gotags: `class:"public"`
  // An opaque token used to continue an existing pagination or
  // request updated items. Use this token in the next list request
  // to request the next page.
  string list_token = 3 [json_name = "list_token"]; // @gotags: `class:"public"`
  // The name of the field which the items are sorted by.
  string sort_by = 4 [json_name = "sort_by"]; // @gotags: `class:"public"`
  // The direction of the sort, either "asc" or "desc".
  string sort_dir = 5 [json_name = "sort_dir"]; // @gotags: `class:"public"`
  // A list of item IDs that have been removed since they were returned
  // as part of a pagination. They should be dropped from any client cache.
  // This may contain items that are not known to the cache, if they were
  // created and deleted between listings.
  repeated string removed_ids = 6 [json_name = "removed_ids"]; // @gotags: `class:"public"`
  // An estimate at the total items available. This may change during pagination.
  uint32 est_item_count = 7 [json_name = "est_item_count"]; // @gotags: `class:"public"`
}

message CreateCredentialRequest {
  resources.credentials.v1.Credential item = 1;
}

message CreateCredentialResponse {
  string uri = 1; // @gotags: `class:"public"`
  resources.credentials.v1.Credential item = 2;
}

message UpdateCredentialRequest {
  string id = 1; // @gotags: `class:"public"`
  resources.credentials.v1.Credential item = 2;
  google.protobuf.FieldMask update_mask = 3 [json_name = "update_mask"];
}

message UpdateCredentialResponse {
  resources.credentials.v1.Credential item = 1;
}

message DeleteCredentialRequest {
  string id = 1; // @gotags: `class:"public"`
}

message DeleteCredentialResponse {}