Skip to main content

UserManagementServiceClient

canton_ledger::proto::admin::user_management_service_client

Struct UserManagementServiceClient 

Source 
pub struct UserManagementServiceClient<T> { /* private fields */ }
Expand description

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 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.
  3. IsAuthenticatedIdentityProviderAdmin(idp) denoting whether idp is equal to the identity_provider_id of the authenticated user and the user has an IdentityProviderAdmin right.

If user_id is set to the empty string (the default), then the data for the authenticated user will be retrieved. If identity_provider_id is set to an empty string, then it’s effectively set to the value of access token’s ‘iss’ field if that is provided. If identity_provider_id remains an empty string, the default identity provider will be assumed.

The fields of request messages (and sub-messages) are marked either as Optional or Required:

  1. Optional denoting the client may leave the field unset when sending a request.
  2. Required denoting the client must set the field to a non-default value when sending a request.

A user resource consists of:

  1. a set of properties represented by the User message,
  2. a set of user rights, where each right is represented by the Right message.

A user resource, once it has been created, can be modified. In order to update the properties represented by the User message use the UpdateUser RPC. The only fields that can be modified are those marked as Modifiable. In order to grant or revoke user rights use GrantRights' and RevokeRights`` RPCs.

Implementations§

Source§

impl UserManagementServiceClient<Channel>

Source

pub async fn connect<D>( dst: D, ) -> Result<UserManagementServiceClient<Channel>, Error>
where D: TryInto<Endpoint>, <D as TryInto<Endpoint>>::Error: Into<Box<dyn Error + Sync + Send>>,

Attempt to create a new client by connecting to a given endpoint.

Source§

impl<T> UserManagementServiceClient<T>
where T: GrpcService<Body>, <T as GrpcService<Body>>::Error: Into<Box<dyn Error + Sync + Send>>, <T as GrpcService<Body>>::ResponseBody: Body<Data = Bytes> + Send + 'static, <<T as GrpcService<Body>>::ResponseBody as Body>::Error: Into<Box<dyn Error + Sync + Send>> + Send,

Source

pub fn new(inner: T) -> UserManagementServiceClient<T>

Source

pub fn with_origin(inner: T, origin: Uri) -> UserManagementServiceClient<T>

Source

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> UserManagementServiceClient<InterceptedService<T, F>>
where F: Interceptor, <T as GrpcService<Body>>::ResponseBody: Default, T: Service<Request<Body>, Response = Response<<T as GrpcService<Body>>::ResponseBody>>, <T as Service<Request<Body>>>::Error: Into<Box<dyn Error + Sync + Send>> + Send + Sync,

Source

pub fn send_compressed( self, encoding: CompressionEncoding, ) -> UserManagementServiceClient<T>

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

Source

pub fn accept_compressed( self, encoding: CompressionEncoding, ) -> UserManagementServiceClient<T>

Enable decompressing responses.

Source

pub fn max_decoding_message_size( self, limit: usize, ) -> UserManagementServiceClient<T>

Limits the maximum size of a decoded message.

Default: 4MB

Source

pub fn max_encoding_message_size( self, limit: usize, ) -> UserManagementServiceClient<T>

Limits the maximum size of an encoded message.

Default: usize::MAX

Source

pub async fn create_user( &mut self, request: impl IntoRequest<CreateUserRequest>, ) -> Result<Response<CreateUserResponse>, Status>

Create a new user.

Source

pub async fn get_user( &mut self, request: impl IntoRequest<GetUserRequest>, ) -> Result<Response<GetUserResponse>, Status>

Get the user data of a specific user or the authenticated user.

Source

pub async fn update_user( &mut self, request: impl IntoRequest<UpdateUserRequest>, ) -> Result<Response<UpdateUserResponse>, Status>

Update selected modifiable attribute of a user resource described by the User message.

Source

pub async fn delete_user( &mut self, request: impl IntoRequest<DeleteUserRequest>, ) -> Result<Response<DeleteUserResponse>, Status>

Delete an existing user and all its rights.

Source

pub async fn list_users( &mut self, request: impl IntoRequest<ListUsersRequest>, ) -> Result<Response<ListUsersResponse>, Status>

List all existing users.

Source

pub async fn grant_user_rights( &mut self, request: impl IntoRequest<GrantUserRightsRequest>, ) -> Result<Response<GrantUserRightsResponse>, Status>

Grant rights to a user. Granting rights does not affect the resource version of the corresponding user.

Source

pub async fn revoke_user_rights( &mut self, request: impl IntoRequest<RevokeUserRightsRequest>, ) -> Result<Response<RevokeUserRightsResponse>, Status>

Revoke rights from a user. Revoking rights does not affect the resource version of the corresponding user.

Source

pub async fn list_user_rights( &mut self, request: impl IntoRequest<ListUserRightsRequest>, ) -> Result<Response<ListUserRightsResponse>, Status>

List the set of all rights granted to a user.

Source

pub async fn update_user_identity_provider_id( &mut self, request: impl IntoRequest<UpdateUserIdentityProviderIdRequest>, ) -> Result<Response<UpdateUserIdentityProviderIdResponse>, Status>

Update the assignment of a user from one IDP to another.

Trait Implementations§

Source§

impl<T> Clone for UserManagementServiceClient<T>
where T: Clone,

Source§

fn clone(&self) -> UserManagementServiceClient<T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T> Debug for UserManagementServiceClient<T>
where T: Debug,

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more