Struct InstancePrincipalsAuthProvider 

pub struct InstancePrincipalsAuthProvider { /* private fields */ }

Instance Principals Authentication Provider

Enables applications running on OCI compute instances to authenticate using X.509 certificates from the Instance Metadata Service (IMDS).

Example

use oci_rust_sdk::auth::InstancePrincipalsAuthProvider;
use std::sync::Arc;

// Initialize provider (auto-detects region and fetches certs from IMDS)
let auth = InstancePrincipalsAuthProvider::new().await?;
let auth_ref = Arc::new(auth);

// Use with OciClient
// let client = OciClient::new(auth_ref, endpoint)?;

Implementations

impl InstancePrincipalsAuthProvider

pub async fn new() -> Result<Self>

Create a new instance principals authentication provider

This will:

1. Fetch region and certificates from IMDS
2. Extract tenant ID from certificate
3. Generate initial session keypair
4. Request initial security token from federation service

Errors

Returns an error if:

• IMDS is unavailable (not running on OCI instance)
• Certificate parsing fails
• Federation service is unreachable
• Token request fails

pub fn region(&self) -> Region

Get the region for this instance

Trait Implementations

impl AuthProvider for InstancePrincipalsAuthProvider

fn get_key_id(&self) -> String

Get the key ID (e.g., “ocid1.tenancy.oc1..xxxxx/ocid1.user.oc1..xxxxx/fingerprint”)

fn get_private_key(&self) -> &str

Get the private key in PEM format

fn get_passphrase(&self) -> Option<&str>

Get the passphrase for the private key (if any)