Skip to main content

IdentityProviderConfigServiceClient

Struct IdentityProviderConfigServiceClient 

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

Identity Provider Config Service makes it possible for participant node administrators to setup and manage additional identity providers at runtime.

This allows using access tokens from identity providers unknown at deployment time. When an identity provider is configured, independent IDP administrators can manage their own set of parties and users. Such parties and users have a matching identity_provider_id defined and are inaccessible to administrators from other identity providers. A user will only be authenticated if the corresponding JWT token is issued by the appropriate identity provider. Users and parties without identity_provider_id defined are assumed to be using the default identity provider, which is configured statically at the participant node’s deployment time.

The Ledger API uses the “iss” claim of a JWT token to match the token to a specific IDP. If there is no match, the default IDP is 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.

An identity provider config resource is described by the IdentityProviderConfig message, An identity provider config resource, once it has been created, can be modified. In order to update the properties represented by the IdentityProviderConfig message use the UpdateIdentityProviderConfig RPC. The only fields that can be modified are those marked as Modifiable.

Implementations§

Source§

impl IdentityProviderConfigServiceClient<Channel>

Source

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

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

Source§

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

Source

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

Source

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

Source

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> IdentityProviderConfigServiceClient<InterceptedService<T, F>>

Source

pub fn send_compressed( self, encoding: CompressionEncoding, ) -> IdentityProviderConfigServiceClient<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, ) -> IdentityProviderConfigServiceClient<T>

Enable decompressing responses.

Source

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

Limits the maximum size of a decoded message.

Default: 4MB

Source

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

Limits the maximum size of an encoded message.

Default: usize::MAX

Source

pub async fn create_identity_provider_config( &mut self, request: impl IntoRequest<CreateIdentityProviderConfigRequest>, ) -> Result<Response<CreateIdentityProviderConfigResponse>, Status>

Create a new identity provider configuration. The request will fail if the maximum allowed number of separate configurations is reached.

Source

pub async fn get_identity_provider_config( &mut self, request: impl IntoRequest<GetIdentityProviderConfigRequest>, ) -> Result<Response<GetIdentityProviderConfigResponse>, Status>

Get the identity provider configuration data by id.

Source

pub async fn update_identity_provider_config( &mut self, request: impl IntoRequest<UpdateIdentityProviderConfigRequest>, ) -> Result<Response<UpdateIdentityProviderConfigResponse>, Status>

Update selected modifiable attribute of an identity provider config resource described by the IdentityProviderConfig message.

Source

pub async fn list_identity_provider_configs( &mut self, request: impl IntoRequest<ListIdentityProviderConfigsRequest>, ) -> Result<Response<ListIdentityProviderConfigsResponse>, Status>

List all existing identity provider configurations.

Source

pub async fn delete_identity_provider_config( &mut self, request: impl IntoRequest<DeleteIdentityProviderConfigRequest>, ) -> Result<Response<DeleteIdentityProviderConfigResponse>, Status>

Delete an existing identity provider configuration.

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> IdentityProviderConfigServiceClient<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 IdentityProviderConfigServiceClient<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<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> 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<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> 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, !>

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<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