forked from TheThingsNetwork/lorawan-stack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathuser_services.proto
More file actions
149 lines (129 loc) · 4.25 KB
/
user_services.proto
File metadata and controls
149 lines (129 loc) · 4.25 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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
// 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/identifiers.proto";
import "lorawan-stack/api/rights.proto";
import "lorawan-stack/api/user.proto";
package ttn.lorawan.v3;
option go_package = "go.thethings.network/lorawan-stack/v3/pkg/ttnpb";
service UserRegistry {
// Register a new user. This method may be restricted by network settings.
rpc Create(CreateUserRequest) returns (User) {
option (google.api.http) = {
post: "/users"
body: "*"
};
};
// Get the user 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(GetUserRequest) returns (User) {
option (google.api.http) = {
get: "/users/{user_ids.user_id}"
};
};
rpc List(ListUsersRequest) returns (Users) {
option (google.api.http) = {
get: "/users"
};
};
rpc Update(UpdateUserRequest) returns (User) {
option (google.api.http) = {
put: "/users/{user.ids.user_id}"
body: "*"
};
};
// Create a temporary password that can be used for updating a forgotten password.
// The generated password is sent to the user's email address.
rpc CreateTemporaryPassword(CreateTemporaryPasswordRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/users/{user_ids.user_id}/temporary_password"
};
}
rpc UpdatePassword(UpdateUserPasswordRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
put: "/users/{user_ids.user_id}/password"
body: "*"
};
}
rpc Delete(UserIdentifiers) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/users/{user_id}"
};
};
}
service UserAccess {
rpc ListRights(UserIdentifiers) returns (Rights) {
option (google.api.http) = {
get: "/users/{user_id}/rights"
};
};
rpc CreateAPIKey(CreateUserAPIKeyRequest) returns (APIKey) {
option (google.api.http) = {
post: "/users/{user_ids.user_id}/api-keys"
body: "*"
};
};
rpc ListAPIKeys(ListUserAPIKeysRequest) returns (APIKeys) {
option (google.api.http) = {
get: "/users/{user_ids.user_id}/api-keys"
};
};
rpc GetAPIKey(GetUserAPIKeyRequest) returns (APIKey) {
option (google.api.http) = {
get: "/users/{user_ids.user_id}/api-keys/{key_id}"
};
};
// Update the rights of an existing user API key. To generate an API key,
// the CreateAPIKey should be used. To delete an API key, update it
// with zero rights. It is required for the caller to have all assigned or/and removed rights.
rpc UpdateAPIKey(UpdateUserAPIKeyRequest) returns (APIKey) {
option (google.api.http) = {
put: "/users/{user_ids.user_id}/api-keys/{api_key.id}"
body: "*"
};
};
}
service UserInvitationRegistry {
rpc Send(SendInvitationRequest) returns (Invitation) {
option (google.api.http) = {
post: "/invitations"
body: "*"
};
};
rpc List(ListInvitationsRequest) returns (Invitations) {
option (google.api.http) = {
get: "/invitations"
};
};
rpc Delete(DeleteInvitationRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/invitations"
};
};
}
service UserSessionRegistry {
rpc List(ListUserSessionsRequest) returns (UserSessions) {
option (google.api.http) = {
get: "/users/{user_ids.user_id}/sessions"
};
};
rpc Delete(UserSessionIdentifiers) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/users/{user_ids.user_id}/sessions/{session_id}"
};
};
}