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

Class UserManagementServiceGrpc.UserManagementServiceImplBase

  • All Implemented Interfaces:
    io.grpc.BindableService
    Enclosing class:
    UserManagementServiceGrpc
    public abstract static class UserManagementServiceGrpc.UserManagementServiceImplBase
extends java.lang.Object
implements io.grpc.BindableService
     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.

    • Constructor Detail

      • UserManagementServiceImplBase

        public UserManagementServiceImplBase()

    • Method Detail

      • 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

      • 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

      • bindService

        public final io.grpc.ServerServiceDefinition bindService()
        Specified by:
        bindService in interface io.grpc.BindableService