Auth API

Table of Contents

• upsquad/auth/v1/api_key.proto

  • APIKeyInfo

  • CreateAPIKeyRequest

  • CreateAPIKeyResponse

  • ListAPIKeysRequest

  • ListAPIKeysResponse

  • RevokeAPIKeyRequest

  • RevokeAPIKeyResponse

  • RotateAPIKeyRequest

  • RotateAPIKeyResponse

  • APIKeyService

• upsquad/auth/v1/context.proto

  • TenantContext

• Scalar Value Types

Top

upsquad/auth/v1/api_key.proto

APIKeyInfo

APIKeyInfo is the non-secret metadata for a single API key.

Field	Type	Label	Description
key_id	string		key_id is the UUID of the key row.
key_prefix	string		key_prefix is the first 12 characters for human identification.
member_id	string		member_id is the member the key was issued to.
team_id	string		team_id is the team the key belongs to.
scoped_agent_id	string	optional	scoped_agent_id is set if the key is restricted to a single agent.
is_active	bool		is_active indicates whether the key is currently valid.
created_at	google.protobuf.Timestamp		created_at is when the key was created.
expires_at	google.protobuf.Timestamp	optional	expires_at is when the key expires, if set.

CreateAPIKeyRequest

CreateAPIKeyRequest provisions a new API key.

Field	Type	Label	Description
team_id	string		team_id is the team the key belongs to.
member_id	string		member_id is the member the key is issued to.
scoped_agent_id	string	optional	scoped_agent_id optionally restricts the key to a single agent.
expires_at	google.protobuf.Timestamp	optional	expires_at optionally sets key expiration.

CreateAPIKeyResponse

CreateAPIKeyResponse returns the newly created key details.

Field	Type	Label	Description
key_id	string		key_id is the UUID of the created key row.
raw_key	string		raw_key is the full plaintext key. Only returned once, on creation.
key_prefix	string		key_prefix is the first 12 characters for human identification.
created_at	google.protobuf.Timestamp		created_at is when the key was created.
expires_at	google.protobuf.Timestamp	optional	expires_at is when the key expires, if set.

ListAPIKeysRequest

ListAPIKeysRequest lists keys in the caller's organisation.

Field	Type	Label	Description
member_id	string	optional	member_id optionally filters by member. Empty returns all org keys.

ListAPIKeysResponse

ListAPIKeysResponse returns key metadata.

Field	Type	Label	Description
keys	APIKeyInfo	repeated	keys is the list of API key metadata records.

RevokeAPIKeyRequest

RevokeAPIKeyRequest revokes a key by ID.

Field	Type	Label	Description
key_id	string		key_id is the UUID of the key to revoke.

RevokeAPIKeyResponse

RevokeAPIKeyResponse is empty on success.

RotateAPIKeyRequest

RotateAPIKeyRequest rotates an existing key by ID.

Field	Type	Label	Description
key_id	string		key_id is the UUID of the key to rotate.

RotateAPIKeyResponse

RotateAPIKeyResponse returns the new key and confirms revocation of the old.

Field	Type	Label	Description
new_key_id	string		new_key_id is the UUID of the newly created key.
raw_key	string		raw_key is the new full plaintext key. Only returned once.
key_prefix	string		key_prefix is the first 12 characters of the new key.
revoked_key_id	string		revoked_key_id is the UUID of the old key that was revoked.

APIKeyService

APIKeyService manages the lifecycle of member API keys within an organisation. All operations are scoped to the caller's org_id via JWT-derived claims.

Method Name	Request Type	Response Type	Description
CreateAPIKey	CreateAPIKeyRequest	CreateAPIKeyResponse	CreateAPIKey provisions a new API key for a member. The raw key is returned only once in the response and is never stored or retrievable.
RotateAPIKey	RotateAPIKeyRequest	RotateAPIKeyResponse	RotateAPIKey atomically revokes an existing key and creates a replacement. The new raw key is returned only once.
RevokeAPIKey	RevokeAPIKeyRequest	RevokeAPIKeyResponse	RevokeAPIKey deactivates an existing key. The key row is retained for audit purposes but is no longer valid for authentication.
ListAPIKeys	ListAPIKeysRequest	ListAPIKeysResponse	ListAPIKeys returns metadata for all keys in the caller's organisation, optionally filtered by member_id.

Top

upsquad/auth/v1/context.proto

TenantContext

TenantContext is the authenticated caller envelope constructed by the gateway after JWT verification. It flows through middleware and is attached to request contexts so downstream handlers, interceptors, and RLS-aware DB helpers share a single source of truth for the caller's tenant, identity, clearance tier, and global role grants.

Field	Type	Label	Description
tenant_id	string		Tenant (organisation) id the caller is authenticated against.
member_id	string		Member id of the caller within tenant_id. May be empty when the Clerk subject has not yet been mapped to a members row (e.g. first request post-signup before the provisioning webhook has fired) — consumers MUST treat an empty value as "no scoped grants known".
clearance_level	int32		Numeric clearance tier in the closed range [1, 5]. Mirrors members.clearance. Zero is legal and means "not yet resolved"; governance gates default-deny on zero.
clearance_label	string		Display-grade clearance label. One of: 1 => "Standard" 2 => "Internal" 3 => "Sensitive" 4 => "Privileged" 5 => "Executive" Matches the CHECK constraint on members.clearance_label added in migration 062. Empty string when clearance_level == 0.
global_role_ids	string	repeated	Global role ids granted to member_id (scope_type='global' rows in role_assignments, deleted_at IS NULL). Sorted for deterministic serialisation. Length is strictly <= 20 per HLD §6.2.3; the builder REJECTS construction for members that exceed the cap so this field is safe to trust as bounded at the boundary.

Scoped role ids (org_unit / member) are intentionally OMITTED here and resolved via PermissionResolver. See the package documentation on internal/rbac/resolver.go for the rationale (HLD §5.3 / §4.3.2). | | clerk_user_id | string | | Clerk user id (Clerk's sub claim). Preserved so downstream audit writers can attribute actions even when member_id is empty. |

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)