Files
ca/Documentation/api/server_service_admin.md
dissoupovandGitHub 0b6087424e Impove Cursor pagination (#19)
* Impove Cursor pagination

* Upgrade deps
2026-10-24 12:21:21 -05:00

5.3 KiB

admin

import "github.com/effective-security/trustyca/server/service/admin"

Index

Constants

ServiceName provides the Service Name for this package

const ServiceName = "admin"

func Factory

func Factory(server gserver.GServer) any

Factory returns a factory of the service

type Service

Service defines the Admin service: the support views across orgs. It reads the CA tables through db.CaReadonlyDb and holds no issuer keys.

type Service struct {
    // contains filtered or unexported fields
}

func (*Service) AdminHTTPHandler

func (s *Service) AdminHTTPHandler() restserver.Handle

func (*Service) Close

func (s *Service) Close()

Close the subservices and its resources

func (*Service) IsReady

func (s *Service) IsReady() bool

IsReady indicates that the service is ready to serve its end-points

func (*Service) ListCertificates

func (s *Service) ListCertificates(ctx context.Context, req *privpb.ListAllCertificatesRequest) (*pb.CertificatesResponse, error)

ListCertificates lists the certificates of the org the request names, of the platform, or of every org and the platform, newest first, for support staff

func (*Service) ListIssuers

func (s *Service) ListIssuers(ctx context.Context, req *privpb.ListAllIssuersRequest) (*pb.IssuersResponse, error)

ListIssuers lists the issuers of the org the request names, of the platform, or of every org and the platform, newest first, for support staff. Private key material is never part of the rows' API view.

func (*Service) ListOrgs

func (s *Service) ListOrgs(ctx context.Context, req *privpb.ListOrgsRequest) (*pb.OrgsResponse, error)

ListOrgs lists the orgs by name, paged by offset or by cursor

func (*Service) ListProjects

func (s *Service) ListProjects(ctx context.Context, req *privpb.ListProjectsRequest) (*pb.ProjectsResponse, error)

ListProjects lists the projects of an org, or of every org, by name, paged by offset or by cursor

func (*Service) Name

func (s *Service) Name() string

Name returns the service name

func (*Service) RegisterGRPC

func (s *Service) RegisterGRPC(r *grpc.Server)

RegisterGRPC registers gRPC handler

func (*Service) RegisterRoute

func (s *Service) RegisterRoute(r restserver.Router)

RegisterRoute adds the Admin API endpoints to the URL router

Generated by gomarkdoc