Struct SetUserApiKeyRequest

pub struct SetUserApiKeyRequest {
    pub dataset_ids: Option<Option<Vec<Uuid>>>,
    pub name: String,
    pub organization_ids: Option<Option<Vec<Uuid>>>,
    pub role: i32,
    pub scopes: Option<Option<Vec<String>>>,
}

Fields

dataset_ids: Option<Option<Vec<Uuid>>>

The dataset ids which the api key will have access to. If not provided or empty, the api key will have access to all datasets the auth’ed user has access to. If both dataset_ids and organization_ids are provided, the api key will have access to the intersection of the datasets and organizations.

name: String

The name which will be assigned to the new api key.

organization_ids: Option<Option<Vec<Uuid>>>

The organization ids which the api key will have access to. If not provided or empty, the api key will have access to all organizations the auth’ed user has access to.

role: i32

The role which will be assigned to the new api key. Either 0 (read), 1 (read and write at the level of the currently auth’ed user). The auth’ed user must have a role greater than or equal to the role being assigned which means they must be an admin (1) or owner (2) of the organization to assign write permissions with a role of 1.

scopes: Option<Option<Vec<String>>>

The routes which the api key will have access to. If not provided or empty, the api key will have access to all routes the auth’ed user has access to. Specify the routes as a list of strings. For example, ["GET /api/dataset", "POST /api/dataset"].

Implementations

impl SetUserApiKeyRequest

pub fn new(name: String, role: i32) -> SetUserApiKeyRequest

Trait Implementations

impl Clone for SetUserApiKeyRequest

fn clone(&self) -> SetUserApiKeyRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SetUserApiKeyRequest

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

Formats the value using the given formatter.

impl Default for SetUserApiKeyRequest

fn default() -> SetUserApiKeyRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SetUserApiKeyRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SetUserApiKeyRequest

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

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 SetUserApiKeyRequest