Struct EndpointOAuthGitHub

pub struct EndpointOAuthGitHub {
    pub client_id: Option<String>,
    pub client_secret: Option<String>,
    pub scopes: Option<Vec<String>>,
    pub email_addresses: Option<Vec<String>>,
    pub email_domains: Option<Vec<String>>,
    pub teams: Option<Vec<String>>,
    pub organizations: Option<Vec<String>>,
}

Fields

client_id: Option<String>

the OAuth app client ID. retrieve it from the identity provider’s dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well.

client_secret: Option<String>

the OAuth app client secret. retrieve if from the identity provider’s dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for client_id.

scopes: Option<Vec<String>>

a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)

email_addresses: Option<Vec<String>>

a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint

email_domains: Option<Vec<String>>

a list of email domains of users authenticated by identity provider who are allowed access to the endpoint

teams: Option<Vec<String>>

a list of github teams identifiers. users will be allowed access to the endpoint if they are a member of any of these teams. identifiers should be in the ‘slug’ format qualified with the org name, e.g. org-name/team-name

organizations: Option<Vec<String>>

a list of github org identifiers. users who are members of any of the listed organizations will be allowed access. identifiers should be the organization’s ‘slug’

Trait Implementations

impl Clone for EndpointOAuthGitHub

fn clone(&self) -> EndpointOAuthGitHub

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointOAuthGitHub

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

Formats the value using the given formatter.

impl Default for EndpointOAuthGitHub

fn default() -> EndpointOAuthGitHub

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EndpointOAuthGitHub

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EndpointOAuthGitHub

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

where __S: Serializer,

Serialize this value into the given Serde serializer.