-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexample_test.go
More file actions
481 lines (401 loc) · 14.1 KB
/
example_test.go
File metadata and controls
481 lines (401 loc) · 14.1 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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
// Copyright 2025 Company.info 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 keycloak_test provides example usage of the keycloak package.
// These examples demonstrate common use cases and best practices for interacting
// with the Keycloak Admin API using this client library.
package keycloak_test
import (
"context"
"fmt"
"log"
"os"
"time"
"go.companyinfo.dev/keycloak"
"go.companyinfo.dev/ptr"
)
// ExampleNew demonstrates how to create a new Keycloak client.
func ExampleNew() {
ctx := context.Background()
config := keycloak.Config{
URL: os.Getenv("KEYCLOAK_URL"),
Realm: os.Getenv("KEYCLOAK_REALM"),
ClientID: os.Getenv("KEYCLOAK_CLIENT_ID"),
ClientSecret: os.Getenv("KEYCLOAK_CLIENT_SECRET"),
}
client, err := keycloak.New(ctx, config)
if err != nil {
log.Fatalf("Failed to create client: %v", err)
}
// Client is ready to use
_ = client
}
// ExampleNew_withOptions demonstrates creating a client with functional options.
func ExampleNew_withOptions() {
ctx := context.Background()
config := keycloak.Config{
URL: os.Getenv("KEYCLOAK_URL"),
Realm: os.Getenv("KEYCLOAK_REALM"),
ClientID: os.Getenv("KEYCLOAK_CLIENT_ID"),
ClientSecret: os.Getenv("KEYCLOAK_CLIENT_SECRET"),
}
client, err := keycloak.New(ctx, config,
keycloak.WithPageSize(100),
keycloak.WithTimeout(30*time.Second),
keycloak.WithRetry(3, 5*time.Second, 30*time.Second),
)
if err != nil {
log.Fatalf("Failed to create client: %v", err)
}
// Client is ready to use with custom configuration
_ = client
}
// ExampleGroupsClient_Create demonstrates creating a group.
func ExampleGroupsClient_Create() {
ctx := context.Background()
client, _ := keycloak.New(ctx, keycloak.Config{
URL: os.Getenv("KEYCLOAK_URL"),
Realm: os.Getenv("KEYCLOAK_REALM"),
ClientID: os.Getenv("KEYCLOAK_CLIENT_ID"),
ClientSecret: os.Getenv("KEYCLOAK_CLIENT_SECRET"),
})
attributes := map[string][]string{
"description": {"Customer group"},
"type": {"organization"},
}
groupID, err := client.Groups.Create(ctx, "ACME Corp", attributes)
if err != nil {
log.Fatalf("Failed to create group: %v", err)
}
fmt.Printf("Created group with ID: %s\n", groupID)
}
// ExampleGroupsClient_List demonstrates listing groups.
func ExampleGroupsClient_List() {
ctx := context.Background()
client, _ := keycloak.New(ctx, keycloak.Config{
URL: os.Getenv("KEYCLOAK_URL"),
Realm: os.Getenv("KEYCLOAK_REALM"),
ClientID: os.Getenv("KEYCLOAK_CLIENT_ID"),
ClientSecret: os.Getenv("KEYCLOAK_CLIENT_SECRET"),
})
// List all groups with full details
groups, err := client.Groups.List(ctx, nil, false)
if err != nil {
log.Fatalf("Failed to list groups: %v", err)
}
for _, group := range groups {
fmt.Printf("Group: %s (ID: %s)\n", *group.Name, *group.ID)
// Show additional fields from GroupRepresentation
if group.Description != nil {
fmt.Printf(" Description: %s\n", *group.Description)
}
if group.Path != nil {
fmt.Printf(" Path: %s\n", *group.Path)
}
if group.ParentID != nil {
fmt.Printf(" Parent ID: %s\n", *group.ParentID)
}
if group.SubGroupCount != nil {
fmt.Printf(" Subgroup Count: %d\n", *group.SubGroupCount)
}
}
}
// ExampleGroupsClient_ListWithParams demonstrates listing groups with advanced query parameters.
func ExampleGroupsClient_ListWithParams() {
ctx := context.Background()
client, _ := keycloak.New(ctx, keycloak.Config{
URL: "https://keycloak.example.com",
Realm: "my-realm",
ClientID: "admin-cli",
ClientSecret: "secret",
})
// Example 1: Search with exact match and populate hierarchy
searchTerm := "ACME Corp"
params := keycloak.SearchGroupParams{
Search: &searchTerm,
Exact: ptr.Bool(true),
PopulateHierarchy: ptr.Bool(true),
SubGroupsCount: ptr.Bool(true),
}
groups, err := client.Groups.ListWithParams(ctx, params)
if err != nil {
log.Fatalf("Failed to list groups: %v", err)
}
for _, group := range groups {
fmt.Printf("Group: %s (ID: %s)\n", *group.Name, *group.ID)
if group.SubGroups != nil {
fmt.Printf(" Has %d subgroups\n", len(*group.SubGroups))
}
}
// Example 2: Paginated search with brief representation
briefParams := keycloak.SearchGroupParams{
BriefRepresentation: ptr.Bool(true),
First: ptr.Int(0),
Max: ptr.Int(20),
Q: ptr.String("organization"),
}
briefGroups, err := client.Groups.ListWithParams(ctx, briefParams)
if err != nil {
log.Fatalf("Failed to list groups: %v", err)
}
fmt.Printf("Found %d groups matching query\n", len(briefGroups))
// Example 3: Get all top-level groups without subgroups (no search/q parameter)
topLevelParams := keycloak.SearchGroupParams{
BriefRepresentation: ptr.Bool(false),
}
topLevelGroups, err := client.Groups.ListWithParams(ctx, topLevelParams)
if err != nil {
log.Fatalf("Failed to list top-level groups: %v", err)
}
fmt.Printf("Retrieved %d top-level groups\n", len(topLevelGroups))
}
// ExampleGroupsClient_GetByAttribute demonstrates searching for groups by attribute.
func ExampleGroupsClient_GetByAttribute() {
ctx := context.Background()
client, _ := keycloak.New(ctx, keycloak.Config{
URL: os.Getenv("KEYCLOAK_URL"),
Realm: os.Getenv("KEYCLOAK_REALM"),
ClientID: os.Getenv("KEYCLOAK_CLIENT_ID"),
ClientSecret: os.Getenv("KEYCLOAK_CLIENT_SECRET"),
})
attribute := &keycloak.GroupAttribute{
Key: "salesforceID",
Value: "SF-12345",
}
group, err := client.Groups.GetByAttribute(ctx, attribute)
if err == keycloak.ErrGroupNotFound {
log.Println("Group not found")
return
}
if err != nil {
log.Fatalf("Error: %v", err)
}
fmt.Printf("Found group: %s\n", *group.Name)
}
// ExampleGroupsClient_CreateSubGroup demonstrates creating subgroups.
func ExampleGroupsClient_CreateSubGroup() {
ctx := context.Background()
client, _ := keycloak.New(ctx, keycloak.Config{
URL: os.Getenv("KEYCLOAK_URL"),
Realm: "my-realm",
ClientID: "admin-cli",
ClientSecret: "secret",
})
parentGroupID := "parent-group-id"
attributes := map[string][]string{
"type": {"account"},
"pricingPlanID": {"premium"},
}
subGroupID, err := client.Groups.CreateSubGroup(ctx, parentGroupID, "Premium Account", attributes)
if err != nil {
log.Fatalf("Failed to create subgroup: %v", err)
}
fmt.Printf("Created subgroup with ID: %s\n", subGroupID)
}
// ExampleGroupsClient_Update demonstrates updating a group.
func ExampleGroupsClient_Update() {
ctx := context.Background()
client, _ := keycloak.New(ctx, keycloak.Config{
URL: os.Getenv("KEYCLOAK_URL"),
Realm: os.Getenv("KEYCLOAK_REALM"),
ClientID: os.Getenv("KEYCLOAK_CLIENT_ID"),
ClientSecret: os.Getenv("KEYCLOAK_CLIENT_SECRET"),
})
groupID := "group-id"
// Get the group
group, err := client.Groups.Get(ctx, groupID)
if err != nil {
log.Fatalf("Failed to get group: %v", err)
}
// Update description and attributes
group.Description = ptr.String("Updated description for the group")
if group.Attributes == nil {
attrs := make(map[string][]string)
group.Attributes = &attrs
}
(*group.Attributes)["updated"] = []string{"true"}
(*group.Attributes)["lastModified"] = []string{"2025-01-01"}
// Update the group
err = client.Groups.Update(ctx, *group)
if err != nil {
log.Fatalf("Failed to update group: %v", err)
}
fmt.Println("Group updated successfully")
}
// ExampleGroupsClient_Delete demonstrates deleting a group.
func ExampleGroupsClient_Delete() {
ctx := context.Background()
client, _ := keycloak.New(ctx, keycloak.Config{
URL: os.Getenv("KEYCLOAK_URL"),
Realm: os.Getenv("KEYCLOAK_REALM"),
ClientID: os.Getenv("KEYCLOAK_CLIENT_ID"),
ClientSecret: os.Getenv("KEYCLOAK_CLIENT_SECRET"),
})
groupID := "group-to-delete"
err := client.Groups.Delete(ctx, groupID)
if err != nil {
log.Fatalf("Failed to delete group: %v", err)
}
fmt.Println("Group deleted successfully")
}
// ExampleGroupsClient_ListSubGroupsPaginated demonstrates listing subgroups with pagination and search.
func ExampleGroupsClient_ListSubGroupsPaginated() {
ctx := context.Background()
client, _ := keycloak.New(ctx, keycloak.Config{
URL: os.Getenv("KEYCLOAK_URL"),
Realm: os.Getenv("KEYCLOAK_REALM"),
ClientID: os.Getenv("KEYCLOAK_CLIENT_ID"),
ClientSecret: os.Getenv("KEYCLOAK_CLIENT_SECRET"),
})
parentGroupID := "parent-group-id"
// Example 1: Basic pagination
params := keycloak.SubGroupSearchParams{
First: ptr.Int(0),
Max: ptr.Int(10),
}
subGroups, err := client.Groups.ListSubGroupsPaginated(ctx, parentGroupID, params)
if err != nil {
log.Fatalf("Failed to list subgroups: %v", err)
}
for _, subGroup := range subGroups {
fmt.Printf("Subgroup: %s (ID: %s)\n", *subGroup.Name, *subGroup.ID)
}
// Example 2: Search with exact match
searchTerm := "Premium Account"
exactMatch := true
searchParams := keycloak.SubGroupSearchParams{
Search: &searchTerm,
Exact: &exactMatch,
BriefRepresentation: ptr.Bool(false),
SubGroupsCount: ptr.Bool(true),
}
results, err := client.Groups.ListSubGroupsPaginated(ctx, parentGroupID, searchParams)
if err != nil {
log.Fatalf("Failed to search subgroups: %v", err)
}
fmt.Printf("Found %d subgroups matching search\n", len(results))
// Example 3: Brief representation with pagination
briefParams := keycloak.SubGroupSearchParams{
BriefRepresentation: ptr.Bool(true),
First: ptr.Int(0),
Max: ptr.Int(20),
}
briefResults, err := client.Groups.ListSubGroupsPaginated(ctx, parentGroupID, briefParams)
if err != nil {
log.Fatalf("Failed to list subgroups: %v", err)
}
fmt.Printf("Retrieved %d subgroups with brief representation\n", len(briefResults))
}
// ExampleGroupsClient_ListMembers demonstrates listing members (users) of a group.
func ExampleGroupsClient_ListMembers() {
ctx := context.Background()
client, _ := keycloak.New(ctx, keycloak.Config{
URL: os.Getenv("KEYCLOAK_URL"),
Realm: os.Getenv("KEYCLOAK_REALM"),
ClientID: os.Getenv("KEYCLOAK_CLIENT_ID"),
ClientSecret: os.Getenv("KEYCLOAK_CLIENT_SECRET"),
})
groupID := "group-id"
// Example 1: Get all members with full details
params := keycloak.GroupMembersParams{
BriefRepresentation: ptr.Bool(false),
First: ptr.Int(0),
Max: ptr.Int(100),
}
members, err := client.Groups.ListMembers(ctx, groupID, params)
if err != nil {
log.Fatalf("Failed to list group members: %v", err)
}
for _, user := range members {
fmt.Printf("User: %s (ID: %s)\n", ptr.ToString(user.Username), ptr.ToString(user.ID))
if user.Email != nil {
fmt.Printf(" Email: %s (Verified: %v)\n", *user.Email, user.EmailVerified != nil && *user.EmailVerified)
}
if user.FirstName != nil || user.LastName != nil {
fmt.Printf(" Name: %s %s\n", ptr.ToString(user.FirstName), ptr.ToString(user.LastName))
}
if user.Enabled != nil {
fmt.Printf(" Enabled: %v\n", *user.Enabled)
}
if user.Origin != nil {
fmt.Printf(" Origin: %s\n", *user.Origin)
}
if user.FederatedIdentities != nil && len(*user.FederatedIdentities) > 0 {
fmt.Printf(" Federated Identities: %d\n", len(*user.FederatedIdentities))
}
}
// Example 2: Get members with brief representation (faster)
briefParams := keycloak.GroupMembersParams{
BriefRepresentation: ptr.Bool(true),
Max: ptr.Int(50),
}
briefMembers, err := client.Groups.ListMembers(ctx, groupID, briefParams)
if err != nil {
log.Fatalf("Failed to list group members: %v", err)
}
fmt.Printf("Found %d members in group\n", len(briefMembers))
}
// ExampleGroupsClient_GetManagementPermissions demonstrates getting management permissions for a group.
func ExampleGroupsClient_GetManagementPermissions() {
ctx := context.Background()
client, _ := keycloak.New(ctx, keycloak.Config{
URL: os.Getenv("KEYCLOAK_URL"),
Realm: os.Getenv("KEYCLOAK_REALM"),
ClientID: os.Getenv("KEYCLOAK_CLIENT_ID"),
ClientSecret: os.Getenv("KEYCLOAK_CLIENT_SECRET"),
})
groupID := "group-id"
permissions, err := client.Groups.GetManagementPermissions(ctx, groupID)
if err != nil {
log.Fatalf("Failed to get management permissions: %v", err)
}
if permissions.Enabled != nil && *permissions.Enabled {
fmt.Println("Management permissions are enabled")
if permissions.Resource != nil {
fmt.Printf("Resource: %s\n", *permissions.Resource)
}
} else {
fmt.Println("Management permissions are disabled")
}
}
// ExampleGroupsClient_UpdateManagementPermissions demonstrates enabling management permissions for a group.
func ExampleGroupsClient_UpdateManagementPermissions() {
ctx := context.Background()
client, _ := keycloak.New(ctx, keycloak.Config{
URL: os.Getenv("KEYCLOAK_URL"),
Realm: os.Getenv("KEYCLOAK_REALM"),
ClientID: os.Getenv("KEYCLOAK_CLIENT_ID"),
ClientSecret: os.Getenv("KEYCLOAK_CLIENT_SECRET"),
})
groupID := "group-id"
// Enable management permissions
ref := keycloak.ManagementPermissionReference{
Enabled: ptr.Bool(true),
}
result, err := client.Groups.UpdateManagementPermissions(ctx, groupID, ref)
if err != nil {
log.Fatalf("Failed to update management permissions: %v", err)
}
if result.Enabled != nil && *result.Enabled {
fmt.Println("Management permissions enabled successfully")
}
// Disable management permissions
disableRef := keycloak.ManagementPermissionReference{
Enabled: ptr.Bool(false),
}
result, err = client.Groups.UpdateManagementPermissions(ctx, groupID, disableRef)
if err != nil {
log.Fatalf("Failed to update management permissions: %v", err)
}
fmt.Println("Management permissions disabled successfully")
}