Struct CreateApiUser

pub struct CreateApiUser {
    pub role: ApiUserRole,
    pub name: String,
    pub csr_pem: String,
    pub co_signer_setup_type: Option<CoSignerSetupType>,
    pub co_signer_setup_is_first_user: Option<bool>,
}

Fields

role: ApiUserRole

name: String

User Name

csr_pem: String

API requests are authenticated by providing in each request: a. API Key in the X-API-Key header b. Auth header - Authorization: Bearer <JWT> while the JWT is signed with an RSA 4096 private key. When creating a new API Key, you need to generate an RSA 4096 private key and a CSR file. The CSR file is uploaded to Fireblocks upon the user creation and used later on for signature validation (Auth JWT signature validation). For more info read the following article

co_signer_setup_type: Option<CoSignerSetupType>

Required for Signer/Admin API users that planned to be paired with an API Co-Signer Machine. - SGX_MACHINE: For SGX enabled servers - FIREBLOCKS_CCMT: Fireblocks Communal Co-Signer (for Testnet workspaces only) - NITRO_MACHINE: For AWS Nitro Enclave enabled servers For more information about Fireblocks Co-Signer setup please read the following article.

co_signer_setup_is_first_user: Option<bool>

Pass as `true`` if this is the first user on the your Co-Signer machine

Implementations

impl CreateApiUser

pub fn new(role: ApiUserRole, name: String, csr_pem: String) -> CreateApiUser

Trait Implementations

impl Clone for CreateApiUser

fn clone(&self) -> CreateApiUser

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateApiUser

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

Formats the value using the given formatter.

impl Default for CreateApiUser

fn default() -> CreateApiUser

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateApiUser

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateApiUser

fn eq(&self, other: &CreateApiUser) -> 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 CreateApiUser

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateApiUser