Skip to main content

ExternalLoginsResource

Struct ExternalLoginsResource 

Source
pub struct ExternalLoginsResource<'a> { /* private fields */ }
Expand description

client.external_logins()

Implementations§

Source§

impl<'a> ExternalLoginsResource<'a>

Source

pub fn oidc(&self) -> ExternalLoginsOidcResource<'a>

Source

pub fn saml(&self) -> ExternalLoginsSamlResource<'a>

Source

pub fn create(&self, body: &ExternalLoginCreate) -> Result<ExternalLogin>

Create an external login provider

POST /externallogins

Creates an OAuth, OpenID Connect or SAML provider configuration. Requires “churchcore administer settings” permission; SAML additionally requires the SAML settings feature flag. Logo discovery may contact the provider while saving. Only one provider can be primary.

§Example
let body = models::ExternalLoginCreate {
    config: serde_json::json!({"accessTokenUrl": "https://identity.example.org/accessTokenUrl", "authorizeUrl": "https://identity.example.org/authorizeUrl", "clientId": "churchtools", "urlResourceOwnerDetails": "https://identity.example.org/urlResourceOwnerDetails"}),
    create_new_person: true,
    has_registration: true,
    name: "Organization login".into(),
    new_person_campus_id: Some(42),
    new_person_department_id: Some(42),
    new_person_status_id: Some(42),
    r#type: "oauth".into(),
    update_data_on_login: true,
    ..Default::default()
};
let result = client.external_logins().create(&body)?;
println!("{}", result.name);
Source

pub fn delete(&self, external_login_id: impl Display) -> Result<()>

Delete an external login provider

DELETE /externallogins/{externalLoginId}

Deletes the provider configuration and its stored person-identity mappings. Requires “churchcore administer settings” permission; deleting a SAML provider also requires the SAML settings feature flag. ChurchTools persons and sessions at the external provider remain.

§Example
client.external_logins().delete(7)?;
Source

pub fn get(&self, external_login_id: impl Display) -> Result<ExternalLogin>

Get an external login provider

GET /externallogins/{externalLoginId}

Returns one provider configuration. Requires “churchcore administer settings” permission. Hidden providers remain accessible. Client secrets and SAML SP private keys are not included.

§Example
let external_login = client.external_logins().get(7)?;
println!("{}", external_login.name);
Source

pub fn list(&self) -> Result<Vec<ExternalLogin>>

List external login providers

GET /externallogins

Returns all external login provider configurations, including hidden providers. Requires “churchcore administer settings” permission. Client secrets and SAML SP private keys are not included.

§Example
for external_login in client.external_logins().list()? {
    println!("{}", external_login.name);
}
Source

pub fn update( &self, external_login_id: impl Display, body: &ExternalLoginUpdate, ) -> Result<ExternalLogin>

Update an external login provider

PUT /externallogins/{externalLoginId}

Updates an existing provider. Requires “churchcore administer settings” permission; SAML changes additionally require the SAML settings feature flag. The protocol cannot be changed. Logo discovery is repeated, and setting primaryLogin does not demote another primary provider.

§Example
let body = models::ExternalLoginUpdate {
    config: serde_json::json!({"accessTokenUrl": "https://identity.example.org/accessTokenUrl", "authorizeUrl": "https://identity.example.org/authorizeUrl", "clientId": "churchtools", "urlResourceOwnerDetails": "https://identity.example.org/urlResourceOwnerDetails"}),
    create_new_person: true,
    has_registration: true,
    name: "Nextcloud".into(),
    new_person_campus_id: Some(42),
    new_person_department_id: Some(42),
    new_person_status_id: Some(42),
    r#type: "oauth".into(),
    update_data_on_login: true,
    ..Default::default()
};
let result = client.external_logins().update(7, &body)?;
println!("{}", result.name);

Trait Implementations§

Source§

impl<'a> Clone for ExternalLoginsResource<'a>

Source§

fn clone(&self) -> Self

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<'a> Copy for ExternalLoginsResource<'a>

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