spiral-sdk 0.1.7

Rust SDK for Spiral resource and table APIs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

// Generated by tools/service-contracts/rust.py. Do not edit.
#![doc = "Transport-independent service interface for local and remote calls."]

use async_trait::async_trait;
use spiral_contract::auth::AuthHeader;
use spiral_contract::call::CallError;

use crate::api::authn::objects::*;
/// Service implementations authenticate Authorization headers and enforce resource permissions.
#[async_trait]
pub trait AuthnApi: Send + Sync + 'static {
    /// Only consent-enabled registrars may decide a challenge. Granted scopes must be within the
    /// request and current registration. Each challenge can be decided once.
    async fn decide_consent(
        &self,
        auth_header: AuthHeader,
        challenge: String,
        request: ConsentDecision,
    ) -> Result<ConsentRedirect, CallError<AuthnError>>;
    /// Delete a client that the caller owns. Tokens already issued to it stay valid until they
    /// expire.
    async fn delete_client(
        &self,
        auth_header: AuthHeader,
        client_id: String,
    ) -> Result<(), CallError<AuthnError>>;
    /// Read a client that the caller owns.
    async fn get_client(
        &self,
        auth_header: AuthHeader,
        client_id: String,
    ) -> Result<ClientRegistration, CallError<AuthnError>>;
    /// Only consent-enabled registrars may read a challenge.
    async fn get_consent_request(
        &self,
        auth_header: AuthHeader,
        challenge: String,
    ) -> Result<ConsentRequest, CallError<AuthnError>>;
    /// Read which third-party clients an Organization's users may sign in to. Only registrars
    /// permitted to manage app access may call it.
    async fn get_organization_app_access(
        &self,
        auth_header: AuthHeader,
        organization_id: String,
    ) -> Result<OrganizationAppAccess, CallError<AuthnError>>;
    /// Register the client, or replace the registration of a client that the caller owns. Returns
    /// ClientConflict when a configured client or another registrar's client has the ID.
    async fn put_client(
        &self,
        auth_header: AuthHeader,
        client_id: String,
        request: ClientRegistration,
    ) -> Result<ClientRegistration, CallError<AuthnError>>;
    /// Replace an Organization's app access. Sign-in and refresh check it on their next request;
    /// issued access tokens keep their expiry.
    async fn put_organization_app_access(
        &self,
        auth_header: AuthHeader,
        organization_id: String,
        request: OrganizationAppAccess,
    ) -> Result<OrganizationAppAccess, CallError<AuthnError>>;
    /// Withdraw every consent this client received from one user. Only its registrar may do so.
    async fn revoke_consent(
        &self,
        auth_header: AuthHeader,
        client_id: String,
        user_id: String,
    ) -> Result<(), CallError<AuthnError>>;
    /// Withdraw this user's consent for this client in one organization. Only its registrar may do
    /// so.
    async fn revoke_organization_consent(
        &self,
        auth_header: AuthHeader,
        client_id: String,
        user_id: String,
        organization_id: String,
    ) -> Result<(), CallError<AuthnError>>;
}