forked from TheThingsNetwork/lorawan-stack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathorganization_services.proto
More file actions
123 lines (107 loc) · 4.14 KB
/
organization_services.proto
File metadata and controls
123 lines (107 loc) · 4.14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
// Copyright © 2019 The Things Network Foundation, The Things Industries B.V.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
import "github.com/gogo/protobuf/gogoproto/gogo.proto";
import "google/api/annotations.proto";
import "google/protobuf/empty.proto";
import "lorawan-stack/api/identifiers.proto";
import "lorawan-stack/api/organization.proto";
import "lorawan-stack/api/rights.proto";
package ttn.lorawan.v3;
option go_package = "go.thethings.network/lorawan-stack/pkg/ttnpb";
service OrganizationRegistry {
// Create a new organization. This also sets the given user as
// first collaborator with all possible rights.
rpc Create(CreateOrganizationRequest) returns (Organization) {
option (google.api.http) = {
post: "/users/{collaborator.user_ids.user_id}/organizations"
body: "*"
};
};
// Get the organization with the given identifiers, selecting the fields given
// by the field mask. The method may return more or less fields, depending on
// the rights of the caller.
rpc Get(GetOrganizationRequest) returns (Organization) {
option (google.api.http) = {
get: "/organizations/{organization_ids.organization_id}"
};
};
// List organizations. See request message for details.
rpc List(ListOrganizationsRequest) returns (Organizations) {
option (google.api.http) = {
get: "/organizations"
additional_bindings {
get: "/users/{collaborator.user_ids.user_id}/organizations"
}
};
};
rpc Update(UpdateOrganizationRequest) returns (Organization) {
option (google.api.http) = {
put: "/organizations/{organization.ids.organization_id}"
body: "*"
};
};
rpc Delete(OrganizationIdentifiers) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/organizations/{organization_id}"
};
};
}
service OrganizationAccess {
rpc ListRights(OrganizationIdentifiers) returns (Rights) {
option (google.api.http) = {
get: "/organizations/{organization_id}/rights"
};
};
rpc CreateAPIKey(CreateOrganizationAPIKeyRequest) returns (APIKey) {
option (google.api.http) = {
post: "/organizations/{organization_ids.organization_id}/api-keys"
body: "*"
};
};
rpc ListAPIKeys(ListOrganizationAPIKeysRequest) returns (APIKeys) {
option (google.api.http) = {
get: "/organizations/{organization_ids.organization_id}/api-keys"
};
};
rpc GetAPIKey(GetOrganizationAPIKeyRequest) returns (APIKey) {
option (google.api.http) = {
get: "/organizations/{organization_ids.organization_id}/api-keys/{key_id}"
};
};
// Update the rights of an existing organization API key. To generate an API key,
// the CreateAPIKey should be used. To delete an API key, update it
// with zero rights.
rpc UpdateAPIKey(UpdateOrganizationAPIKeyRequest) returns (APIKey) {
option (google.api.http) = {
put: "/organizations/{organization_ids.organization_id}/api-keys/{api_key.id}"
body: "*"
};
};
// Set the rights of a collaborator (member) on the organization. Users
// are considered to be a collaborator if they have at least one right on the
// organization.
// Note that only users can collaborate (be member of) an organization.
rpc SetCollaborator(SetOrganizationCollaboratorRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
put: "/organizations/{organization_ids.organization_id}/collaborators"
body: "*"
};
};
rpc ListCollaborators(ListOrganizationCollaboratorsRequest) returns (Collaborators) {
option (google.api.http) = {
get: "/organizations/{organization_ids.organization_id}/collaborators"
};
};
}