-
Notifications
You must be signed in to change notification settings - Fork 302
/
api_key_created.go
68 lines (53 loc) · 2.51 KB
/
api_key_created.go
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
// 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.
package emails
import (
"fmt"
"go.thethings.network/lorawan-stack/v3/pkg/ttnpb"
)
// APIKeyCreated is the email that is sent when users creates a new API key
type APIKeyCreated struct {
Data
Key *ttnpb.APIKey
Rights []ttnpb.Right
}
// Identifier returns the pretty name of the API key.
// The naming of this method is for compatibility reasons.
func (a APIKeyCreated) Identifier() string {
return a.Key.PrettyName()
}
// ConsoleURL returns the URL to the API key in the Console.
func (a APIKeyCreated) ConsoleURL() string {
if a.Entity.Type == "user" {
return fmt.Sprintf("%s/user/api-keys/%s", a.Network.ConsoleURL, a.Key.ID)
}
return fmt.Sprintf("%s/%ss/%s/api-keys/%s", a.Network.ConsoleURL, a.Entity.Type, a.Entity.ID, a.Key.ID)
}
// TemplateName returns the name of the template to use for this email.
func (APIKeyCreated) TemplateName() string { return "api_key_created" }
const apiKeyCreatedSubject = `An API key has been created`
const apiKeyCreatedText = `Dear {{.User.Name}},
A new API key "{{.Identifier}}" has been created for {{.Entity.Type}} "{{.Entity.ID}}" on {{.Network.Name}} with the following rights:
{{range $right := .Rights}}
{{$right}} {{end}}
You can go to {{.ConsoleURL}} to view and edit this API key in the Console.
If you prefer to use the command-line interface, you can run the following commands to view or edit this API key:
ttn-lw-cli {{.Entity.Type}}s api-keys get --{{.Entity.Type}}-id {{.Entity.ID}} --api-key-id {{.Key.ID}}
ttn-lw-cli {{.Entity.Type}}s api-keys set --{{.Entity.Type}}-id {{.Entity.ID}} --api-key-id {{.Key.ID}}
For more information on how to use the command-line interface, please refer to the documentation: {{ documentation_url "/getting-started/cli/" }}.
`
// DefaultTemplates returns the default templates for this email.
func (APIKeyCreated) DefaultTemplates() (subject, html, text string) {
return apiKeyCreatedSubject, "", apiKeyCreatedText
}