Struct pachyderm::auth::ActivateRequest

pub struct ActivateRequest {
    pub subject: String,
    pub github_token: String,
}

ActivateRequest mirrors AuthenticateRequest. The caller is authenticated via GitHub OAuth, and then promoted to the cluster's first Admin. Afterwards, the caller can promote other users to Admin and remove themselves

Fields

subject: String

If set, Pachyderm will authenticate the caller as this user.

• If set to a github user (i.e. it has a 'github:' prefix or no prefix) then Pachyderm will confirm that it matches the user associated with 'github_token'
• If set to a robot user (i.e. it has a 'robot:' prefix), then Pachyderm will generate a new token for the robot user; this token will be the only way to administer this cluster until more admins are added.

github_token: String

This is the token returned by GitHub and used to authenticate the caller. When Pachyderm is deployed locally, setting this value to a given string will automatically authenticate the caller as a GitHub user whose username is that string (unless this "looks like" a GitHub access code, in which case Pachyderm does retrieve the corresponding GitHub username)

Trait Implementations

impl Clone for ActivateRequest

fn clone(&self) -> ActivateRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ActivateRequest

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

Formats the value using the given formatter.

impl Default for ActivateRequest

fn default() -> ActivateRequest

Returns the "default value" for a type.

impl Message for ActivateRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<ActivateRequest> for ActivateRequest

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

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

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

This method tests for !=.

impl StructuralPartialEq for ActivateRequest