Struct okta::authorization_servers::AuthorizationServers
source · [−]pub struct AuthorizationServers {
pub client: Client,
}Fields
client: ClientImplementations
sourceimpl AuthorizationServers
impl AuthorizationServers
sourcepub async fn list(
&self,
q: &str,
limit: &str,
after: &str
) -> Result<Vec<AuthorizationServer>>
pub async fn list(
&self,
q: &str,
limit: &str,
after: &str
) -> Result<Vec<AuthorizationServer>>
This function performs a GET to the /api/v1/authorizationServers endpoint.
Success
Parameters:
q: &strlimit: &strafter: &str
sourcepub async fn list_all(&self, q: &str) -> Result<Vec<AuthorizationServer>>
pub async fn list_all(&self, q: &str) -> Result<Vec<AuthorizationServer>>
This function performs a GET to the /api/v1/authorizationServers endpoint.
As opposed to list, this function returns all the pages of the request at once.
Success
sourcepub async fn create(
&self,
body: &AuthorizationServer
) -> Result<AuthorizationServer>
pub async fn create(
&self,
body: &AuthorizationServer
) -> Result<AuthorizationServer>
This function performs a POST to the /api/v1/authorizationServers endpoint.
Success
sourcepub async fn get(&self, auth_server_id: &str) -> Result<AuthorizationServer>
pub async fn get(&self, auth_server_id: &str) -> Result<AuthorizationServer>
This function performs a GET to the /api/v1/authorizationServers/{authServerId} endpoint.
Success
Parameters:
auth_server_id: &str
sourcepub async fn update(
&self,
auth_server_id: &str,
body: &AuthorizationServer
) -> Result<AuthorizationServer>
pub async fn update(
&self,
auth_server_id: &str,
body: &AuthorizationServer
) -> Result<AuthorizationServer>
This function performs a PUT to the /api/v1/authorizationServers/{authServerId} endpoint.
Success
Parameters:
auth_server_id: &str
sourcepub async fn delete(&self, auth_server_id: &str) -> Result<()>
pub async fn delete(&self, auth_server_id: &str) -> Result<()>
This function performs a DELETE to the /api/v1/authorizationServers/{authServerId} endpoint.
Success
Parameters:
auth_server_id: &str
sourcepub async fn list_o_auth_2_claims(
&self,
auth_server_id: &str
) -> Result<Vec<OAuth2Claim>>
pub async fn list_o_auth_2_claims(
&self,
auth_server_id: &str
) -> Result<Vec<OAuth2Claim>>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/claims endpoint.
Success
Parameters:
auth_server_id: &str
sourcepub async fn list_all_o_auth_2_claims(
&self,
auth_server_id: &str
) -> Result<Vec<OAuth2Claim>>
pub async fn list_all_o_auth_2_claims(
&self,
auth_server_id: &str
) -> Result<Vec<OAuth2Claim>>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/claims endpoint.
As opposed to list_o_auth_2_claims, this function returns all the pages of the request at once.
Success
sourcepub async fn create_o_auth_2_claim(
&self,
auth_server_id: &str,
body: &OAuth2Claim
) -> Result<OAuth2Claim>
pub async fn create_o_auth_2_claim(
&self,
auth_server_id: &str,
body: &OAuth2Claim
) -> Result<OAuth2Claim>
This function performs a POST to the /api/v1/authorizationServers/{authServerId}/claims endpoint.
Success
Parameters:
auth_server_id: &str
sourcepub async fn get_o_auth_2_claim(
&self,
auth_server_id: &str,
claim_id: &str
) -> Result<OAuth2Claim>
pub async fn get_o_auth_2_claim(
&self,
auth_server_id: &str,
claim_id: &str
) -> Result<OAuth2Claim>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/claims/{claimId} endpoint.
Success
Parameters:
auth_server_id: &strclaim_id: &str
sourcepub async fn update_o_auth_2_claim(
&self,
auth_server_id: &str,
claim_id: &str,
body: &OAuth2Claim
) -> Result<OAuth2Claim>
pub async fn update_o_auth_2_claim(
&self,
auth_server_id: &str,
claim_id: &str,
body: &OAuth2Claim
) -> Result<OAuth2Claim>
This function performs a PUT to the /api/v1/authorizationServers/{authServerId}/claims/{claimId} endpoint.
Success
Parameters:
auth_server_id: &strclaim_id: &str
sourcepub async fn delete_o_auth_2_claim(
&self,
auth_server_id: &str,
claim_id: &str
) -> Result<()>
pub async fn delete_o_auth_2_claim(
&self,
auth_server_id: &str,
claim_id: &str
) -> Result<()>
This function performs a DELETE to the /api/v1/authorizationServers/{authServerId}/claims/{claimId} endpoint.
Success
Parameters:
auth_server_id: &strclaim_id: &str
sourcepub async fn list_o_auth_2_clients_fors(
&self,
auth_server_id: &str
) -> Result<Vec<OAuth2Client>>
pub async fn list_o_auth_2_clients_fors(
&self,
auth_server_id: &str
) -> Result<Vec<OAuth2Client>>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/clients endpoint.
Success
Parameters:
auth_server_id: &str
sourcepub async fn list_all_o_auth_2_clients_fors(
&self,
auth_server_id: &str
) -> Result<Vec<OAuth2Client>>
pub async fn list_all_o_auth_2_clients_fors(
&self,
auth_server_id: &str
) -> Result<Vec<OAuth2Client>>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/clients endpoint.
As opposed to list_o_auth_2_clients_for, this function returns all the pages of the request at once.
Success
sourcepub async fn list_refresh_tokens_for_and_clients(
&self,
auth_server_id: &str,
client_id: &str,
expand: &str,
after: &str,
limit: i64
) -> Result<Vec<OAuth2RefreshToken>>
pub async fn list_refresh_tokens_for_and_clients(
&self,
auth_server_id: &str,
client_id: &str,
expand: &str,
after: &str,
limit: i64
) -> Result<Vec<OAuth2RefreshToken>>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens endpoint.
Success
Parameters:
auth_server_id: &strclient_id: &strexpand: &strafter: &strlimit: i64
sourcepub async fn list_all_refresh_tokens_for_and_clients(
&self,
auth_server_id: &str,
client_id: &str,
expand: &str
) -> Result<Vec<OAuth2RefreshToken>>
pub async fn list_all_refresh_tokens_for_and_clients(
&self,
auth_server_id: &str,
client_id: &str,
expand: &str
) -> Result<Vec<OAuth2RefreshToken>>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens endpoint.
As opposed to list_refresh_tokens_for_and_client, this function returns all the pages of the request at once.
Success
sourcepub async fn revoke_refresh_tokens_for_and_client(
&self,
auth_server_id: &str,
client_id: &str
) -> Result<()>
pub async fn revoke_refresh_tokens_for_and_client(
&self,
auth_server_id: &str,
client_id: &str
) -> Result<()>
This function performs a DELETE to the /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens endpoint.
Success
Parameters:
auth_server_id: &strclient_id: &str
sourcepub async fn get_refresh_token_for_and_client(
&self,
auth_server_id: &str,
client_id: &str,
token_id: &str,
expand: &str
) -> Result<OAuth2RefreshToken>
pub async fn get_refresh_token_for_and_client(
&self,
auth_server_id: &str,
client_id: &str,
token_id: &str,
expand: &str
) -> Result<OAuth2RefreshToken>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId} endpoint.
Success
Parameters:
auth_server_id: &strclient_id: &strtoken_id: &strexpand: &str
sourcepub async fn revoke_refresh_token_for_and_client(
&self,
auth_server_id: &str,
client_id: &str,
token_id: &str
) -> Result<()>
pub async fn revoke_refresh_token_for_and_client(
&self,
auth_server_id: &str,
client_id: &str,
token_id: &str
) -> Result<()>
This function performs a DELETE to the /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId} endpoint.
Success
Parameters:
auth_server_id: &strclient_id: &strtoken_id: &str
sourcepub async fn list_keys(&self, auth_server_id: &str) -> Result<Vec<JsonWebKey>>
pub async fn list_keys(&self, auth_server_id: &str) -> Result<Vec<JsonWebKey>>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/credentials/keys endpoint.
Success
Parameters:
auth_server_id: &str
sourcepub async fn list_all_keys(
&self,
auth_server_id: &str
) -> Result<Vec<JsonWebKey>>
pub async fn list_all_keys(
&self,
auth_server_id: &str
) -> Result<Vec<JsonWebKey>>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/credentials/keys endpoint.
As opposed to list_keys, this function returns all the pages of the request at once.
Success
sourcepub async fn rotate_keys(
&self,
auth_server_id: &str,
body: &JwkUse
) -> Result<Vec<JsonWebKey>>
pub async fn rotate_keys(
&self,
auth_server_id: &str,
body: &JwkUse
) -> Result<Vec<JsonWebKey>>
This function performs a POST to the /api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotate endpoint.
Success
Parameters:
auth_server_id: &str
sourcepub async fn activate(&self, auth_server_id: &str) -> Result<()>
pub async fn activate(&self, auth_server_id: &str) -> Result<()>
This function performs a POST to the /api/v1/authorizationServers/{authServerId}/lifecycle/activate endpoint.
Success
Parameters:
auth_server_id: &str
sourcepub async fn deactivate(&self, auth_server_id: &str) -> Result<()>
pub async fn deactivate(&self, auth_server_id: &str) -> Result<()>
This function performs a POST to the /api/v1/authorizationServers/{authServerId}/lifecycle/deactivate endpoint.
Success
Parameters:
auth_server_id: &str
sourcepub async fn list_policies(&self, auth_server_id: &str) -> Result<Vec<Policy>>
pub async fn list_policies(&self, auth_server_id: &str) -> Result<Vec<Policy>>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/policies endpoint.
Success
Parameters:
auth_server_id: &str
sourcepub async fn list_all_policies(
&self,
auth_server_id: &str
) -> Result<Vec<Policy>>
pub async fn list_all_policies(
&self,
auth_server_id: &str
) -> Result<Vec<Policy>>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/policies endpoint.
As opposed to list_policies, this function returns all the pages of the request at once.
Success
sourcepub async fn create_policy(
&self,
auth_server_id: &str,
body: &Policy
) -> Result<Policy>
pub async fn create_policy(
&self,
auth_server_id: &str,
body: &Policy
) -> Result<Policy>
This function performs a POST to the /api/v1/authorizationServers/{authServerId}/policies endpoint.
Success
Parameters:
auth_server_id: &str
sourcepub async fn get_policy(
&self,
auth_server_id: &str,
policy_id: &str
) -> Result<Policy>
pub async fn get_policy(
&self,
auth_server_id: &str,
policy_id: &str
) -> Result<Policy>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/policies/{policyId} endpoint.
Success
Parameters:
auth_server_id: &strpolicy_id: &str
sourcepub async fn update_policy(
&self,
auth_server_id: &str,
policy_id: &str,
body: &Policy
) -> Result<Policy>
pub async fn update_policy(
&self,
auth_server_id: &str,
policy_id: &str,
body: &Policy
) -> Result<Policy>
This function performs a PUT to the /api/v1/authorizationServers/{authServerId}/policies/{policyId} endpoint.
Success
Parameters:
auth_server_id: &strpolicy_id: &str
sourcepub async fn delete_policy(
&self,
auth_server_id: &str,
policy_id: &str
) -> Result<()>
pub async fn delete_policy(
&self,
auth_server_id: &str,
policy_id: &str
) -> Result<()>
This function performs a DELETE to the /api/v1/authorizationServers/{authServerId}/policies/{policyId} endpoint.
Success
Parameters:
auth_server_id: &strpolicy_id: &str
sourcepub async fn activate_policy(
&self,
auth_server_id: &str,
policy_id: &str
) -> Result<()>
pub async fn activate_policy(
&self,
auth_server_id: &str,
policy_id: &str
) -> Result<()>
This function performs a POST to the /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activate endpoint.
Activate Authorization Server Policy
Parameters:
auth_server_id: &strpolicy_id: &str
sourcepub async fn deactivate_policy(
&self,
auth_server_id: &str,
policy_id: &str
) -> Result<()>
pub async fn deactivate_policy(
&self,
auth_server_id: &str,
policy_id: &str
) -> Result<()>
This function performs a POST to the /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivate endpoint.
Deactivate Authorization Server Policy
Parameters:
auth_server_id: &strpolicy_id: &str
sourcepub async fn list_policy_rules(
&self,
policy_id: &str,
auth_server_id: &str
) -> Result<Vec<AuthorizationServerPolicyRule>>
pub async fn list_policy_rules(
&self,
policy_id: &str,
auth_server_id: &str
) -> Result<Vec<AuthorizationServerPolicyRule>>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules endpoint.
Enumerates all policy rules for the specified Custom Authorization Server and Policy.
Parameters:
policy_id: &strauth_server_id: &str
sourcepub async fn list_all_policy_rules(
&self,
policy_id: &str,
auth_server_id: &str
) -> Result<Vec<AuthorizationServerPolicyRule>>
pub async fn list_all_policy_rules(
&self,
policy_id: &str,
auth_server_id: &str
) -> Result<Vec<AuthorizationServerPolicyRule>>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules endpoint.
As opposed to list_policy_rules, this function returns all the pages of the request at once.
Enumerates all policy rules for the specified Custom Authorization Server and Policy.
sourcepub async fn create_policy_rule(
&self,
policy_id: &str,
auth_server_id: &str,
body: &AuthorizationServerPolicyRule
) -> Result<AuthorizationServerPolicyRule>
pub async fn create_policy_rule(
&self,
policy_id: &str,
auth_server_id: &str,
body: &AuthorizationServerPolicyRule
) -> Result<AuthorizationServerPolicyRule>
This function performs a POST to the /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules endpoint.
Creates a policy rule for the specified Custom Authorization Server and Policy.
Parameters:
policy_id: &strauth_server_id: &str
sourcepub async fn get_policy_rule(
&self,
policy_id: &str,
auth_server_id: &str,
rule_id: &str
) -> Result<AuthorizationServerPolicyRule>
pub async fn get_policy_rule(
&self,
policy_id: &str,
auth_server_id: &str,
rule_id: &str
) -> Result<AuthorizationServerPolicyRule>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId} endpoint.
Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy.
Parameters:
policy_id: &strauth_server_id: &strrule_id: &str
sourcepub async fn update_policy_rule(
&self,
policy_id: &str,
auth_server_id: &str,
rule_id: &str,
body: &AuthorizationServerPolicyRule
) -> Result<AuthorizationServerPolicyRule>
pub async fn update_policy_rule(
&self,
policy_id: &str,
auth_server_id: &str,
rule_id: &str,
body: &AuthorizationServerPolicyRule
) -> Result<AuthorizationServerPolicyRule>
This function performs a PUT to the /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId} endpoint.
Updates the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy.
Parameters:
policy_id: &strauth_server_id: &strrule_id: &str
sourcepub async fn delete_policy_rule(
&self,
policy_id: &str,
auth_server_id: &str,
rule_id: &str
) -> Result<()>
pub async fn delete_policy_rule(
&self,
policy_id: &str,
auth_server_id: &str,
rule_id: &str
) -> Result<()>
This function performs a DELETE to the /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId} endpoint.
Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy.
Parameters:
policy_id: &strauth_server_id: &strrule_id: &str
sourcepub async fn activate_policy_rule(
&self,
auth_server_id: &str,
policy_id: &str,
rule_id: &str
) -> Result<()>
pub async fn activate_policy_rule(
&self,
auth_server_id: &str,
policy_id: &str,
rule_id: &str
) -> Result<()>
This function performs a POST to the /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/activate endpoint.
Activate Authorization Server Policy Rule
Parameters:
auth_server_id: &strpolicy_id: &strrule_id: &str
sourcepub async fn deactivate_policy_rule(
&self,
auth_server_id: &str,
policy_id: &str,
rule_id: &str
) -> Result<()>
pub async fn deactivate_policy_rule(
&self,
auth_server_id: &str,
policy_id: &str,
rule_id: &str
) -> Result<()>
This function performs a POST to the /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate endpoint.
Deactivate Authorization Server Policy Rule
Parameters:
auth_server_id: &strpolicy_id: &strrule_id: &str
sourcepub async fn list_o_auth_2_scopes(
&self,
auth_server_id: &str,
q: &str,
filter: &str,
cursor: &str,
limit: i64
) -> Result<Vec<OAuth2Scope>>
pub async fn list_o_auth_2_scopes(
&self,
auth_server_id: &str,
q: &str,
filter: &str,
cursor: &str,
limit: i64
) -> Result<Vec<OAuth2Scope>>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/scopes endpoint.
Success
Parameters:
auth_server_id: &strq: &strfilter: &strcursor: &strlimit: i64
sourcepub async fn list_all_o_auth_2_scopes(
&self,
auth_server_id: &str,
q: &str,
filter: &str,
cursor: &str
) -> Result<Vec<OAuth2Scope>>
pub async fn list_all_o_auth_2_scopes(
&self,
auth_server_id: &str,
q: &str,
filter: &str,
cursor: &str
) -> Result<Vec<OAuth2Scope>>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/scopes endpoint.
As opposed to list_o_auth_2_scopes, this function returns all the pages of the request at once.
Success
sourcepub async fn create_o_auth_2_scope(
&self,
auth_server_id: &str,
body: &OAuth2Scope
) -> Result<OAuth2Scope>
pub async fn create_o_auth_2_scope(
&self,
auth_server_id: &str,
body: &OAuth2Scope
) -> Result<OAuth2Scope>
This function performs a POST to the /api/v1/authorizationServers/{authServerId}/scopes endpoint.
Success
Parameters:
auth_server_id: &str
sourcepub async fn get_o_auth_2_scope(
&self,
auth_server_id: &str,
scope_id: &str
) -> Result<OAuth2Scope>
pub async fn get_o_auth_2_scope(
&self,
auth_server_id: &str,
scope_id: &str
) -> Result<OAuth2Scope>
This function performs a GET to the /api/v1/authorizationServers/{authServerId}/scopes/{scopeId} endpoint.
Success
Parameters:
auth_server_id: &strscope_id: &str
sourcepub async fn update_o_auth_2_scope(
&self,
auth_server_id: &str,
scope_id: &str,
body: &OAuth2Scope
) -> Result<OAuth2Scope>
pub async fn update_o_auth_2_scope(
&self,
auth_server_id: &str,
scope_id: &str,
body: &OAuth2Scope
) -> Result<OAuth2Scope>
This function performs a PUT to the /api/v1/authorizationServers/{authServerId}/scopes/{scopeId} endpoint.
Success
Parameters:
auth_server_id: &strscope_id: &str
Auto Trait Implementations
impl !RefUnwindSafe for AuthorizationServers
impl Send for AuthorizationServers
impl Sync for AuthorizationServers
impl Unpin for AuthorizationServers
impl !UnwindSafe for AuthorizationServers
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> FutureExt for T
impl<T> FutureExt for T
fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more