Documentation
¶
Overview ¶
Package pbclient is a minimal Portal Backend API client for CLI management commands.
Index ¶
- type ApplicationCollection
- type Client
- func (c *Client) CreateApplication(ctx context.Context, req *models.CreateApplicationRequest) (*models.ApplicationResponse, error)
- func (c *Client) CreateMember(ctx context.Context, req *models.CreateMemberRequest) (*models.MemberResponse, error)
- func (c *Client) CreateSchema(ctx context.Context, req *models.CreateSchemaRequest) (*models.SchemaResponse, error)
- func (c *Client) GetApplication(ctx context.Context, applicationID string) (*models.ApplicationResponse, error)
- func (c *Client) ListApplications(ctx context.Context, memberID *string) (*ApplicationCollection, error)
- func (c *Client) UpdateApplicationPolicy(ctx context.Context, applicationID string, ...) (*models.ApplicationResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApplicationCollection ¶
type ApplicationCollection struct {
Items []models.ApplicationResponse `json:"items"`
Count int `json:"count"`
}
ApplicationCollection is the GET /api/v1/applications response envelope.
type Client ¶
Client calls the Portal Backend management API using a bearer token.
func (*Client) CreateApplication ¶
func (c *Client) CreateApplication(ctx context.Context, req *models.CreateApplicationRequest) (*models.ApplicationResponse, error)
CreateApplication calls POST /api/v1/applications.
func (*Client) CreateMember ¶
func (c *Client) CreateMember(ctx context.Context, req *models.CreateMemberRequest) (*models.MemberResponse, error)
CreateMember calls POST /api/v1/members.
func (*Client) CreateSchema ¶
func (c *Client) CreateSchema(ctx context.Context, req *models.CreateSchemaRequest) (*models.SchemaResponse, error)
CreateSchema calls POST /api/v1/schemas.
func (*Client) GetApplication ¶
func (c *Client) GetApplication(ctx context.Context, applicationID string) (*models.ApplicationResponse, error)
GetApplication calls GET /api/v1/applications/{applicationId}.
func (*Client) ListApplications ¶
func (c *Client) ListApplications(ctx context.Context, memberID *string) (*ApplicationCollection, error)
ListApplications calls GET /api/v1/applications, optionally filtered to one member's applications.
func (*Client) UpdateApplicationPolicy ¶
func (c *Client) UpdateApplicationPolicy(ctx context.Context, applicationID string, req *models.UpdateApplicationPolicyRequest) (*models.ApplicationResponse, error)
UpdateApplicationPolicy calls PUT /api/v1/applications/{applicationId}/policy to replace an existing application's allow-list.