This directory contains standalone examples demonstrating how to use the go.companyinfo.dev/keycloak library.

Before running these examples, you need:

1. A running Keycloak instance
2. Valid credentials (client ID, client secret, username, password)
3. Appropriate permissions to perform the operations

All examples use environment variables for configuration:

export KEYCLOAK_URL="https://your-keycloak-instance.com"
export KEYCLOAK_REALM="your-realm"
export KEYCLOAK_CLIENT_ID="your-client-id"
export KEYCLOAK_CLIENT_SECRET="your-client-secret"
export KEYCLOAK_USERNAME="your-username"
export KEYCLOAK_PASSWORD="your-password"

Demonstrates basic client initialization and connection to Keycloak.

cd examples/basic
go run main.go

Shows how to list groups, get group details, and work with subgroups.

cd examples/groups
go run main.go

Demonstrates advanced features including:

• Custom timeouts
• Searching for groups with filters
• Creating new groups (set CREATE_GROUP=true)
• Working with group attributes
• Recursive subgroup handling

cd examples/advanced
go run main.go

# To enable group creation:
CREATE_GROUP=true go run main.go

These examples use the parent module, so they work out of the box:

cd examples/basic
go run main.go

If you want to test against a local version of the library during development, the examples automatically use the parent module via the go.mod replace directive.

All examples include proper error handling and logging. If you encounter errors:

1. Verify your Keycloak instance is accessible
2. Check your credentials are correct
3. Ensure your user/client has appropriate permissions
4. Review the error messages for specific issues

When adding new examples:

1. Create a new directory under examples/
2. Include a descriptive main.go file
3. Use environment variables for configuration
4. Add proper error handling and logging
5. Include comments explaining the example's purpose
6. Update this README with the new example