README
¶
pkg/handler/organizations
This package is the tenancy-root handler client for the identity API.
Intent
Most handler clients operate inside an organization or project scope that has already been resolved. This client is different: it is responsible for turning authenticated caller context into the set of organizations that caller can see, and for exposing the organization metadata that the rest of the handler tree depends on.
Its main responsibilities are:
- list organizations visible to the current caller
- return individual organization details
- create, update, and delete organization resources
- provide organization metadata, especially the namespace currently used by
v1org-scoped handlers
What Is Specific Here
Membership-Driven Listing
Organization listing is not ordinary namespace CRUD.
For callers with global organization-read authority, the client returns all organizations. Otherwise it derives visibility from identity membership:
- users are mapped through
OrganizationUserrecords - service accounts are mapped to their bound organization
- an optional email filter can be used to ask "which organizations is this user in?", with additional permission checks when the caller is not querying their own identity
That makes this package the bridge between authenticated identity context and organization-level visibility.
Namespace Handoff To The Rest Of v1
For the current v1 API model, the rest of the organization-scoped handler tree depends on this
client to expose the organization namespace from status metadata.
That namespace is then used by downstream clients such as projects, groups, users, service accounts, quotas, and organization-scoped OAuth2 providers to find or store child resources.
This is important current behaviour, but it is also transition-bound. As described in
pkg/apis/unikorn/v1alpha1, the v2 API direction
reduces the long-term architectural importance of namespace handoff by moving away from
organization/project-scoped routing.
Secondary Support For Built-In Domain Login Routing
The organization resource also carries the domain/provider mapping used by the built-in OAuth2/OIDC path when email-domain-based IdP selection is in use.
That is no longer the main production design center of identity, but it remains supported as part of the low-friction built-in authn path used for development, testing, and self-contained deployments. This package therefore still translates that configuration into and out of the organization resource, even though membership and tenancy-root responsibilities are more central to its present-day role.
Invariants
- organization visibility is derived from authenticated identity context, not from unauthenticated query parameters
- service accounts only see their bound organization through this path
- the organization client is the source of namespace metadata used by the current
v1org-scoped handler tree - organization reads and writes use the same persisted organization resource contract defined in
pkg/apis/unikorn/v1alpha1 - domain/provider mapping, when used, is configuration on the organization resource rather than a separate lookup model in the handler layer
Caveats
- This package makes stronger assumptions about cross-resource consistency than most of the other handler clients because a broken organization->membership edge affects the root of the visibility tree.
- The current namespace handoff behaviour is important for
v1, but it is not the intended final API shape. - Domain/provider-directed login behaviour remains supported, but it is a secondary path relative to the package's main tenancy-root and membership-resolution role.
TODO
- Fail closed when organization namespace metadata is unset or otherwise unusable before handing it
to downstream
v1org-scoped handler clients. - Revisit membership-list resilience so orphaned
OrganizationUserreferences do not necessarily break the entire organization listing path for the caller.
Related Documentation
pkg/apis/unikorn/v1alpha1, which defines the persistedOrganizationandOrganizationUserresources consumed herepkg/userdb, which provides the local user and service-account membership lookups used by the organization visibility pathpkg/rbac, which defines the authority model that shapes which organizations a caller may enumerate or inspect
Documentation
¶
Index ¶
- type Client
- func (c *Client) Create(ctx context.Context, request *openapi.OrganizationWrite) (*openapi.OrganizationRead, error)
- func (c *Client) Delete(ctx context.Context, organizationID ids.OrganizationID) error
- func (c *Client) Get(ctx context.Context, organizationID ids.OrganizationID) (*openapi.OrganizationRead, error)
- func (c *Client) GetMetadata(ctx context.Context, organizationID ids.OrganizationID) (*Meta, error)
- func (c *Client) List(ctx context.Context, userdb *userdb.UserDatabase, email *string) (openapi.Organizations, error)
- func (c *Client) Update(ctx context.Context, organizationID ids.OrganizationID, ...) error
- type Meta
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) Create ¶ added in v0.2.47
func (c *Client) Create(ctx context.Context, request *openapi.OrganizationWrite) (*openapi.OrganizationRead, error)
func (*Client) Get ¶ added in v0.2.5
func (c *Client) Get(ctx context.Context, organizationID ids.OrganizationID) (*openapi.OrganizationRead, error)
func (*Client) GetMetadata ¶ added in v0.2.0
GetMetadata retrieves the organization metadata. Clients should consult at least the Active status before doing anything with the organization.
func (*Client) List ¶
func (c *Client) List(ctx context.Context, userdb *userdb.UserDatabase, email *string) (openapi.Organizations, error)
func (*Client) Update ¶ added in v0.2.5
func (c *Client) Update(ctx context.Context, organizationID ids.OrganizationID, request *openapi.OrganizationWrite) error
type Meta ¶ added in v0.2.0
type Meta struct {
// ID is the organization's typed identifier, propagated from the validated
// path parameter so callers downstream of GetMetadata keep type safety.
ID ids.OrganizationID
// Namespace is the namespace that is provisioned by the organization.
// Should be usable set when the organization is active.
Namespace string
}
Meta describes the organization.
Source Files