Skip to main content

ApiScopeInfo

Struct ApiScopeInfo 

Source
pub struct ApiScopeInfo {
    pub access: Option<ApiScopeAccess>,
    pub description: Option<String>,
    pub name: Option<String>,
    pub resource: Option<String>,
    pub scope: Option<Scope>,
}
Expand description

ApiScopeInfo : One scope for people and agents choosing scopes.

Fields§

§access: Option<ApiScopeAccess>

Whether the scope reads or writes the resource.

§description: Option<String>

What the scope allows.

§name: Option<String>

The scope string as it appears in OAuth grants and error messages (e.g. links:read).

§resource: Option<String>

The resource the scope covers (e.g. links).

§scope: Option<Scope>

The scope. - API_SCOPE_UNSPECIFIED: Not a scope. Rejected wherever a scope is expected. - API_SCOPE_LINKS_READ: Read links, their QR code images, tags, folders and link settings. - API_SCOPE_LINKS_WRITE: Create, update and delete links, tags, folders and link settings. - API_SCOPE_WORKFLOWS_READ: Read the workflow steps behind a link and validate them. - API_SCOPE_WORKFLOWS_WRITE: Create, connect, update, lay out and delete workflow steps. - API_SCOPE_QRCODES_READ: Read QR code designs and QR code templates. - API_SCOPE_QRCODES_WRITE: Change QR code designs and create, publish and delete QR code templates. - API_SCOPE_PAGE_THEMES_READ: Read page themes and page theme templates. - API_SCOPE_PAGE_THEMES_WRITE: Change page themes and create, publish and delete page theme templates. - API_SCOPE_MEDIA_READ: Read uploaded media. - API_SCOPE_MEDIA_WRITE: Upload and delete media. - API_SCOPE_DOMAINS_READ: Read custom domains and their DNS instructions. - API_SCOPE_DOMAINS_WRITE: Add, verify, update and delete custom domains. - API_SCOPE_VISITORS_READ: Read and search visitors and their attributes. - API_SCOPE_VISITORS_WRITE: Identify, update and delete visitors and their attributes. - API_SCOPE_ANALYTICS_READ: Read events, metrics, time series, analytics data and dashboards. - API_SCOPE_ANALYTICS_WRITE: Create, update and delete analytics dashboards and generate widget summaries. - API_SCOPE_WEBHOOKS_READ: Read webhooks. - API_SCOPE_WEBHOOKS_WRITE: Create, update and delete webhooks. - API_SCOPE_INTEGRATIONS_READ: Read the Slack and Google Forms integrations. - API_SCOPE_INTEGRATIONS_WRITE: Connect, configure, test, sync and disconnect the Slack and Google Forms integrations. - API_SCOPE_WORKSPACE_READ: Read the workspace and its settings. - API_SCOPE_WORKSPACE_WRITE: Update the workspace, request enrollment and delete the workspace. - API_SCOPE_MEMBERS_READ: Read workspace members. - API_SCOPE_MEMBERS_WRITE: Update, revoke, sign out and remove members. Inviting a member or changing a sign-in email or password needs full access. - API_SCOPE_TOKENS_READ: Read API tokens and their scopes, never their secrets. - API_SCOPE_TOKENS_WRITE: Create, update and delete API tokens, limited to the scopes the calling token holds. - API_SCOPE_BILLING_WRITE: Open checkout, credit top-up and billing portal sessions. - API_SCOPE_ASSISTANT_READ: Read the Assistant conversation. - API_SCOPE_ASSISTANT_WRITE: Send files to the Assistant, clear the conversation and contact support. - API_SCOPE_AGENTS_READ: Read agents and their knowledge documents. - API_SCOPE_AGENTS_WRITE: Create, update and delete agents and their knowledge documents.

Implementations§

Source§

impl ApiScopeInfo

Source

pub fn new() -> ApiScopeInfo

One scope for people and agents choosing scopes.

Trait Implementations§

Source§

impl Clone for ApiScopeInfo

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ApiScopeInfo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ApiScopeInfo

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ApiScopeInfo

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ApiScopeInfo

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ApiScopeInfo

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ApiScopeInfo

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more