Enum AuthMethod 

#[non_exhaustive]
pub enum AuthMethod {
    Auto,
    Basic,
    OAuth,
}

Supported authentication methods for the Onshape API.

See the Onshape API key docs for details on each method.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Auto

Automatic detection: try available credentials in priority order.

Resolution order:

1. OAuth with tokens (client credentials + token file present)
2. Basic auth (API key pair present)
3. OAuth pending (client credentials but no tokens yet)
4. Not configured

Basic

HTTP Basic authentication: base64-encoded access_key:secret_key.

Simplest method. Relies on HTTPS for transport security. Onshape documents this as suitable for local testing and personal use.

OAuth

OAuth 2.0 bearer token authentication.

Uses access tokens obtained through the OAuth 2.0 authorization code flow. Tokens are stored in a local file and refreshed when expired. Suitable for multi-user apps and team access.

Trait Implementations

impl Clone for AuthMethod

fn clone(&self) -> AuthMethod

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AuthMethod

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthMethod

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for AuthMethod

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for AuthMethod

fn eq(&self, other: &AuthMethod) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AuthMethod

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for AuthMethod

impl Eq for AuthMethod

impl StructuralPartialEq for AuthMethod