Struct SSHCredentialCreate

pub struct SSHCredentialCreate {
    pub description: String,
    pub metadata: String,
    pub acl: Vec<String>,
    pub public_key: String,
    pub owner_id: Option<String>,
}

Fields

description: String

human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.

metadata: String

arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.

acl: Vec<String>

optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of bind:*=example which will allow x=example, y=example, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.

public_key: String

the PEM-encoded public key of the SSH keypair that will be used to authenticate

owner_id: Option<String>

If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.

Trait Implementations

impl Clone for SSHCredentialCreate

fn clone(&self) -> SSHCredentialCreate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SSHCredentialCreate

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

Formats the value using the given formatter.

impl Default for SSHCredentialCreate

fn default() -> SSHCredentialCreate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SSHCredentialCreate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SSHCredentialCreate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.