forked from TheThingsNetwork/lorawan-stack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclient_services.proto
More file actions
113 lines (100 loc) · 3.76 KB
/
client_services.proto
File metadata and controls
113 lines (100 loc) · 3.76 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
// 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 "google/api/annotations.proto";
import "google/protobuf/empty.proto";
import "lorawan-stack/api/client.proto";
import "lorawan-stack/api/identifiers.proto";
import "lorawan-stack/api/rights.proto";
package ttn.lorawan.v3;
option go_package = "go.thethings.network/lorawan-stack/v3/pkg/ttnpb";
service ClientRegistry {
// Create a new OAuth client. This also sets the given organization or user as
// first collaborator with all possible rights.
rpc Create(CreateClientRequest) returns (Client) {
option (google.api.http) = {
post: "/users/{collaborator.user_ids.user_id}/clients"
body: "*"
additional_bindings {
post: "/organizations/{collaborator.organization_ids.organization_id}/clients"
body: "*"
}
};
};
// Get the OAuth client 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(GetClientRequest) returns (Client) {
option (google.api.http) = {
get: "/clients/{client_ids.client_id}"
};
};
// List OAuth clients. See request message for details.
rpc List(ListClientsRequest) returns (Clients) {
option (google.api.http) = {
get: "/clients"
additional_bindings {
get: "/users/{collaborator.user_ids.user_id}/clients"
}
additional_bindings {
get: "/organizations/{collaborator.organization_ids.organization_id}/clients"
}
};
};
rpc Update(UpdateClientRequest) returns (Client) {
option (google.api.http) = {
put: "/clients/{client.ids.client_id}"
body: "*"
};
};
rpc Delete(ClientIdentifiers) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/clients/{client_id}"
};
};
}
service ClientAccess {
rpc ListRights(ClientIdentifiers) returns (Rights) {
option (google.api.http) = {
get: "/clients/{client_id}/rights"
};
};
// Get the rights of a collaborator (member) of the client.
// Pseudo-rights in the response (such as the "_ALL" right) are not expanded.
rpc GetCollaborator(GetClientCollaboratorRequest) returns (GetCollaboratorResponse) {
option (google.api.http) = {
get: "/clients/{client_ids.client_id}/collaborator"
additional_bindings {
get: "/clients/{client_ids.client_id}/collaborator/user/{collaborator.user_ids.user_id}"
}
additional_bindings {
get: "/clients/{client_ids.client_id}/collaborator/organization/{collaborator.organization_ids.organization_id}"
}
};
}
// Set the rights of a collaborator (member) on the client. It is required for the caller to
// have all assigned or/and removed rights.
// Setting a collaborator without rights, removes them.
rpc SetCollaborator(SetClientCollaboratorRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
put: "/clients/{client_ids.client_id}/collaborators"
body: "*"
};
};
rpc ListCollaborators(ListClientCollaboratorsRequest) returns (Collaborators) {
option (google.api.http) = {
get: "/clients/{client_ids.client_id}/collaborators"
};
};
}