ownCloud
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode

GRPC API

settings.proto

AddSettingToBundleRequest

Field Type Label Description
bundle_id string
setting Setting

AddSettingToBundleResponse

Field Type Label Description
setting Setting

AssignRoleToUserRequest

Field Type Label Description
account_uuid string
role_id string the role_id is a bundle_id internally

AssignRoleToUserResponse

Field Type Label Description
assignment UserRoleAssignment

Bool

Field Type Label Description
default bool
label string

Bundle

Field Type Label Description
id string
name string
type Bundle.Type
extension string
display_name string
settings Setting repeated
resource Resource

GetBundleRequest

Field Type Label Description
bundle_id string

GetBundleResponse

Field Type Label Description
bundle Bundle

GetPermissionByIDRequest

Field Type Label Description
permission_id string

GetPermissionByIDResponse

Field Type Label Description
permission Permission

GetValueByUniqueIdentifiersRequest

Field Type Label Description
account_uuid string
setting_id string

GetValueRequest

Field Type Label Description
id string

GetValueResponse

Field Type Label Description
value ValueWithIdentifier

Identifier

Field Type Label Description
extension string
bundle string
setting string

Int

Field Type Label Description
default int64
min int64
max int64
step int64
placeholder string

ListBundlesRequest

Field Type Label Description
bundle_ids string repeated

ListBundlesResponse

Field Type Label Description
bundles Bundle repeated

ListOption

Field Type Label Description
value ListOptionValue
default bool
display_value string

ListOptionValue

Field Type Label Description
string_value string
int_value int64

ListPermissionsByResourceRequest

Field Type Label Description
resource Resource

ListPermissionsByResourceResponse

Field Type Label Description
permissions Permission repeated

ListRoleAssignmentsRequest

Field Type Label Description
account_uuid string

ListRoleAssignmentsResponse

Field Type Label Description
assignments UserRoleAssignment repeated

ListValue

Field Type Label Description
values ListOptionValue repeated

ListValuesRequest

Field Type Label Description
bundle_id string
account_uuid string

ListValuesResponse

Field Type Label Description
values ValueWithIdentifier repeated

MultiChoiceList

Field Type Label Description
options ListOption repeated

Permission

Field Type Label Description
operation Permission.Operation
constraint Permission.Constraint

RemoveRoleFromUserRequest

Field Type Label Description
id string

RemoveSettingFromBundleRequest

Field Type Label Description
bundle_id string
setting_id string

Resource

Field Type Label Description
type Resource.Type
id string

SaveBundleRequest


requests and responses for settings bundles

Field Type Label Description
bundle Bundle

SaveBundleResponse

Field Type Label Description
bundle Bundle

SaveValueRequest

Field Type Label Description
value Value

SaveValueResponse

Field Type Label Description
value ValueWithIdentifier

Setting

Field Type Label Description
id string
name string
display_name string
description string
int_value Int
string_value String
bool_value Bool
single_choice_value SingleChoiceList
multi_choice_value MultiChoiceList
permission_value Permission
resource Resource

SingleChoiceList

Field Type Label Description
options ListOption repeated

String

Field Type Label Description
default string
required bool
min_length int32
max_length int32
placeholder string

UserRoleAssignment

Field Type Label Description
id string id is generated upon saving the assignment
account_uuid string
role_id string the role_id is a bundle_id internally

Value

Field Type Label Description
id string id is the id of the Value. It is generated on saving it.
bundle_id string
setting_id string setting_id is the id of the setting from within its bundle.
account_uuid string
resource Resource
bool_value bool
int_value int64
string_value string
list_value ListValue

ValueWithIdentifier

Field Type Label Description
identifier Identifier
value Value

Bundle.Type

Name Number Description
TYPE_UNKNOWN 0
TYPE_DEFAULT 1
TYPE_ROLE 2

Permission.Constraint

Name Number Description
CONSTRAINT_UNKNOWN 0
CONSTRAINT_OWN 1
CONSTRAINT_SHARED 2
CONSTRAINT_ALL 3

Permission.Operation

Name Number Description
OPERATION_UNKNOWN 0
OPERATION_CREATE 1
OPERATION_READ 2
OPERATION_UPDATE 3
OPERATION_DELETE 4
OPERATION_WRITE 5 WRITE is a combination of CREATE and UPDATE
OPERATION_READWRITE 6 READWRITE is a combination of READ and WRITE

Resource.Type

Name Number Description
TYPE_UNKNOWN 0
TYPE_SYSTEM 1
TYPE_FILE 2
TYPE_SHARE 3
TYPE_SETTING 4
TYPE_BUNDLE 5
TYPE_USER 6
TYPE_GROUP 7

BundleService

PermissionService

Method Name Request Type Response Type Description
ListPermissionsByResource ListPermissionsByResourceRequest ListPermissionsByResourceResponse
GetPermissionByID GetPermissionByIDRequest GetPermissionByIDResponse

RoleService

Method Name Request Type Response Type Description
ListRoles ListBundlesRequest ListBundlesResponse
ListRoleAssignments ListRoleAssignmentsRequest ListRoleAssignmentsResponse
AssignRoleToUser AssignRoleToUserRequest AssignRoleToUserResponse
RemoveRoleFromUser RemoveRoleFromUserRequest .google.protobuf.Empty

ValueService

Method Name Request Type Response Type Description
SaveValue SaveValueRequest SaveValueResponse
GetValue GetValueRequest GetValueResponse
ListValues ListValuesRequest ListValuesResponse
GetValueByUniqueIdentifiers GetValueByUniqueIdentifiersRequest GetValueResponse

Scalar Value Types

.proto Type Notes C++ Java
double
double double
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
int64
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long
uint32
Uses variable-length encoding. uint32 int
uint64
Uses variable-length encoding. uint64 long
sint32
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int
sint64
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long
fixed32
Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int
fixed64
Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long
sfixed32
Always four bytes. int32 int
sfixed64
Always eight bytes. int64 long
bool
bool boolean
string
A string must always contain UTF-8 encoded or 7-bit ASCII text. string String
bytes
May contain any arbitrary sequence of bytes. string ByteString