Documentation ¶
Overview ¶
Package usermanager_proto is a generated protocol buffer package.
It is generated from these files:
usermanager/v1/usermanager_proto/usermanager.proto
It has these top-level messages:
GetKeySetRequest CreateUserRequest UpdateUserRequest BatchCreateUserRequest BatchCreateUserResponse
Package usermanager_proto is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- func RegisterUserManagerHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterUserManagerHandlerClient(ctx context.Context, mux *runtime.ServeMux, client UserManagerClient) error
- func RegisterUserManagerHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterUserManagerServer(s *grpc.Server, srv UserManagerServer)
- type BatchCreateUserRequest
- func (*BatchCreateUserRequest) Descriptor() ([]byte, []int)
- func (m *BatchCreateUserRequest) GetAddSigningKeys() bool
- func (m *BatchCreateUserRequest) GetAppId() string
- func (m *BatchCreateUserRequest) GetDomainId() string
- func (m *BatchCreateUserRequest) GetUsers() []*google_keytransparency_type.User
- func (*BatchCreateUserRequest) ProtoMessage()
- func (m *BatchCreateUserRequest) Reset()
- func (m *BatchCreateUserRequest) String() string
- type BatchCreateUserResponse
- type CreateUserRequest
- func (*CreateUserRequest) Descriptor() ([]byte, []int)
- func (m *CreateUserRequest) GetAddSigningKeys() bool
- func (m *CreateUserRequest) GetUser() *google_keytransparency_type.User
- func (*CreateUserRequest) ProtoMessage()
- func (m *CreateUserRequest) Reset()
- func (m *CreateUserRequest) String() string
- type GetKeySetRequest
- type UpdateUserRequest
- func (*UpdateUserRequest) Descriptor() ([]byte, []int)
- func (m *UpdateUserRequest) GetUpdateMask() *google_protobuf1.FieldMask
- func (m *UpdateUserRequest) GetUser() *google_keytransparency_type.User
- func (*UpdateUserRequest) ProtoMessage()
- func (m *UpdateUserRequest) Reset()
- func (m *UpdateUserRequest) String() string
- type UserManagerClient
- type UserManagerServer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterUserManagerHandler ¶
func RegisterUserManagerHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterUserManagerHandler registers the http handlers for service UserManager to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterUserManagerHandlerClient ¶
func RegisterUserManagerHandlerClient(ctx context.Context, mux *runtime.ServeMux, client UserManagerClient) error
RegisterUserManagerHandler registers the http handlers for service UserManager to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "UserManagerClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "UserManagerClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "UserManagerClient" to call the correct interceptors.
func RegisterUserManagerHandlerFromEndpoint ¶
func RegisterUserManagerHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterUserManagerHandlerFromEndpoint is same as RegisterUserManagerHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterUserManagerServer ¶
func RegisterUserManagerServer(s *grpc.Server, srv UserManagerServer)
Types ¶
type BatchCreateUserRequest ¶
type BatchCreateUserRequest struct { // domain_id identifies the domain. DomainId string `protobuf:"bytes,1,opt,name=domain_id,json=domainId" json:"domain_id,omitempty"` // app_id identifies the application. AppId string `protobuf:"bytes,2,opt,name=app_id,json=appId" json:"app_id,omitempty"` // users is the set of users to create. Users []*google_keytransparency_type.User `protobuf:"bytes,3,rep,name=users" json:"users,omitempty"` // add_signing_keys specifies whether to add this service's signing_keys to the set of authorized_keys. // This must be set to true if any further operations from this API are meant to succeed. // If set to false, there must be at least one key in authorized_keys. AddSigningKeys bool `protobuf:"varint,4,opt,name=add_signing_keys,json=addSigningKeys" json:"add_signing_keys,omitempty"` }
BatchCreateUserRequest creates multiple users all at once.
func (*BatchCreateUserRequest) Descriptor ¶
func (*BatchCreateUserRequest) Descriptor() ([]byte, []int)
func (*BatchCreateUserRequest) GetAddSigningKeys ¶
func (m *BatchCreateUserRequest) GetAddSigningKeys() bool
func (*BatchCreateUserRequest) GetAppId ¶
func (m *BatchCreateUserRequest) GetAppId() string
func (*BatchCreateUserRequest) GetDomainId ¶
func (m *BatchCreateUserRequest) GetDomainId() string
func (*BatchCreateUserRequest) GetUsers ¶
func (m *BatchCreateUserRequest) GetUsers() []*google_keytransparency_type.User
func (*BatchCreateUserRequest) ProtoMessage ¶
func (*BatchCreateUserRequest) ProtoMessage()
func (*BatchCreateUserRequest) Reset ¶
func (m *BatchCreateUserRequest) Reset()
func (*BatchCreateUserRequest) String ¶
func (m *BatchCreateUserRequest) String() string
type BatchCreateUserResponse ¶
type BatchCreateUserResponse struct { // users returns the list of created users. Users []*google_keytransparency_type.User `protobuf:"bytes,2,rep,name=users" json:"users,omitempty"` }
BatchCreateUserResponse creates multiple users at once.
func (*BatchCreateUserResponse) Descriptor ¶
func (*BatchCreateUserResponse) Descriptor() ([]byte, []int)
func (*BatchCreateUserResponse) GetUsers ¶
func (m *BatchCreateUserResponse) GetUsers() []*google_keytransparency_type.User
func (*BatchCreateUserResponse) ProtoMessage ¶
func (*BatchCreateUserResponse) ProtoMessage()
func (*BatchCreateUserResponse) Reset ¶
func (m *BatchCreateUserResponse) Reset()
func (*BatchCreateUserResponse) String ¶
func (m *BatchCreateUserResponse) String() string
type CreateUserRequest ¶
type CreateUserRequest struct { // user is the user to create. User *google_keytransparency_type.User `protobuf:"bytes,2,opt,name=user" json:"user,omitempty"` // add_signing_keys specifies whether to add this service's signing keys to the set of authorized_keys. // This must be set to true if any further operations from this API are meant to succeed. // If set to false, there must be at least one key in authorized_keys. AddSigningKeys bool `protobuf:"varint,7,opt,name=add_signing_keys,json=addSigningKeys" json:"add_signing_keys,omitempty"` }
CreateUserRequest specifies the information with which a new user should be initialized. New users will be signed with the current active key. It is the responsibility of authorized callers to verify that domain_id/app_id/user_id is correct.
func (*CreateUserRequest) Descriptor ¶
func (*CreateUserRequest) Descriptor() ([]byte, []int)
func (*CreateUserRequest) GetAddSigningKeys ¶
func (m *CreateUserRequest) GetAddSigningKeys() bool
func (*CreateUserRequest) GetUser ¶
func (m *CreateUserRequest) GetUser() *google_keytransparency_type.User
func (*CreateUserRequest) ProtoMessage ¶
func (*CreateUserRequest) ProtoMessage()
func (*CreateUserRequest) Reset ¶
func (m *CreateUserRequest) Reset()
func (*CreateUserRequest) String ¶
func (m *CreateUserRequest) String() string
type GetKeySetRequest ¶
type GetKeySetRequest struct { // domain_id identifies the domain. DomainId string `protobuf:"bytes,1,opt,name=domain_id,json=domainId" json:"domain_id,omitempty"` // app_id identifies the application. AppId string `protobuf:"bytes,2,opt,name=app_id,json=appId" json:"app_id,omitempty"` }
GetKeySetsRequest requests the keyset of a domain_id/app_id
func (*GetKeySetRequest) Descriptor ¶
func (*GetKeySetRequest) Descriptor() ([]byte, []int)
func (*GetKeySetRequest) GetAppId ¶
func (m *GetKeySetRequest) GetAppId() string
func (*GetKeySetRequest) GetDomainId ¶
func (m *GetKeySetRequest) GetDomainId() string
func (*GetKeySetRequest) ProtoMessage ¶
func (*GetKeySetRequest) ProtoMessage()
func (*GetKeySetRequest) Reset ¶
func (m *GetKeySetRequest) Reset()
func (*GetKeySetRequest) String ¶
func (m *GetKeySetRequest) String() string
type UpdateUserRequest ¶
type UpdateUserRequest struct { // user contains data which will be applied to the user. User *google_keytransparency_type.User `protobuf:"bytes,2,opt,name=user" json:"user,omitempty"` // update_mask specifies which fields of user to update. // For example: "data" or "authorized_keys" UpdateMask *google_protobuf1.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask" json:"update_mask,omitempty"` }
UpdateUserRequest sets the data field for the user. The user must have the service's current signing key in its list of authorized_keys in order to succeed.
func (*UpdateUserRequest) Descriptor ¶
func (*UpdateUserRequest) Descriptor() ([]byte, []int)
func (*UpdateUserRequest) GetUpdateMask ¶
func (m *UpdateUserRequest) GetUpdateMask() *google_protobuf1.FieldMask
func (*UpdateUserRequest) GetUser ¶
func (m *UpdateUserRequest) GetUser() *google_keytransparency_type.User
func (*UpdateUserRequest) ProtoMessage ¶
func (*UpdateUserRequest) ProtoMessage()
func (*UpdateUserRequest) Reset ¶
func (m *UpdateUserRequest) Reset()
func (*UpdateUserRequest) String ¶
func (m *UpdateUserRequest) String() string
type UserManagerClient ¶
type UserManagerClient interface { // GetKeySet returns a list of public keys (a keyset) that corresponds to the signing keys // this service has for a given domain and app. GetKeySet(ctx context.Context, in *GetKeySetRequest, opts ...grpc.CallOption) (*google_keytransparency_type1.KeySet, error) // CreateUser creates a new user and initializes it. // If the user already exists, this operation will fail. CreateUser(ctx context.Context, in *CreateUserRequest, opts ...grpc.CallOption) (*google_keytransparency_type.User, error) // UpdateUserData sets the public key for an user. UpdateUser(ctx context.Context, in *UpdateUserRequest, opts ...grpc.CallOption) (*google_keytransparency_type.User, error) // BatchCreateUser creates a set of new users. BatchCreateUser(ctx context.Context, in *BatchCreateUserRequest, opts ...grpc.CallOption) (*google_keytransparency_type.User, error) }
func NewUserManagerClient ¶
func NewUserManagerClient(cc *grpc.ClientConn) UserManagerClient
type UserManagerServer ¶
type UserManagerServer interface { // GetKeySet returns a list of public keys (a keyset) that corresponds to the signing keys // this service has for a given domain and app. GetKeySet(context.Context, *GetKeySetRequest) (*google_keytransparency_type1.KeySet, error) // CreateUser creates a new user and initializes it. // If the user already exists, this operation will fail. CreateUser(context.Context, *CreateUserRequest) (*google_keytransparency_type.User, error) // UpdateUserData sets the public key for an user. UpdateUser(context.Context, *UpdateUserRequest) (*google_keytransparency_type.User, error) // BatchCreateUser creates a set of new users. BatchCreateUser(context.Context, *BatchCreateUserRequest) (*google_keytransparency_type.User, error) }