Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v1

v1.0.0

Jan 28, 2026

v0

v0.246.0

Jan 30, 2026

Changes in this version

+ const Dex_CreateClient_FullMethodName

+ const Dex_CreatePassword_FullMethodName

+ const Dex_DeleteClient_FullMethodName

+ const Dex_DeletePassword_FullMethodName

+ const Dex_GetVersion_FullMethodName

+ const Dex_ListPasswords_FullMethodName

+ const Dex_ListRefresh_FullMethodName

+ const Dex_RevokeRefresh_FullMethodName

+ const Dex_UpdateClient_FullMethodName

+ const Dex_UpdatePassword_FullMethodName

+ const Dex_VerifyPassword_FullMethodName

+ var Dex_ServiceDesc = grpc.ServiceDesc

+ var File_api_api_proto protoreflect.FileDescriptor

+ func RegisterDexServer(s grpc.ServiceRegistrar, srv DexServer)

+ type Client struct

+ Id string

+ LogoUrl string

+ Name string

+ Public bool

+ RedirectUris []string

+ Secret string

+ TrustedPeers []string

+ func (*Client) Descriptor() ([]byte, []int)

+ func (*Client) ProtoMessage()

+ func (x *Client) GetId() string

+ func (x *Client) GetLogoUrl() string

+ func (x *Client) GetName() string

+ func (x *Client) GetPublic() bool

+ func (x *Client) GetRedirectUris() []string

+ func (x *Client) GetSecret() string

+ func (x *Client) GetTrustedPeers() []string

+ func (x *Client) ProtoReflect() protoreflect.Message

+ func (x *Client) Reset()

+ func (x *Client) String() string

+ type CreateClientReq struct

+ Client *Client

+ func (*CreateClientReq) Descriptor() ([]byte, []int)

+ func (*CreateClientReq) ProtoMessage()

+ func (x *CreateClientReq) GetClient() *Client

+ func (x *CreateClientReq) ProtoReflect() protoreflect.Message

+ func (x *CreateClientReq) Reset()

+ func (x *CreateClientReq) String() string

+ type CreateClientResp struct

+ AlreadyExists bool

+ Client *Client

+ func (*CreateClientResp) Descriptor() ([]byte, []int)

+ func (*CreateClientResp) ProtoMessage()

+ func (x *CreateClientResp) GetAlreadyExists() bool

+ func (x *CreateClientResp) GetClient() *Client

+ func (x *CreateClientResp) ProtoReflect() protoreflect.Message

+ func (x *CreateClientResp) Reset()

+ func (x *CreateClientResp) String() string

+ type CreatePasswordReq struct

+ Password *Password

+ func (*CreatePasswordReq) Descriptor() ([]byte, []int)

+ func (*CreatePasswordReq) ProtoMessage()

+ func (x *CreatePasswordReq) GetPassword() *Password

+ func (x *CreatePasswordReq) ProtoReflect() protoreflect.Message

+ func (x *CreatePasswordReq) Reset()

+ func (x *CreatePasswordReq) String() string

+ type CreatePasswordResp struct

+ AlreadyExists bool

+ func (*CreatePasswordResp) Descriptor() ([]byte, []int)

+ func (*CreatePasswordResp) ProtoMessage()

+ func (x *CreatePasswordResp) GetAlreadyExists() bool

+ func (x *CreatePasswordResp) ProtoReflect() protoreflect.Message

+ func (x *CreatePasswordResp) Reset()

+ func (x *CreatePasswordResp) String() string

+ type DeleteClientReq struct

+ Id string

+ func (*DeleteClientReq) Descriptor() ([]byte, []int)

+ func (*DeleteClientReq) ProtoMessage()

+ func (x *DeleteClientReq) GetId() string

+ func (x *DeleteClientReq) ProtoReflect() protoreflect.Message

+ func (x *DeleteClientReq) Reset()

+ func (x *DeleteClientReq) String() string

+ type DeleteClientResp struct

+ NotFound bool

+ func (*DeleteClientResp) Descriptor() ([]byte, []int)

+ func (*DeleteClientResp) ProtoMessage()

+ func (x *DeleteClientResp) GetNotFound() bool

+ func (x *DeleteClientResp) ProtoReflect() protoreflect.Message

+ func (x *DeleteClientResp) Reset()

+ func (x *DeleteClientResp) String() string

+ type DeletePasswordReq struct

+ Email string

+ func (*DeletePasswordReq) Descriptor() ([]byte, []int)

+ func (*DeletePasswordReq) ProtoMessage()

+ func (x *DeletePasswordReq) GetEmail() string

+ func (x *DeletePasswordReq) ProtoReflect() protoreflect.Message

+ func (x *DeletePasswordReq) Reset()

+ func (x *DeletePasswordReq) String() string

+ type DeletePasswordResp struct

+ NotFound bool

+ func (*DeletePasswordResp) Descriptor() ([]byte, []int)

+ func (*DeletePasswordResp) ProtoMessage()

+ func (x *DeletePasswordResp) GetNotFound() bool

+ func (x *DeletePasswordResp) ProtoReflect() protoreflect.Message

+ func (x *DeletePasswordResp) Reset()

+ func (x *DeletePasswordResp) String() string

+ type DexClient interface

+ CreateClient func(ctx context.Context, in *CreateClientReq, opts ...grpc.CallOption) (*CreateClientResp, error)

+ CreatePassword func(ctx context.Context, in *CreatePasswordReq, opts ...grpc.CallOption) (*CreatePasswordResp, error)

+ DeleteClient func(ctx context.Context, in *DeleteClientReq, opts ...grpc.CallOption) (*DeleteClientResp, error)

+ DeletePassword func(ctx context.Context, in *DeletePasswordReq, opts ...grpc.CallOption) (*DeletePasswordResp, error)

+ GetVersion func(ctx context.Context, in *VersionReq, opts ...grpc.CallOption) (*VersionResp, error)

+ ListPasswords func(ctx context.Context, in *ListPasswordReq, opts ...grpc.CallOption) (*ListPasswordResp, error)

+ ListRefresh func(ctx context.Context, in *ListRefreshReq, opts ...grpc.CallOption) (*ListRefreshResp, error)

+ RevokeRefresh func(ctx context.Context, in *RevokeRefreshReq, opts ...grpc.CallOption) (*RevokeRefreshResp, error)

+ UpdateClient func(ctx context.Context, in *UpdateClientReq, opts ...grpc.CallOption) (*UpdateClientResp, error)

+ UpdatePassword func(ctx context.Context, in *UpdatePasswordReq, opts ...grpc.CallOption) (*UpdatePasswordResp, error)

+ VerifyPassword func(ctx context.Context, in *VerifyPasswordReq, opts ...grpc.CallOption) (*VerifyPasswordResp, error)

+ func NewDexClient(cc grpc.ClientConnInterface) DexClient

+ type DexServer interface

+ CreateClient func(context.Context, *CreateClientReq) (*CreateClientResp, error)

+ CreatePassword func(context.Context, *CreatePasswordReq) (*CreatePasswordResp, error)

+ DeleteClient func(context.Context, *DeleteClientReq) (*DeleteClientResp, error)

+ DeletePassword func(context.Context, *DeletePasswordReq) (*DeletePasswordResp, error)

+ GetVersion func(context.Context, *VersionReq) (*VersionResp, error)

+ ListPasswords func(context.Context, *ListPasswordReq) (*ListPasswordResp, error)

+ ListRefresh func(context.Context, *ListRefreshReq) (*ListRefreshResp, error)

+ RevokeRefresh func(context.Context, *RevokeRefreshReq) (*RevokeRefreshResp, error)

+ UpdateClient func(context.Context, *UpdateClientReq) (*UpdateClientResp, error)

+ UpdatePassword func(context.Context, *UpdatePasswordReq) (*UpdatePasswordResp, error)

+ VerifyPassword func(context.Context, *VerifyPasswordReq) (*VerifyPasswordResp, error)

+ type ListPasswordReq struct

+ func (*ListPasswordReq) Descriptor() ([]byte, []int)

+ func (*ListPasswordReq) ProtoMessage()

+ func (x *ListPasswordReq) ProtoReflect() protoreflect.Message

+ func (x *ListPasswordReq) Reset()

+ func (x *ListPasswordReq) String() string

+ type ListPasswordResp struct

+ Passwords []*Password

+ func (*ListPasswordResp) Descriptor() ([]byte, []int)

+ func (*ListPasswordResp) ProtoMessage()

+ func (x *ListPasswordResp) GetPasswords() []*Password

+ func (x *ListPasswordResp) ProtoReflect() protoreflect.Message

+ func (x *ListPasswordResp) Reset()

+ func (x *ListPasswordResp) String() string

+ type ListRefreshReq struct

+ UserId string

+ func (*ListRefreshReq) Descriptor() ([]byte, []int)

+ func (*ListRefreshReq) ProtoMessage()

+ func (x *ListRefreshReq) GetUserId() string

+ func (x *ListRefreshReq) ProtoReflect() protoreflect.Message

+ func (x *ListRefreshReq) Reset()

+ func (x *ListRefreshReq) String() string

+ type ListRefreshResp struct

+ RefreshTokens []*RefreshTokenRef

+ func (*ListRefreshResp) Descriptor() ([]byte, []int)

+ func (*ListRefreshResp) ProtoMessage()

+ func (x *ListRefreshResp) GetRefreshTokens() []*RefreshTokenRef

+ func (x *ListRefreshResp) ProtoReflect() protoreflect.Message

+ func (x *ListRefreshResp) Reset()

+ func (x *ListRefreshResp) String() string

+ type Password struct

+ Email string

+ Hash []byte

+ UserId string

+ Username string

+ func (*Password) Descriptor() ([]byte, []int)

+ func (*Password) ProtoMessage()

+ func (x *Password) GetEmail() string

+ func (x *Password) GetHash() []byte

+ func (x *Password) GetUserId() string

+ func (x *Password) GetUsername() string

+ func (x *Password) ProtoReflect() protoreflect.Message

+ func (x *Password) Reset()

+ func (x *Password) String() string

+ type RefreshTokenRef struct

+ ClientId string

+ CreatedAt int64

+ Id string

+ LastUsed int64

+ func (*RefreshTokenRef) Descriptor() ([]byte, []int)

+ func (*RefreshTokenRef) ProtoMessage()

+ func (x *RefreshTokenRef) GetClientId() string

+ func (x *RefreshTokenRef) GetCreatedAt() int64

+ func (x *RefreshTokenRef) GetId() string

+ func (x *RefreshTokenRef) GetLastUsed() int64

+ func (x *RefreshTokenRef) ProtoReflect() protoreflect.Message

+ func (x *RefreshTokenRef) Reset()

+ func (x *RefreshTokenRef) String() string

+ type RevokeRefreshReq struct

+ ClientId string

+ UserId string

+ func (*RevokeRefreshReq) Descriptor() ([]byte, []int)

+ func (*RevokeRefreshReq) ProtoMessage()

+ func (x *RevokeRefreshReq) GetClientId() string

+ func (x *RevokeRefreshReq) GetUserId() string

+ func (x *RevokeRefreshReq) ProtoReflect() protoreflect.Message

+ func (x *RevokeRefreshReq) Reset()

+ func (x *RevokeRefreshReq) String() string

+ type RevokeRefreshResp struct

+ NotFound bool

+ func (*RevokeRefreshResp) Descriptor() ([]byte, []int)

+ func (*RevokeRefreshResp) ProtoMessage()

+ func (x *RevokeRefreshResp) GetNotFound() bool

+ func (x *RevokeRefreshResp) ProtoReflect() protoreflect.Message

+ func (x *RevokeRefreshResp) Reset()

+ func (x *RevokeRefreshResp) String() string

+ type UnimplementedDexServer struct

+ func (UnimplementedDexServer) CreateClient(context.Context, *CreateClientReq) (*CreateClientResp, error)

+ func (UnimplementedDexServer) CreatePassword(context.Context, *CreatePasswordReq) (*CreatePasswordResp, error)

+ func (UnimplementedDexServer) DeleteClient(context.Context, *DeleteClientReq) (*DeleteClientResp, error)

+ func (UnimplementedDexServer) DeletePassword(context.Context, *DeletePasswordReq) (*DeletePasswordResp, error)

+ func (UnimplementedDexServer) GetVersion(context.Context, *VersionReq) (*VersionResp, error)

+ func (UnimplementedDexServer) ListPasswords(context.Context, *ListPasswordReq) (*ListPasswordResp, error)

+ func (UnimplementedDexServer) ListRefresh(context.Context, *ListRefreshReq) (*ListRefreshResp, error)

+ func (UnimplementedDexServer) RevokeRefresh(context.Context, *RevokeRefreshReq) (*RevokeRefreshResp, error)

+ func (UnimplementedDexServer) UpdateClient(context.Context, *UpdateClientReq) (*UpdateClientResp, error)

+ func (UnimplementedDexServer) UpdatePassword(context.Context, *UpdatePasswordReq) (*UpdatePasswordResp, error)

+ func (UnimplementedDexServer) VerifyPassword(context.Context, *VerifyPasswordReq) (*VerifyPasswordResp, error)

+ type UnsafeDexServer interface

+ type UpdateClientReq struct

+ Id string

+ LogoUrl string

+ Name string

+ RedirectUris []string

+ TrustedPeers []string

+ func (*UpdateClientReq) Descriptor() ([]byte, []int)

+ func (*UpdateClientReq) ProtoMessage()

+ func (x *UpdateClientReq) GetId() string

+ func (x *UpdateClientReq) GetLogoUrl() string

+ func (x *UpdateClientReq) GetName() string

+ func (x *UpdateClientReq) GetRedirectUris() []string

+ func (x *UpdateClientReq) GetTrustedPeers() []string

+ func (x *UpdateClientReq) ProtoReflect() protoreflect.Message

+ func (x *UpdateClientReq) Reset()

+ func (x *UpdateClientReq) String() string

+ type UpdateClientResp struct

+ NotFound bool

+ func (*UpdateClientResp) Descriptor() ([]byte, []int)

+ func (*UpdateClientResp) ProtoMessage()

+ func (x *UpdateClientResp) GetNotFound() bool

+ func (x *UpdateClientResp) ProtoReflect() protoreflect.Message

+ func (x *UpdateClientResp) Reset()

+ func (x *UpdateClientResp) String() string

+ type UpdatePasswordReq struct

+ Email string

+ NewHash []byte

+ NewUsername string

+ func (*UpdatePasswordReq) Descriptor() ([]byte, []int)

+ func (*UpdatePasswordReq) ProtoMessage()

+ func (x *UpdatePasswordReq) GetEmail() string

+ func (x *UpdatePasswordReq) GetNewHash() []byte

+ func (x *UpdatePasswordReq) GetNewUsername() string

+ func (x *UpdatePasswordReq) ProtoReflect() protoreflect.Message

+ func (x *UpdatePasswordReq) Reset()

+ func (x *UpdatePasswordReq) String() string

+ type UpdatePasswordResp struct

+ NotFound bool

+ func (*UpdatePasswordResp) Descriptor() ([]byte, []int)

+ func (*UpdatePasswordResp) ProtoMessage()

+ func (x *UpdatePasswordResp) GetNotFound() bool

+ func (x *UpdatePasswordResp) ProtoReflect() protoreflect.Message

+ func (x *UpdatePasswordResp) Reset()

+ func (x *UpdatePasswordResp) String() string

+ type VerifyPasswordReq struct

+ Email string

+ Password string

+ func (*VerifyPasswordReq) Descriptor() ([]byte, []int)

+ func (*VerifyPasswordReq) ProtoMessage()

+ func (x *VerifyPasswordReq) GetEmail() string

+ func (x *VerifyPasswordReq) GetPassword() string

+ func (x *VerifyPasswordReq) ProtoReflect() protoreflect.Message

+ func (x *VerifyPasswordReq) Reset()

+ func (x *VerifyPasswordReq) String() string

+ type VerifyPasswordResp struct

+ NotFound bool

+ Verified bool

+ func (*VerifyPasswordResp) Descriptor() ([]byte, []int)

+ func (*VerifyPasswordResp) ProtoMessage()

+ func (x *VerifyPasswordResp) GetNotFound() bool

+ func (x *VerifyPasswordResp) GetVerified() bool

+ func (x *VerifyPasswordResp) ProtoReflect() protoreflect.Message

+ func (x *VerifyPasswordResp) Reset()

+ func (x *VerifyPasswordResp) String() string

+ type VersionReq struct

+ func (*VersionReq) Descriptor() ([]byte, []int)

+ func (*VersionReq) ProtoMessage()

+ func (x *VersionReq) ProtoReflect() protoreflect.Message

+ func (x *VersionReq) Reset()

+ func (x *VersionReq) String() string

+ type VersionResp struct

+ Api int32

+ Server string

+ func (*VersionResp) Descriptor() ([]byte, []int)

+ func (*VersionResp) ProtoMessage()

+ func (x *VersionResp) GetApi() int32

+ func (x *VersionResp) GetServer() string

+ func (x *VersionResp) ProtoReflect() protoreflect.Message

+ func (x *VersionResp) Reset()

+ func (x *VersionResp) String() string

Other modules containing this package

github.com/11notes/fork-dex/api/v2