Struct oxide_api::types::SiloCreate

pub struct SiloCreate {
    pub name: String,
    pub description: String,
    pub admin_group_name: String,
    pub discoverable: bool,
    pub user_provision_type: UserProvisionType,
}

Create-time parameters for a Silo

Fields

name: String

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’. Names cannot be a UUID though they may contain a UUID.

description: String

admin_group_name: String

If set, this group will be created during Silo creation and granted the “Silo Admin” role. Identity providers can assert that users belong to this group and those users can log in and further initialize the Silo.

Note that if configuring a SAML based identity provider, group_attribute_name must be set for users to be considered part of a group. See SamlIdentityProviderCreate for more information.

discoverable: bool

user_provision_type: UserProvisionType

How users will be provisioned in a silo during authentication.

Trait Implementations

impl Clone for SiloCreate

fn clone(&self) -> SiloCreate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SiloCreate

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

Formats the value using the given formatter.

impl Default for SiloCreate

fn default() -> SiloCreate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SiloCreate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SiloCreate

fn schema_name() -> String

The name of the generated JSON Schema.

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

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq<SiloCreate> for SiloCreate

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SiloCreate

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

Serialize this value into the given Serde serializer.

impl Tabled for SiloCreate

const LENGTH: usize = 5usize

A length of fields and headers, which must be the same.

fn fields(&self) -> Vec<String>

Fields method must return a list of cells.

fn headers() -> Vec<String>

Headers must return a list of column names.

impl StructuralPartialEq for SiloCreate