mirror of
https://github.com/hanzoai/ca.git
synced 2026-11-03 18:08:27 +00:00
194 lines
7.6 KiB
Protocol Buffer
194 lines
7.6 KiB
Protocol Buffer
syntax = "proto3";
|
|
package privpb;
|
|
|
|
option go_package = "github.com/effective-security/trustyca/privpb";
|
|
|
|
import "google/api/annotations.proto";
|
|
import "google/protobuf/empty.proto";
|
|
import "es/api/annotations.proto";
|
|
import "types.proto";
|
|
import "orgs.proto";
|
|
import "pkix.proto";
|
|
import "ca.proto";
|
|
|
|
service Admin {
|
|
// ListOrgs lists orgs
|
|
rpc ListOrgs(ListOrgsRequest) returns (pb.OrgsResponse) {
|
|
option (google.api.http) = {
|
|
post: "/privpb.Admin/ListOrgs",
|
|
body: "*"
|
|
};
|
|
option (es.api.cli_cmd) = "org list";
|
|
}
|
|
|
|
// TODO
|
|
/*
|
|
// GetOrg returns an org with its budget
|
|
rpc GetOrg(GetOrgRequest) returns (pb.Org) {
|
|
option (google.api.http) = {
|
|
post: "/privpb.Admin/GetOrganization",
|
|
body: "*"
|
|
};
|
|
option (es.api.cli_cmd) = "org get";
|
|
}
|
|
// CreateOrg creates an org owned by an existing user
|
|
rpc CreateOrg(CreateOrgRequest)
|
|
returns (pb.Organization) {
|
|
option (google.api.http) = {
|
|
post: "/privpb.Admin/CreateOrganization",
|
|
body: "*"
|
|
};
|
|
option (es.api.cli_cmd) = "org create";
|
|
}
|
|
// UpdateOrg updates an org
|
|
rpc UpdateOrg(UpdateOrgRequest)
|
|
returns (pb.Organization) {
|
|
option (google.api.http) = {
|
|
post: "/privpb.Admin/UpdateOrganization",
|
|
body: "*"
|
|
};
|
|
option (es.api.cli_cmd) = "org update";
|
|
}
|
|
// DeleteOrg deletes an org that has no projects
|
|
rpc DeleteOrg(DeleteOrgRequest)
|
|
returns (google.protobuf.Empty) {
|
|
option (google.api.http) = {
|
|
post: "/privpb.Admin/DeleteOrganization",
|
|
body: "*"
|
|
};
|
|
option (es.api.cli_cmd) = "org delete";
|
|
}
|
|
*/
|
|
rpc ListProjects(ListProjectsRequest) returns (pb.ProjectsResponse) {
|
|
option (google.api.http) = {
|
|
post: "/privpb.Admin/ListProjects",
|
|
body: "*"
|
|
};
|
|
option (es.api.cli_cmd) = "project list";
|
|
}
|
|
|
|
// ListIssuers lists the issuers of every org and of the platform, newest
|
|
// first, for support staff; the tenant view of an org is CA.ListIssuers.
|
|
// Private key material is never returned.
|
|
rpc ListIssuers(ListAllIssuersRequest) returns (pb.IssuersResponse) {
|
|
option (google.api.http) = {
|
|
post: "/privpb.Admin/ListIssuers",
|
|
body: "*"
|
|
};
|
|
option (es.api.cli_cmd) = "ca issuer list";
|
|
}
|
|
|
|
// ListCertificates lists the certificates of every org and of the
|
|
// platform, newest first, for support staff; the tenant view of an org
|
|
// is CA.ListCertificates
|
|
rpc ListCertificates(ListAllCertificatesRequest)
|
|
returns (pb.CertificatesResponse) {
|
|
option (google.api.http) = {
|
|
post: "/privpb.Admin/ListCertificates",
|
|
body: "*"
|
|
};
|
|
option (es.api.cli_cmd) = "ca cert list";
|
|
}
|
|
}
|
|
|
|
// ListOrgsRequest specifies list orgs request
|
|
message ListOrgsRequest {
|
|
// Limit specifies maximum number of records to return
|
|
uint32 Limit = 1 [json_name = "Limit"];
|
|
// Offset specifies offset for the offset-based pagination.
|
|
// Which is limited to 10000.
|
|
// To paginate for large number of records, use cursor-based pagination
|
|
// instead.
|
|
uint32 Offset = 2 [json_name = "Offset"];
|
|
// Cursor specifies cursor for the cursor-based pagination.
|
|
// Use "initial" to start the pagination or pass the cursor returned from
|
|
// the previous request.
|
|
string Cursor = 3 [json_name = "Cursor"];
|
|
// Status specifies on optional status of the item to filter by.
|
|
// If not specified, all items will be listed.
|
|
pb.ItemStatus.Enum Status = 4 [json_name = "Status"];
|
|
}
|
|
|
|
// ListProjectsRequest specifies list projects request
|
|
message ListProjectsRequest {
|
|
// Limit specifies maximum number of records to return
|
|
uint32 Limit = 1 [json_name = "Limit"];
|
|
// Offset specifies offset for the offset-based pagination.
|
|
// Which is limited to 10000.
|
|
// To paginate for large number of records, use cursor-based pagination
|
|
// instead.
|
|
uint32 Offset = 2 [json_name = "Offset"];
|
|
// Cursor specifies cursor for the cursor-based pagination.
|
|
// Use "initial" to start the pagination or pass the cursor returned from
|
|
// the previous request.
|
|
string Cursor = 3 [json_name = "Cursor"];
|
|
// Status specifies on optional status of the item to filter by.
|
|
// If not specified, all items will be listed.
|
|
pb.ItemStatus.Enum Status = 4 [json_name = "Status"];
|
|
// OrgID specifies optional org ID to filter by.
|
|
string OrgID = 5 [json_name = "OrgID"];
|
|
}
|
|
|
|
// ListAllIssuersRequest specifies a paginated list of issuers across orgs
|
|
message ListAllIssuersRequest {
|
|
// Limit specifies maximum number of records to return
|
|
uint32 Limit = 1 [json_name = "Limit"];
|
|
// Offset specifies offset for the offset-based pagination
|
|
uint32 Offset = 2 [json_name = "Offset"];
|
|
// Cursor specifies cursor for the cursor-based pagination.
|
|
// Use "initial" to start the pagination or pass the cursor returned from
|
|
// the previous request.
|
|
string Cursor = 3 [json_name = "Cursor"];
|
|
// OrgID limits the result to the org. Empty lists the issuers of every
|
|
// org and of the platform, or of the platform only with Platform.
|
|
string OrgID = 4 [json_name = "OrgID"];
|
|
// Platform limits the result to the platform issuers (no org) when
|
|
// OrgID is empty
|
|
bool Platform = 5 [json_name = "Platform"];
|
|
// ProjectID limits the result to the project; used with OrgID
|
|
string ProjectID = 6 [json_name = "ProjectID"];
|
|
// Label limits the result to the issuers with the label, in every scope
|
|
// the list covers
|
|
string Label = 7 [json_name = "Label"];
|
|
// Status filters by lifecycle status; Unknown returns all
|
|
pb.IssuerStatus.Enum Status = 8 [json_name = "Status"];
|
|
// Type filters by authority type; Unknown returns all
|
|
pb.AuthorityType.Enum Type = 9 [json_name = "Type"];
|
|
// IDs limits the result to the issuers with the IDs, at most 500
|
|
repeated string IDs = 10 [json_name = "IDs"];
|
|
// IKIDs limits the result to the issuers with the key identifiers (the
|
|
// SKID of the issuer, the IKID of the certificates it issued), at most
|
|
// 500
|
|
repeated string IKIDs = 11 [json_name = "IKIDs"];
|
|
}
|
|
|
|
// ListAllCertificatesRequest specifies a paginated list of certificates across
|
|
// orgs, newest first
|
|
message ListAllCertificatesRequest {
|
|
// Limit specifies maximum number of records to return
|
|
uint32 Limit = 1 [json_name = "Limit"];
|
|
// Offset specifies offset for the offset-based pagination
|
|
uint32 Offset = 2 [json_name = "Offset"];
|
|
// Cursor specifies cursor for the cursor-based pagination.
|
|
// Use "initial" to start the pagination or pass the cursor returned from
|
|
// the previous request.
|
|
string Cursor = 3 [json_name = "Cursor"];
|
|
// OrgID limits the result to the org. Empty lists the certificates of
|
|
// every org and of the platform, or of the platform only with Platform.
|
|
string OrgID = 4 [json_name = "OrgID"];
|
|
// Platform limits the result to the platform certificates (no org) when
|
|
// OrgID is empty
|
|
bool Platform = 5 [json_name = "Platform"];
|
|
// ProjectID limits the result to the project; used with OrgID
|
|
string ProjectID = 6 [json_name = "ProjectID"];
|
|
// IKID filters by issuer
|
|
string IKID = 7 [json_name = "IKID"];
|
|
// Profile filters by profile label
|
|
string Profile = 8 [json_name = "Profile"];
|
|
// Status filters by status; Unknown returns all
|
|
pb.CertificateStatus.Enum Status = 9 [json_name = "Status"];
|
|
// ExpiringBefore filters certificates with NotAfter before the time,
|
|
// in RFC3339 format
|
|
string ExpiringBefore = 10 [json_name = "ExpiringBefore"];
|
|
}
|