pub struct AuthApi;Expand description
AuthApi
Owns delegated-token helpers and root-signed role-attestation helpers. Owned by the API layer and called by generated endpoint wrappers.
Implementations§
Source§impl AuthApi
impl AuthApi
Sourcepub fn establish_application_session(
request: ApplicationSessionRequest,
) -> Result<ApplicationSessionCommandResponse, Error>
pub fn establish_application_session( request: ApplicationSessionRequest, ) -> Result<ApplicationSessionCommandResponse, Error>
Establish one caller-bound scoped session from a current delegated proof.
Sourcepub fn clear_application_session() -> Result<ApplicationSessionCommandResponse, Error>
pub fn clear_application_session() -> Result<ApplicationSessionCommandResponse, Error>
Remove only the current caller’s retained session and keep replay tombstones.
Sourcepub fn application_session_status() -> Result<ApplicationSessionStatus, Error>
pub fn application_session_status() -> Result<ApplicationSessionStatus, Error>
Return the current caller’s read-only application-session classification.
Sourcepub fn application_session_audit(
page: PageRequest,
) -> Result<ApplicationSessionAuditResponse, Error>
pub fn application_session_audit( page: PageRequest, ) -> Result<ApplicationSessionAuditResponse, Error>
Return one root-authorized bounded audit page of retained application sessions.
Source§impl AuthApi
impl AuthApi
Sourcepub fn prepare_component_role_attestation_root(
request: RoleAttestationRequest,
member: &ManagedCanisterBinding,
) -> Result<RoleAttestationPrepareResponse, Error>
pub fn prepare_component_role_attestation_root( request: RoleAttestationRequest, member: &ManagedCanisterBinding, ) -> Result<RoleAttestationPrepareResponse, Error>
Prepare a root-certified role attestation from the local root update path.
Sourcepub fn get_role_attestation_root(
request: RoleAttestationGetRequest,
) -> Result<SignedRoleAttestation, Error>
pub fn get_role_attestation_root( request: RoleAttestationGetRequest, ) -> Result<SignedRoleAttestation, Error>
Retrieve a prepared role attestation with its root canister-signature proof.
Sourcepub async fn verify_role_attestation(
attestation: &SignedRoleAttestation,
min_accepted_epoch: u64,
) -> Result<(), Error>
pub async fn verify_role_attestation( attestation: &SignedRoleAttestation, min_accepted_epoch: u64, ) -> Result<(), Error>
Verify a role attestation locally from its embedded root proof.
Sourcepub async fn verify_local_subnet_role_attestation(
attestation: &SignedRoleAttestation,
min_accepted_epoch: u64,
) -> Result<(), Error>
pub async fn verify_local_subnet_role_attestation( attestation: &SignedRoleAttestation, min_accepted_epoch: u64, ) -> Result<(), Error>
Verify a role attestation that explicitly binds the caller to this live Subnet.
Source§impl AuthApi
impl AuthApi
Sourcepub fn upsert_root_issuer_policy_root(
request: RootIssuerPolicyUpsertRequest,
) -> Result<RootIssuerPolicyResponse, Error>
pub fn upsert_root_issuer_policy_root( request: RootIssuerPolicyUpsertRequest, ) -> Result<RootIssuerPolicyResponse, Error>
Upsert root issuer policy from the local root controller path.
Sourcepub fn upsert_root_issuer_renewal_template_root(
request: RootIssuerRenewalTemplateUpsertRequest,
) -> Result<RootIssuerRenewalTemplateResponse, Error>
pub fn upsert_root_issuer_renewal_template_root( request: RootIssuerRenewalTemplateUpsertRequest, ) -> Result<RootIssuerRenewalTemplateResponse, Error>
Upsert root-managed renewal template from the local root controller path.
Sourcepub fn root_issuer_renewal_status_root(
request: RootIssuerRenewalStatusRequest,
) -> Result<RootIssuerRenewalStatusResponse, Error>
pub fn root_issuer_renewal_status_root( request: RootIssuerRenewalStatusRequest, ) -> Result<RootIssuerRenewalStatusResponse, Error>
Report root-managed renewal template/state for one issuer.
Sourcepub async fn get_or_create_chain_key_delegation_proof_root() -> Result<RootDelegationProofBatchProof, Error>
pub async fn get_or_create_chain_key_delegation_proof_root() -> Result<RootDelegationProofBatchProof, Error>
Return or create a chain-key root delegation proof for the registered issuer caller.
Sourcepub async fn provision_chain_key_delegation_proof_for_issuer_root(
issuer_pid: Principal,
) -> Result<(), Error>
pub async fn provision_chain_key_delegation_proof_for_issuer_root( issuer_pid: Principal, ) -> Result<(), Error>
Create or reuse and install a chain-key delegation proof for one issuer.
Root applications may call this after installing or reinstalling an issuer so delegated-token issuance is ready before the first login.
Source§impl AuthApi
impl AuthApi
Sourcepub async fn prepare_delegated_token(
request: DelegatedTokenPrepareRequest,
) -> Result<DelegatedTokenPrepareResponse, Error>
pub async fn prepare_delegated_token( request: DelegatedTokenPrepareRequest, ) -> Result<DelegatedTokenPrepareResponse, Error>
Prepare a delegated token from the issuer-local active delegation proof.
Sourcepub fn get_delegated_token(
request: DelegatedTokenGetRequest,
) -> Result<DelegatedToken, Error>
pub fn get_delegated_token( request: DelegatedTokenGetRequest, ) -> Result<DelegatedToken, Error>
Retrieve a prepared delegated token with its issuer canister-signature proof.
Sourcepub fn install_active_delegation_proof(
request: InstallActiveDelegationProofRequest,
) -> Result<InstallActiveDelegationProofResponse, Error>
pub fn install_active_delegation_proof( request: InstallActiveDelegationProofRequest, ) -> Result<InstallActiveDelegationProofResponse, Error>
Install validated root-certified delegation material for issuer-local token issuance.
Sourcepub fn active_delegation_proof_status() -> Result<ActiveDelegationProofStatusResponse, Error>
pub fn active_delegation_proof_status() -> Result<ActiveDelegationProofStatusResponse, Error>
Report non-secret issuer-local active proof lifecycle status for operators.