Struct okta::identity_providers::IdentityProviders

source · [−]

pub struct IdentityProviders {
    pub client: Client,
}

Fields

client: Client

Implementations

source

impl IdentityProviders

source

pub async fn list(
 &self,
 q: &str,
 after: &str,
 limit: i64,
 type_: &str
) -> Result<Vec<IdentityProvider>>

List Identity Providers.

This function performs a GET to the /api/v1/idps endpoint.

Enumerates IdPs in your organization with pagination. A subset of IdPs can be returned that match a supported filter expression or query.

Parameters:

q: &str – Searches the name property of IdPs for matching value.
after: &str – Specifies the pagination cursor for the next page of IdPs.
limit: i64 – Specifies the number of IdP results in a page.
type_: &str – Filters IdPs by type.

source

pub async fn list_all(
 &self,
 q: &str,
 type_: &str
) -> Result<Vec<IdentityProvider>>

List Identity Providers.

This function performs a GET to the /api/v1/idps endpoint.

As opposed to list, this function returns all the pages of the request at once.

Enumerates IdPs in your organization with pagination. A subset of IdPs can be returned that match a supported filter expression or query.

source

pub async fn create(&self, body: &IdentityProvider) -> Result<IdentityProvider>

Add Identity Provider.

This function performs a POST to the /api/v1/idps endpoint.

Adds a new IdP to your organization.

source

pub async fn list_keys(
 &self,
 after: &str,
 limit: i64
) -> Result<Vec<JsonWebKey>>

List Keys.

This function performs a GET to the /api/v1/idps/credentials/keys endpoint.

Enumerates IdP key credentials.

Parameters:

after: &str – Specifies the pagination cursor for the next page of keys.
limit: i64 – Specifies the number of key results in a page.

source

pub async fn list_all_keys(&self) -> Result<Vec<JsonWebKey>>

List Keys.

This function performs a GET to the /api/v1/idps/credentials/keys endpoint.

As opposed to list_keys, this function returns all the pages of the request at once.

Enumerates IdP key credentials.

source

pub async fn create_key(&self, body: &JsonWebKey) -> Result<JsonWebKey>

Add X.509 Certificate Public Key.

This function performs a POST to the /api/v1/idps/credentials/keys endpoint.

Adds a new X.509 certificate credential to the IdP key store.

source

pub async fn get_key(&self, key_id: &str) -> Result<JsonWebKey>

Get Key.

This function performs a GET to the /api/v1/idps/credentials/keys/{keyId} endpoint.

Gets a specific IdP Key Credential by kid

Parameters:

key_id: &str

source

pub async fn delete_key(&self, key_id: &str) -> Result<()>

Delete Key.

This function performs a DELETE to the /api/v1/idps/credentials/keys/{keyId} endpoint.

Deletes a specific IdP Key Credential by kid if it is not currently being used by an Active or Inactive IdP.

Parameters:

key_id: &str

source

pub async fn get(&self, idp_id: &str) -> Result<IdentityProvider>

Get Identity Provider.

This function performs a GET to the /api/v1/idps/{idpId} endpoint.

Fetches an IdP by id.

Parameters:

idp_id: &str

source

pub async fn update(
 &self,
 idp_id: &str,
 body: &IdentityProvider
) -> Result<IdentityProvider>

Update Identity Provider.

This function performs a PUT to the /api/v1/idps/{idpId} endpoint.

Updates the configuration for an IdP.

Parameters:

idp_id: &str

source

pub async fn delete(&self, idp_id: &str) -> Result<()>

Delete Identity Provider.

This function performs a DELETE to the /api/v1/idps/{idpId} endpoint.

Removes an IdP from your organization.

Parameters:

idp_id: &str

source

pub async fn list_csrs_fors(&self, idp_id: &str) -> Result<Vec<Csr>>

List Certificate Signing Requests for IdP.

This function performs a GET to the /api/v1/idps/{idpId}/credentials/csrs endpoint.

Enumerates Certificate Signing Requests for an IdP

Parameters:

idp_id: &str

source

pub async fn list_all_csrs_fors(&self, idp_id: &str) -> Result<Vec<Csr>>

List Certificate Signing Requests for IdP.

This function performs a GET to the /api/v1/idps/{idpId}/credentials/csrs endpoint.

As opposed to list_csrs_for, this function returns all the pages of the request at once.

Enumerates Certificate Signing Requests for an IdP

source

pub async fn generate_csr_for(
 &self,
 idp_id: &str,
 body: &CsrMetadata
) -> Result<Csr>

Generate Certificate Signing Request for IdP.

This function performs a POST to the /api/v1/idps/{idpId}/credentials/csrs endpoint.

Generates a new key pair and returns a Certificate Signing Request for it.

Parameters:

idp_id: &str

source

pub async fn get_csr_for(&self, idp_id: &str, csr_id: &str) -> Result<Csr>

This function performs a GET to the /api/v1/idps/{idpId}/credentials/csrs/{csrId} endpoint.

Gets a specific Certificate Signing Request model by id

Parameters:

idp_id: &str
csr_id: &str

source

pub async fn revoke_csr_for(&self, idp_id: &str, csr_id: &str) -> Result<()>

This function performs a DELETE to the /api/v1/idps/{idpId}/credentials/csrs/{csrId} endpoint.

Revoke a Certificate Signing Request and delete the key pair from the IdP

Parameters:

idp_id: &str
csr_id: &str

source

pub async fn post_idp_credentials_csr_lifecycle_publish(
 &self,
 idp_id: &str,
 csr_id: &str
) -> Result<JsonWebKey>

This function performs a POST to the /api/v1/idps/{idpId}/credentials/csrs/{csrId}/lifecycle/publish endpoint.

Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.

Parameters:

idp_id: &str
csr_id: &str

source

pub async fn list_signing_keys(&self, idp_id: &str) -> Result<Vec<JsonWebKey>>

List Signing Key Credentials for IdP.

This function performs a GET to the /api/v1/idps/{idpId}/credentials/keys endpoint.

Enumerates signing key credentials for an IdP

Parameters:

idp_id: &str

source

pub async fn list_all_signing_keys(
&self,
idp_id: &str
) -> Result<Vec<JsonWebKey>>

List Signing Key Credentials for IdP.

This function performs a GET to the /api/v1/idps/{idpId}/credentials/keys endpoint.

As opposed to list_signing_keys, this function returns all the pages of the request at once.

Enumerates signing key credentials for an IdP

source

pub async fn generate_signing_key(
 &self,
 idp_id: &str,
 validity_years: i64
) -> Result<JsonWebKey>

Generate New IdP Signing Key Credential.

This function performs a POST to the /api/v1/idps/{idpId}/credentials/keys/generate endpoint.

Generates a new X.509 certificate for an IdP signing key credential to be used for signing assertions sent to the IdP

Parameters:

idp_id: &str
validity_years: i64 – expiry of the IdP Key Credential.

source

pub async fn get_signing_key(
 &self,
 idp_id: &str,
 key_id: &str
) -> Result<JsonWebKey>

Get Signing Key Credential for IdP.

This function performs a GET to the /api/v1/idps/{idpId}/credentials/keys/{keyId} endpoint.

Gets a specific IdP Key Credential by kid

Parameters:

idp_id: &str
key_id: &str

source

pub async fn clone_key(
 &self,
 idp_id: &str,
 key_id: &str,
 target_idp_id: &str
) -> Result<JsonWebKey>

Clone Signing Key Credential for IdP.

This function performs a POST to the /api/v1/idps/{idpId}/credentials/keys/{keyId}/clone endpoint.

Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP

Parameters:

idp_id: &str
key_id: &str
target_idp_id: &str

source

pub async fn activate(&self, idp_id: &str) -> Result<IdentityProvider>

Activate Identity Provider.

This function performs a POST to the /api/v1/idps/{idpId}/lifecycle/activate endpoint.

Activates an inactive IdP.

Parameters:

idp_id: &str

source

pub async fn deactivate(&self, idp_id: &str) -> Result<IdentityProvider>

Deactivate Identity Provider.

This function performs a POST to the /api/v1/idps/{idpId}/lifecycle/deactivate endpoint.

Deactivates an active IdP.

Parameters:

idp_id: &str

source

pub async fn list_application_users(
&self,
idp_id: &str
) -> Result<Vec<IdentityProviderApplicationUser>>

Find Users.

This function performs a GET to the /api/v1/idps/{idpId}/users endpoint.

Find all the users linked to an identity provider

Parameters:

idp_id: &str

source

pub async fn list_all_application_users(
&self,
idp_id: &str
) -> Result<Vec<IdentityProviderApplicationUser>>

Find Users.

This function performs a GET to the /api/v1/idps/{idpId}/users endpoint.

As opposed to list_application_users, this function returns all the pages of the request at once.

Find all the users linked to an identity provider

source

pub async fn get_application_user(
 &self,
 idp_id: &str,
 user_id: &str
) -> Result<IdentityProviderApplicationUser>

This function performs a GET to the /api/v1/idps/{idpId}/users/{userId} endpoint.

Fetches a linked IdP user by ID

Parameters:

idp_id: &str
user_id: &str

source

pub async fn link_user(
 &self,
 idp_id: &str,
 user_id: &str,
 body: &UserIdentityProviderLinkRequest
) -> Result<IdentityProviderApplicationUser>

Link a user to a Social IdP without a transaction.

This function performs a POST to the /api/v1/idps/{idpId}/users/{userId} endpoint.

Links an Okta user to an existing Social Identity Provider. This does not support the SAML2 Identity Provider Type

Parameters:

idp_id: &str
user_id: &str

source

pub async fn unlink_user_from(&self, idp_id: &str, user_id: &str) -> Result<()>

Unlink User from IdP.

This function performs a DELETE to the /api/v1/idps/{idpId}/users/{userId} endpoint.

Removes the link between the Okta user and the IdP user.

Parameters:

idp_id: &str
user_id: &str

source

pub async fn list_social_auth_tokens(
 &self,
 idp_id: &str,
 user_id: &str
) -> Result<Vec<SocialAuthToken>>

Social Authentication Token Operation.

This function performs a GET to the /api/v1/idps/{idpId}/users/{userId}/credentials/tokens endpoint.

Fetches the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth.

Parameters:

idp_id: &str
user_id: &str

source

pub async fn list_all_social_auth_tokens(
 &self,
 idp_id: &str,
 user_id: &str
) -> Result<Vec<SocialAuthToken>>

Social Authentication Token Operation.

This function performs a GET to the /api/v1/idps/{idpId}/users/{userId}/credentials/tokens endpoint.

As opposed to list_social_auth_tokens, this function returns all the pages of the request at once.

Fetches the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth.

Auto Trait Implementations

impl !RefUnwindSafe for IdentityProviders

impl Send for IdentityProviders

impl Sync for IdentityProviders

impl Unpin for IdentityProviders

impl !UnwindSafe for IdentityProviders

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

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

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

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 for T where
U: From<T>,

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

Struct okta::identity_providers::IdentityProviders

Fields

Implementations

impl IdentityProviders

pub async fn list( &self, q: &str, after: &str, limit: i64, type_: &str) -> Result<Vec<IdentityProvider>>

pub async fn list_all( &self, q: &str, type_: &str) -> Result<Vec<IdentityProvider>>

pub async fn create(&self, body: &IdentityProvider) -> Result<IdentityProvider>

pub async fn list_keys( &self, after: &str, limit: i64) -> Result<Vec<JsonWebKey>>

pub async fn list_all_keys(&self) -> Result<Vec<JsonWebKey>>

pub async fn create_key(&self, body: &JsonWebKey) -> Result<JsonWebKey>

pub async fn get_key(&self, key_id: &str) -> Result<JsonWebKey>

pub async fn delete_key(&self, key_id: &str) -> Result<()>

pub async fn get(&self, idp_id: &str) -> Result<IdentityProvider>

pub async fn update( &self, idp_id: &str, body: &IdentityProvider) -> Result<IdentityProvider>

pub async fn delete(&self, idp_id: &str) -> Result<()>

pub async fn list_csrs_fors(&self, idp_id: &str) -> Result<Vec<Csr>>

pub async fn list_all_csrs_fors(&self, idp_id: &str) -> Result<Vec<Csr>>

pub async fn generate_csr_for( &self, idp_id: &str, body: &CsrMetadata) -> Result<Csr>

pub async fn get_csr_for(&self, idp_id: &str, csr_id: &str) -> Result<Csr>

pub async fn revoke_csr_for(&self, idp_id: &str, csr_id: &str) -> Result<()>

pub async fn post_idp_credentials_csr_lifecycle_publish( &self, idp_id: &str, csr_id: &str) -> Result<JsonWebKey>

pub async fn list_signing_keys(&self, idp_id: &str) -> Result<Vec<JsonWebKey>>

pub async fn list_all_signing_keys( &self, idp_id: &str) -> Result<Vec<JsonWebKey>>

pub async fn generate_signing_key( &self, idp_id: &str, validity_years: i64) -> Result<JsonWebKey>

pub async fn get_signing_key( &self, idp_id: &str, key_id: &str) -> Result<JsonWebKey>

pub async fn clone_key( &self, idp_id: &str, key_id: &str, target_idp_id: &str) -> Result<JsonWebKey>

pub async fn activate(&self, idp_id: &str) -> Result<IdentityProvider>

pub async fn deactivate(&self, idp_id: &str) -> Result<IdentityProvider>

pub async fn list_application_users( &self, idp_id: &str) -> Result<Vec<IdentityProviderApplicationUser>>

pub async fn list_all_application_users( &self, idp_id: &str) -> Result<Vec<IdentityProviderApplicationUser>>

pub async fn get_application_user( &self, idp_id: &str, user_id: &str) -> Result<IdentityProviderApplicationUser>

pub async fn link_user( &self, idp_id: &str, user_id: &str, body: &UserIdentityProviderLinkRequest) -> Result<IdentityProviderApplicationUser>

pub async fn unlink_user_from(&self, idp_id: &str, user_id: &str) -> Result<()>

pub async fn list_social_auth_tokens( &self, idp_id: &str, user_id: &str) -> Result<Vec<SocialAuthToken>>

pub async fn list_all_social_auth_tokens( &self, idp_id: &str, user_id: &str) -> Result<Vec<SocialAuthToken>>

Auto Trait Implementations

impl !RefUnwindSafe for IdentityProviders

impl Send for IdentityProviders

impl Sync for IdentityProviders

impl Unpin for IdentityProviders

impl !UnwindSafe for IdentityProviders

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for T

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

fn with_current_context(self) -> WithContext<Self>

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn list(
&self,
q: &str,
after: &str,
limit: i64,
type_: &str
) -> Result<Vec<IdentityProvider>>

pub async fn list_all(
&self,
q: &str,
type_: &str
) -> Result<Vec<IdentityProvider>>

pub async fn list_keys(
&self,
after: &str,
limit: i64
) -> Result<Vec<JsonWebKey>>

pub async fn update(
&self,
idp_id: &str,
body: &IdentityProvider
) -> Result<IdentityProvider>

pub async fn generate_csr_for(
&self,
idp_id: &str,
body: &CsrMetadata
) -> Result<Csr>

pub async fn post_idp_credentials_csr_lifecycle_publish(
&self,
idp_id: &str,
csr_id: &str
) -> Result<JsonWebKey>

pub async fn list_all_signing_keys(
&self,
idp_id: &str
) -> Result<Vec<JsonWebKey>>

pub async fn generate_signing_key(
&self,
idp_id: &str,
validity_years: i64
) -> Result<JsonWebKey>

pub async fn get_signing_key(
&self,
idp_id: &str,
key_id: &str
) -> Result<JsonWebKey>

pub async fn clone_key(
&self,
idp_id: &str,
key_id: &str,
target_idp_id: &str
) -> Result<JsonWebKey>

pub async fn list_application_users(
&self,
idp_id: &str
) -> Result<Vec<IdentityProviderApplicationUser>>

pub async fn list_all_application_users(
&self,
idp_id: &str
) -> Result<Vec<IdentityProviderApplicationUser>>

pub async fn get_application_user(
&self,
idp_id: &str,
user_id: &str
) -> Result<IdentityProviderApplicationUser>

pub async fn link_user(
&self,
idp_id: &str,
user_id: &str,
body: &UserIdentityProviderLinkRequest
) -> Result<IdentityProviderApplicationUser>

pub async fn list_social_auth_tokens(
&self,
idp_id: &str,
user_id: &str
) -> Result<Vec<SocialAuthToken>>

pub async fn list_all_social_auth_tokens(
&self,
idp_id: &str,
user_id: &str
) -> Result<Vec<SocialAuthToken>>

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

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

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

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

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

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

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

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