Skip to content

ReefLogic::common_proto API Reference

This page is generated from the protobuf sources under 1000_shared/001_models/proto and the per-service proto files in 2000_server/. Each Package section below lists the messages, enums, and gRPC services in that package with field tags, types, labels, and the inline comments authored in the .proto files. Use the Packages at a Glance table to jump to a package; horizontal dividers separate package boundaries.

Generated on 2026-05-23T06:49:43.917Z.

Proto files processed: 15

Packages at a Glance

Package Source
reeflogic.admin.v1 1000_shared/001_models/proto/common/admin.proto
reeflogic.client_oidc.v1 1000_shared/001_models/proto/common/client_oidc.proto
reeflogic.cmd.v1 1000_shared/001_models/proto/common/cmd.proto
reeflogic.common.v1 1000_shared/001_models/proto/common/common.proto
reeflogic.grant.v1 1000_shared/001_models/proto/common/grant.proto
reeflogic.oidc.v1 1000_shared/001_models/proto/common/oidc.proto
reeflogic.permission.v1 1000_shared/001_models/proto/common/permission.proto
reeflogic.query.v1 1000_shared/001_models/proto/common/query.proto
reeflogic.role.v1 1000_shared/001_models/proto/common/role.proto
reeflogic.tenant.v1 1000_shared/001_models/proto/common/tenant.proto
reeflogic.status.v1 2000_server/050_server/proto/reef_status_service.proto
reeflogic.server.v1 2000_server/050_server/proto/reef_survey_service.proto
reeflogic.admin.v1 2000_server/100_server_admin/proto/reef_admin_service.proto
reeflogic.init.v1 2000_server/100_server_admin/proto/reef_init_service.proto
reeflogic.status.v1 2000_server/100_server_admin/proto/reef_status_service.proto

Package reeflogic.admin.v1

Source proto: 1000_shared/001_models/proto/common/admin.proto

Imports

  • common/common.proto
  • common/oidc.proto

Messages

ServerStatus

Tag Field Type Label Description
1 initialized bool - -
2 version_major int32 - -
3 version_minor int32 - -
4 version_patch int32 - -
5 commit_hash string - -
6 public_key reeflogic.common.v1.MLKEMPublicKey - -
7 admin_oidc_provider reeflogic.oidc.v1.OidcProvider optional -

ReefInitialize

Tag Field Type Label Description
1 proposed_admin_provider reeflogic.oidc.v1.OidcProvider - -
2 oidc_access_token string - -
3 install_secret string - -
4 client_kem_public_key bytes - -
5 pin_wrapped_dek bytes optional -
6 encrypted_client_profile bytes optional -
7 pin_kem_envelope bytes optional -

Package reeflogic.client_oidc.v1

Source proto: 1000_shared/001_models/proto/common/client_oidc.proto

Imports

  • common/oidc.proto

Messages

ClientOidcConfig

Tag Field Type Label Description
1 provider_uuid string - -
2 scope reeflogic.oidc.v1.OidcProvider.Scope - -
3 tenant_uuid string - -
4 issuer string - -
5 audience string - -
6 client_id string - -
7 requested_scopes string repeated -
8 redirect_uri_template string - -
9 groups_claim_name string - -

ClientOidcDiscoveryCache

Tag Field Type Label Description
1 authorization_endpoint string - -
2 token_endpoint string - -
3 userinfo_endpoint string - -
4 introspection_endpoint string - -
5 end_session_endpoint string - -
6 jwks_json string - -
7 jwks_fetched_unix_seconds int64 - -
8 discovery_fetched_unix_seconds int64 - -

ClientOidcSession

Tag Field Type Label Description
1 subject_id string - -
2 display_name string - -
3 mail string - -
4 access_token_keychain_ref string - -
5 refresh_token_keychain_ref string - -
6 access_token_exp_unix_seconds int64 - -
7 refresh_token_exp_unix_seconds int64 - -
8 token_type string - -
9 resolved_group_uuids string repeated -
10 last_successful_login_unix_seconds int64 - -

persisted

Tag Field Type Label Description
1 config ClientOidcConfig - -
2 discovery ClientOidcDiscoveryCache - -
3 session ClientOidcSession - -

Package reeflogic.cmd.v1

Source proto: 1000_shared/001_models/proto/common/cmd.proto

Imports

  • google/protobuf/descriptor.proto
  • google/protobuf/empty.proto
  • google/rpc/status.proto
  • common/permission.proto
  • common/role.proto
  • common/grant.proto
  • common/oidc.proto
  • common/tenant.proto

Messages

AdminExecuteRequest

Tag Field Type Label Description
1 request_id string - -
2 client_version string optional -
3 kind AdminCommandKind - -
4 permission_view reeflogic.permission.v1.PermissionQueryRequest - -
5 role_view reeflogic.role.v1.RoleQueryRequest - -
6 role_create reeflogic.role.v1.RoleCreateRequest - -
7 role_delete reeflogic.role.v1.RoleDeleteRequest - -
8 role_update reeflogic.role.v1.RoleUpdateRequest - -
9 oidc_provider_view reeflogic.oidc.v1.OidcProviderQueryRequest - -
10 oidc_provider_update reeflogic.oidc.v1.OidcProviderUpdateRequest - -
11 role_copy reeflogic.role.v1.RoleCopyRequest - -
12 grant_view reeflogic.grant.v1.GrantQueryRequest - -
13 grant_create reeflogic.grant.v1.GrantCreateRequest - -
14 grant_update reeflogic.grant.v1.GrantUpdateRequest - -
15 grant_delete reeflogic.grant.v1.GrantDeleteRequest - -
16 tenant_view reeflogic.tenant.v1.TenantQueryRequest - -
17 tenant_create reeflogic.tenant.v1.TenantCreateRequest - -
18 tenant_update reeflogic.tenant.v1.TenantUpdateRequest - -
19 tenant_retire reeflogic.tenant.v1.TenantRetireRequest - -
20 tenant_delete reeflogic.tenant.v1.TenantDeleteRequest - -

AdminExecuteReply

Tag Field Type Label Description
1 request_id string - -
2 status google.rpc.Status - -
3 permission_view reeflogic.permission.v1.PermissionQueryReply - -
4 role_view reeflogic.role.v1.RoleQueryReply - -
5 role_create reeflogic.role.v1.RoleQueryReply - -
6 role_delete google.protobuf.Empty - -
7 role_update reeflogic.role.v1.RoleQueryReply - -
8 oidc_provider_view reeflogic.oidc.v1.OidcProviderQueryReply - -
9 oidc_provider_update reeflogic.oidc.v1.OidcProviderUpdateReply - -
10 role_copy reeflogic.role.v1.RoleQueryReply - -
11 grant_view reeflogic.grant.v1.GrantQueryReply - -
12 grant_create reeflogic.grant.v1.GrantQueryReply - -
13 grant_update reeflogic.grant.v1.GrantQueryReply - -
14 grant_delete google.protobuf.Empty - -
15 tenant_view reeflogic.tenant.v1.TenantQueryReply - -
16 tenant_create reeflogic.tenant.v1.TenantQueryReply - -
17 tenant_update reeflogic.tenant.v1.TenantQueryReply - -
18 tenant_retire google.protobuf.Empty - -
19 tenant_delete google.protobuf.Empty - -

RuntimeExecuteRequest

Tag Field Type Label Description
1 request_id string - -
2 client_version string optional -
3 kind RuntimeCommandKind - -
4 survey_view google.protobuf.Empty - -

RuntimeExecuteReply

Tag Field Type Label Description
1 request_id string - -
2 status google.rpc.Status - -

Enums

AdminCommandKind

Name Value Description
ADMIN_COMMAND_KIND_UNSPECIFIED 0 -

RuntimeCommandKind

Name Value Description
RUNTIME_COMMAND_KIND_UNSPECIFIED 0 -

Package reeflogic.common.v1

Source proto: 1000_shared/001_models/proto/common/common.proto

Messages

ReefSiteId

Tag Field Type Label Description
1 value string - -

GeoPoint

Tag Field Type Label Description
1 latitude double - -
2 longitude double - -
3 depth_meters double - -

AuditInfo

Tag Field Type Label Description
1 created_by string - -
2 created_unix_seconds int64 - -
3 updated_unix_seconds int64 - -

Pagination

Tag Field Type Label Description
1 page_size uint32 - -
2 page_token string - -

PagedResultMetadata

Tag Field Type Label Description
1 next_page_token string - -
2 total_items uint32 - -

MLKEMPublicKey

Tag Field Type Label Description
1 public_key bytes - -

Package reeflogic.grant.v1

Source proto: 1000_shared/001_models/proto/common/grant.proto

Imports

  • google/protobuf/timestamp.proto
  • common/query.proto

Messages

Grant

Tag Field Type Label Description
1 id int64 - -
2 created_on google.protobuf.Timestamp - -
3 modified_on google.protobuf.Timestamp - -
4 uuid string - -
5 role_uuid string - -
6 role_name string - -
7 role_origin string - -
8 perm_uuid string - -
9 perm_label string - -
10 perm_domain string - -
11 mask uint64 - -
12 valid_until google.protobuf.Timestamp optional -

GrantData

Tag Field Type Label Description
1 role_uuid string - -
2 perm_uuid string - -
3 mask uint64 - -
4 valid_until google.protobuf.Timestamp optional -

GrantQueryRequest

Tag Field Type Label Description
1 query reeflogic.query.v1.Query - -
2 role_uuid string optional -

GrantCreateRequest

Tag Field Type Label Description
1 grant_data GrantData - -

GrantUpdateRequest

Tag Field Type Label Description
1 grant_uuid string - -
2 grant_data GrantData - -

GrantDeleteRequest

Tag Field Type Label Description
1 grant_uuid string repeated -

GrantQueryReply

Tag Field Type Label Description
1 query_result reeflogic.query.v1.QueryResult - -
2 grant Grant repeated -

Package reeflogic.oidc.v1

Source proto: 1000_shared/001_models/proto/common/oidc.proto

Imports

  • common/query.proto

Messages

OidcConnection

Tag Field Type Label Description
1 uuid string optional -
2 idp_uuid string optional -
3 issuer string - -
4 audience string - -
5 use_discovery bool - -
6 discovery_url_override string - -
7 jwks_url_override string - -
8 user_info_url_override string - -
9 introspection_url_override string - -
10 introspection_client_id string - -
11 introspection_client_secret string optional -
12 token_mode TokenMode - -
13 allow_userinfo_fallback bool - -
14 allow_introspection_fallback bool - -
15 clock_skew_seconds int32 - -
16 connect_timeout_ms int32 - -
17 read_timeout_ms int32 - -

OidcProvider

Tag Field Type Label Description
1 uuid string optional -
2 scope Scope - -
3 tenant_uuid string optional -
4 connection OidcConnection - -

family

Tag Field Type Label Description
1 query reeflogic.query.v1.Query - -

OidcProviderQueryReply

Tag Field Type Label Description
1 query_result reeflogic.query.v1.QueryResult - -
2 provider OidcProvider repeated -

OidcProviderUpdateRequest

Tag Field Type Label Description
1 provider OidcProvider - -

OidcProviderUpdateReply

Tag Field Type Label Description
1 provider OidcProvider - -

Enums

TokenMode

Name Value Description
OIDC_TOKEN_MODE_UNSPECIFIED 0 -
OIDC_TOKEN_MODE_JWT_LOCAL 1 -
OIDC_TOKEN_MODE_JWT_USERINFO 2 -
OIDC_TOKEN_MODE_OPAQUE_INTROSPECT 3 -
OIDC_TOKEN_MODE_AUTO 4 -

Scope

Name Value Description
SCOPE_UNSPECIFIED 0 -
SCOPE_ADMIN 1 -
SCOPE_TENANT 2 -

Package reeflogic.permission.v1

Source proto: 1000_shared/001_models/proto/common/permission.proto

Imports

  • google/protobuf/timestamp.proto
  • common/query.proto

Messages

Permission

Tag Field Type Label Description
1 id int64 - -
2 created_on google.protobuf.Timestamp - -
3 modified_on google.protobuf.Timestamp - -
4 uuid string - -
5 domain string - -
6 name string - -
7 description string - -

PermissionQueryRequest

Tag Field Type Label Description
1 query reeflogic.query.v1.Query - -

PermissionQueryReply

Tag Field Type Label Description
1 query_result reeflogic.query.v1.QueryResult - -
2 permission Permission repeated -

Package reeflogic.query.v1

Source proto: 1000_shared/001_models/proto/common/query.proto

Messages

Query

Tag Field Type Label Description
1 page_number int64 - -
2 page_size int64 - -
3 mode QueryMode - -
4 query string optional -

QueryResult

Tag Field Type Label Description
1 page_number int64 - -
2 page_size int64 - -
3 total_records int64 - -

Enums

QueryMode

Name Value Description
QUERY_MODE_WEB 0 -
QUERY_MODE_PLAIN 1 -
QUERY_MODE_ILIKE 2 -

Package reeflogic.role.v1

Source proto: 1000_shared/001_models/proto/common/role.proto

Imports

  • google/protobuf/timestamp.proto
  • common/query.proto

Messages

Role

Tag Field Type Label Description
1 id int64 - -
2 created_on google.protobuf.Timestamp - -
3 modified_on google.protobuf.Timestamp - -
4 uuid string - -
5 tenant_id int64 optional -
6 role string - -
7 domain string - -
8 name string - -
9 description string - -
10 valid_until google.protobuf.Timestamp optional -
11 origin string - -
12 template_key string optional -

RoleQueryRequest

Tag Field Type Label Description
1 query reeflogic.query.v1.Query - -

RoleData

Tag Field Type Label Description
1 tenant_id int64 optional -
2 role string - -
3 domain string - -
4 name string - -
5 description string - -
6 valid_until google.protobuf.Timestamp optional -
7 template_key string optional -
8 uuid string optional -

RoleCreateRequest

Tag Field Type Label Description
1 role_data RoleData - -

RoleDeleteRequest

Tag Field Type Label Description
1 tenant_uuid string optional -
2 role_uuid string repeated -

RoleUpdateRequest

Tag Field Type Label Description
1 tenant_uuid string optional -
2 role_uuid string - -
3 role_data RoleData - -

RoleCopyRequest

Tag Field Type Label Description
1 source_role_uuid string - -
2 role_data RoleData - -

RoleQueryReply

Tag Field Type Label Description
1 query_result reeflogic.query.v1.QueryResult - -
2 role Role repeated -

Package reeflogic.tenant.v1

Source proto: 1000_shared/001_models/proto/common/tenant.proto

Imports

  • google/protobuf/timestamp.proto
  • common/query.proto
  • common/oidc.proto

Messages

Tenant

Tag Field Type Label Description
1 id int64 - -
2 created_on google.protobuf.Timestamp - -
3 modified_on google.protobuf.Timestamp - -
4 uuid string - -
5 tenant string - -
6 display_name string - -
7 valid_until google.protobuf.Timestamp optional -
8 oidc_provider reeflogic.oidc.v1.OidcProvider - -

TenantData

Tag Field Type Label Description
1 tenant string - -
2 display_name string - -
3 valid_until google.protobuf.Timestamp optional -
4 uuid string optional -
5 oidc_connection reeflogic.oidc.v1.OidcConnection - -

family

Tag Field Type Label Description
1 query reeflogic.query.v1.Query - -

TenantQueryReply

Tag Field Type Label Description
1 query_result reeflogic.query.v1.QueryResult - -
2 tenant Tenant repeated -

TenantCreateRequest

Tag Field Type Label Description
1 tenant_data TenantData - -

TenantUpdateRequest

Tag Field Type Label Description
1 tenant_uuid string - -
2 tenant_data TenantData - -

TenantRetireRequest

Tag Field Type Label Description
1 tenant_uuid string repeated -

TenantDeleteRequest

Tag Field Type Label Description
1 tenant_uuid string repeated -

Package reeflogic.status.v1

Source proto: 2000_server/050_server/proto/reef_status_service.proto

Imports

  • common/admin.proto
  • google/protobuf/empty.proto

Services

name

RPC Request Response Description
is_initialized google.protobuf.Empty reeflogic.admin.v1.ServerStatus -

Package reeflogic.server.v1

Source proto: 2000_server/050_server/proto/reef_survey_service.proto

Imports

  • common/cmd.proto

Services

ReefSurveyService

RPC Request Response Description
execute reeflogic.cmd.v1.RuntimeExecuteRequest reeflogic.cmd.v1.RuntimeExecuteReply -

Package reeflogic.admin.v1

Source proto: 2000_server/100_server_admin/proto/reef_admin_service.proto

Imports

  • common/cmd.proto

Services

ReefAdminService

RPC Request Response Description
execute reeflogic.cmd.v1.AdminExecuteRequest reeflogic.cmd.v1.AdminExecuteReply -

Package reeflogic.init.v1

Source proto: 2000_server/100_server_admin/proto/reef_init_service.proto

Imports

  • common/admin.proto
  • google/protobuf/empty.proto

Services

ReefInitService

RPC Request Response Description
initialize reeflogic.admin.v1.ReefInitialize google.protobuf.Empty -

Package reeflogic.status.v1

Source proto: 2000_server/100_server_admin/proto/reef_status_service.proto

Imports

  • common/admin.proto
  • google/protobuf/empty.proto

Services

ReefStatusService

RPC Request Response Description
is_initialized google.protobuf.Empty reeflogic.admin.v1.ServerStatus -