keycloak

type Auth struct {
	Realm    string `json:"realm" yaml:"realm"`
	Username string `json:"username" yaml:"username"`
	Password string `json:"password" yaml:"password"`

	// ClientID/ClientSecret authenticate as a confidential client's service
	// account (client_credentials grant) instead of Username/Password.
	ClientID     string `json:"clientId" yaml:"clientId"`
	ClientSecret string `json:"clientSecret" yaml:"clientSecret"`
}

type Client interface {
	RestyClient() *resty.Client
	Login(context.Context, string, string, string, string, string) (*gocloak.JWT, error)
	LoginAdmin(context.Context, string, string, string) (*gocloak.JWT, error)
	LoginClient(ctx context.Context, clientID, clientSecret, realm string, scopes ...string) (*gocloak.JWT, error)
	GetUsers(context.Context, string, string, gocloak.GetUsersParams) ([]*gocloak.User, error)
	GetClients(context.Context, string, string, gocloak.GetClientsParams) ([]*gocloak.Client, error)
	CreateClient(context.Context, string, string, gocloak.Client) (string, error)
	CreateClientProtocolMapper(context.Context, string, string, string, gocloak.ProtocolMapperRepresentation) (string, error)
	GetClientSecret(ctx context.Context, token, realm, idOfClient string) (*gocloak.CredentialRepresentation, error)
	CreateUser(context.Context, string, string, gocloak.User) (string, error)
	SetPassword(context.Context, string, string, string, string, bool) error
	UpdateUser(context.Context, string, string, gocloak.User) error
	DeleteUser(context.Context, string, string, string) error
	GetClientRole(ctx context.Context, token string, realm string, idOfClient string, roleName string) (*gocloak.Role, error)
	AddClientRolesToUser(ctx context.Context, token string, realm string, idOfClient string, userID string, roles []gocloak.Role) error
	DeleteClientRolesFromUser(ctx context.Context, token string, realm string, idOfClient string, userID string, roles []gocloak.Role) error
	ExecuteActionsEmail(ctx context.Context, token, realm string, params gocloak.ExecuteActionsEmail) error

	/* Client mirrors methods gocloak.GoCloak already implements -- there's no
	 * implementation here because gocloak's real client satisfies this interface
	 * directly (assigned in SetKeycloakClient). This exists purely so mockery can
	 * generate a mock for tests.
	 */
	GetGroups(ctx context.Context, token string, realm string, params gocloak.GetGroupsParams) ([]*gocloak.Group, error)
	GetGroup(ctx context.Context, token string, realm string, groupID string) (*gocloak.Group, error)
	GetGroupByPath(ctx context.Context, token string, realm string, groupPath string) (*gocloak.Group, error)
	CreateGroup(ctx context.Context, token string, realm string, group gocloak.Group) (string, error)
	CreateChildGroup(ctx context.Context, token string, realm string, groupID string, group gocloak.Group) (string, error)
	DeleteGroup(ctx context.Context, token string, realm string, groupID string) error
	GetUserGroups(ctx context.Context, token string, realm string, userID string, params gocloak.GetGroupsParams) ([]*gocloak.Group, error)
	GetGroupMembers(ctx context.Context, token string, realm string, groupID string, params gocloak.GetGroupsParams) ([]*gocloak.User, error)
	AddUserToGroup(ctx context.Context, token string, realm string, userID string, groupID string) error
	DeleteUserFromGroup(ctx context.Context, token string, realm string, userID string, groupID string) error
	GetClientRolesByUserID(ctx context.Context, token string, realm string, idOfClient string, userID string) ([]*gocloak.Role, error)
	GetUsersByClientRoleName(ctx context.Context, token string, realm string, idOfClient string, roleName string, params gocloak.GetUsersByRoleParams) ([]*gocloak.User, error)
	GetRealmRole(ctx context.Context, token string, realm string, roleName string) (*gocloak.Role, error)
	AddRealmRoleToUser(ctx context.Context, token string, realm string, userID string, roles []gocloak.Role) error
	LogoutUserSession(context.Context, string, string, string) error
	GetComponent(ctx context.Context, token string, realm string, componentID string) (*gocloak.Component, error)
}

type ClientCredentials struct {
	ID     string
	Secret string
}

type Helper struct {
	Client
	Token string

	Options
}

type HelperWithoutCredentials struct {
	Client
	Options
}

type Host struct {
	Scheme                string `json:"scheme" yaml:"scheme"`
	Ip                    string `json:"ip" yaml:"ip"`
	Port                  int    `json:"port" yaml:"port"`
	Path                  string `json:"path" yaml:"path"`
	TlsInsecureSkipVerify bool   `json:"tlsInsecureSkipVerify" yaml:"tlsInsecureSkipVerify"`
}

type Option func(*Options)

type Options struct {
	Host `json:"host" yaml:"host"`
	Auth `json:"auth" yaml:"auth"`
}