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

Class UserManagementServiceGrpc.UserManagementServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<UserManagementServiceGrpc.UserManagementServiceFutureStub>

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

Enclosing class:

UserManagementServiceGrpc

public static final class UserManagementServiceGrpc.UserManagementServiceFutureStub
extends io.grpc.stub.AbstractFutureStub<UserManagementServiceGrpc.UserManagementServiceFutureStub>

 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.UserManagementServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<UserManagementServiceOuterClass.CreateUserResponse>	createUser(UserManagementServiceOuterClass.CreateUserRequest request)	Create a new user.
com.google.common.util.concurrent.ListenableFuture<UserManagementServiceOuterClass.DeleteUserResponse>	deleteUser(UserManagementServiceOuterClass.DeleteUserRequest request)	Delete an existing user and all its rights.
com.google.common.util.concurrent.ListenableFuture<UserManagementServiceOuterClass.GetUserResponse>	getUser(UserManagementServiceOuterClass.GetUserRequest request)	Get the user data of a specific user or the authenticated user.
com.google.common.util.concurrent.ListenableFuture<UserManagementServiceOuterClass.GrantUserRightsResponse>	grantUserRights(UserManagementServiceOuterClass.GrantUserRightsRequest request)	Grant rights to a user.
com.google.common.util.concurrent.ListenableFuture<UserManagementServiceOuterClass.ListUserRightsResponse>	listUserRights(UserManagementServiceOuterClass.ListUserRightsRequest request)	List the set of all rights granted to a user.
com.google.common.util.concurrent.ListenableFuture<UserManagementServiceOuterClass.ListUsersResponse>	listUsers(UserManagementServiceOuterClass.ListUsersRequest request)	List all existing users.
com.google.common.util.concurrent.ListenableFuture<UserManagementServiceOuterClass.RevokeUserRightsResponse>	revokeUserRights(UserManagementServiceOuterClass.RevokeUserRightsRequest request)	Revoke rights from a user.

Methods inherited from class io.grpc.stub.AbstractFutureStub

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.UserManagementServiceFutureStub build(io.grpc.Channel channel,
                                                                          io.grpc.CallOptions callOptions)

Specified by:

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

createUser

public com.google.common.util.concurrent.ListenableFuture<UserManagementServiceOuterClass.CreateUserResponse> createUser(UserManagementServiceOuterClass.CreateUserRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<UserManagementServiceOuterClass.GetUserResponse> getUser(UserManagementServiceOuterClass.GetUserRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<UserManagementServiceOuterClass.DeleteUserResponse> deleteUser(UserManagementServiceOuterClass.DeleteUserRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<UserManagementServiceOuterClass.ListUsersResponse> listUsers(UserManagementServiceOuterClass.ListUsersRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<UserManagementServiceOuterClass.GrantUserRightsResponse> grantUserRights(UserManagementServiceOuterClass.GrantUserRightsRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<UserManagementServiceOuterClass.RevokeUserRightsResponse> revokeUserRights(UserManagementServiceOuterClass.RevokeUserRightsRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<UserManagementServiceOuterClass.ListUserRightsResponse> listUserRights(UserManagementServiceOuterClass.ListUserRightsRequest request)

 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