keycloak

Documentation

Overview

Package keycloak implements a keycloak client for Lagoon.

Index

• type Client
  • func NewClientCredentialsClient(ctx context.Context, baseURL, clientID, clientSecret string) (*Client, error)
  • func (c *Client) Groups(ctx context.Context) ([]Group, error)
  • func (c *Client) RawGroups(ctx context.Context) ([]byte, error)
• type Group
• type GroupUpdateRepresentation

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a Keycloak admin client.

func NewClientCredentialsClient

func NewClientCredentialsClient(ctx context.Context, baseURL, clientID,
	clientSecret string) (*Client, error)

NewClientCredentialsClient creates a new keycloak client.

func (*Client) Groups

func (c *Client) Groups(ctx context.Context) ([]Group, error)

Groups returns all Keycloak Groups including their attributes.

func (*Client) RawGroups

func (c *Client) RawGroups(ctx context.Context) ([]byte, error)

RawGroups returns the raw JSON group representation from the Keycloak API.

type Group

type Group struct {
	ID string `json:"id"`
	GroupUpdateRepresentation
}

Group represents a Keycloak Group. It holds the fields required when getting a list of groups from keycloak.

type GroupUpdateRepresentation

type GroupUpdateRepresentation struct {
	Name       string              `json:"name"`
	Attributes map[string][]string `json:"attributes"`
}

GroupUpdateRepresentation holds the fields required when updating a group.