pub struct ExternalLoginsResource<'a> { /* private fields */ }Expand description
client.external_logins()
Implementations§
Source§impl<'a> ExternalLoginsResource<'a>
impl<'a> ExternalLoginsResource<'a>
pub fn link(&self) -> ExternalLoginsLinkResource<'a>
pub fn oidc(&self) -> ExternalLoginsOidcResource<'a>
pub fn saml(&self) -> ExternalLoginsSamlResource<'a>
Sourcepub fn create(&self, body: &ExternalLoginCreate) -> Result<ExternalLogin>
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);Sourcepub fn delete(&self, external_login_id: impl Display) -> Result<()>
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)?;Sourcepub fn get(&self, external_login_id: impl Display) -> Result<ExternalLogin>
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);Sourcepub fn list(&self) -> Result<Vec<ExternalLogin>>
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);
}Sourcepub fn update(
&self,
external_login_id: impl Display,
body: &ExternalLoginUpdate,
) -> Result<ExternalLogin>
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);