Package com.daml.ledger.api.v1.admin

Class UserManagementServiceGrpc.UserManagementServiceStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractAsyncStub<UserManagementServiceGrpc.UserManagementServiceStub>

com.daml.ledger.api.v1.admin.UserManagementServiceGrpc.UserManagementServiceStub

Enclosing class:

UserManagementServiceGrpc

public static final class UserManagementServiceGrpc.UserManagementServiceStub
extends io.grpc.stub.AbstractAsyncStub<UserManagementServiceGrpc.UserManagementServiceStub>

 Service to manage users and their rights for interacting with the Ledger API
 served by a participant node.
 The authorization rules for its RPCs are specified on the ``<RpcName>Request``
 messages as boolean expressions over these two facts:
 (1) ``HasRight(r)`` denoting whether the authenticated user has right ``r`` and
 (2) ``IsAuthenticatedUser(uid)`` denoting whether ``uid`` is the empty string or equal to the id of the authenticated user.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
protected UserManagementServiceGrpc.UserManagementServiceStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	createUser(UserManagementServiceOuterClass.CreateUserRequest request, io.grpc.stub.StreamObserver<UserManagementServiceOuterClass.CreateUserResponse> responseObserver)	Create a new user.
void	deleteUser(UserManagementServiceOuterClass.DeleteUserRequest request, io.grpc.stub.StreamObserver<UserManagementServiceOuterClass.DeleteUserResponse> responseObserver)	Delete an existing user and all its rights.
void	getUser(UserManagementServiceOuterClass.GetUserRequest request, io.grpc.stub.StreamObserver<UserManagementServiceOuterClass.GetUserResponse> responseObserver)	Get the user data of a specific user or the authenticated user.
void	grantUserRights(UserManagementServiceOuterClass.GrantUserRightsRequest request, io.grpc.stub.StreamObserver<UserManagementServiceOuterClass.GrantUserRightsResponse> responseObserver)	Grant rights to a user.
void	listUserRights(UserManagementServiceOuterClass.ListUserRightsRequest request, io.grpc.stub.StreamObserver<UserManagementServiceOuterClass.ListUserRightsResponse> responseObserver)	List the set of all rights granted to a user.
void	listUsers(UserManagementServiceOuterClass.ListUsersRequest request, io.grpc.stub.StreamObserver<UserManagementServiceOuterClass.ListUsersResponse> responseObserver)	List all existing users.
void	revokeUserRights(UserManagementServiceOuterClass.RevokeUserRightsRequest request, io.grpc.stub.StreamObserver<UserManagementServiceOuterClass.RevokeUserRightsResponse> responseObserver)	Revoke rights from a user.

Methods inherited from class io.grpc.stub.AbstractAsyncStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected UserManagementServiceGrpc.UserManagementServiceStub build(io.grpc.Channel channel,
                                                                    io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<UserManagementServiceGrpc.UserManagementServiceStub>

createUser

public void createUser(UserManagementServiceOuterClass.CreateUserRequest request,
                       io.grpc.stub.StreamObserver<UserManagementServiceOuterClass.CreateUserResponse> responseObserver)

 Create a new user.
 Errors:
 - ``ALREADY_EXISTS``: if the user already exists
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields
 

getUser

public void getUser(UserManagementServiceOuterClass.GetUserRequest request,
                    io.grpc.stub.StreamObserver<UserManagementServiceOuterClass.GetUserResponse> responseObserver)

 Get the user data of a specific user or the authenticated user.
 Errors:
 - ``NOT_FOUND``: if the user doesn't exist
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields
 

deleteUser

public void deleteUser(UserManagementServiceOuterClass.DeleteUserRequest request,
                       io.grpc.stub.StreamObserver<UserManagementServiceOuterClass.DeleteUserResponse> responseObserver)

 Delete an existing user and all its rights.
 Errors:
 - ``NOT_FOUND``: if the user doesn't exist
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields
 

listUsers

public void listUsers(UserManagementServiceOuterClass.ListUsersRequest request,
                      io.grpc.stub.StreamObserver<UserManagementServiceOuterClass.ListUsersResponse> responseObserver)

 List all existing users.
 Errors:
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields
 

grantUserRights

public void grantUserRights(UserManagementServiceOuterClass.GrantUserRightsRequest request,
                            io.grpc.stub.StreamObserver<UserManagementServiceOuterClass.GrantUserRightsResponse> responseObserver)

 Grant rights to a user.
 Errors:
 - ``NOT_FOUND``: if the user doesn't exist
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields
 

revokeUserRights

public void revokeUserRights(UserManagementServiceOuterClass.RevokeUserRightsRequest request,
                             io.grpc.stub.StreamObserver<UserManagementServiceOuterClass.RevokeUserRightsResponse> responseObserver)

 Revoke rights from a user.
 Errors:
 - ``NOT_FOUND``: if the user doesn't exist
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields
 

listUserRights

public void listUserRights(UserManagementServiceOuterClass.ListUserRightsRequest request,
                           io.grpc.stub.StreamObserver<UserManagementServiceOuterClass.ListUserRightsResponse> responseObserver)

 List the set of all rights granted to a user.
 Errors:
 - ``NOT_FOUND``: if the user doesn't exist
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields