Interface Resource

interface Resource {
    id?: string;
    name?: string;
    org?: string;
    orgID?: string;
    type:
        | "authorizations"
        | "buckets"
        | "dashboards"
        | "orgs"
        | "sources"
        | "tasks"
        | "telegrafs"
        | "users"
        | "variables"
        | "scrapers"
        | "secrets"
        | "labels"
        | "views"
        | "documents"
        | "notificationRules"
        | "notificationEndpoints"
        | "checks"
        | "dbrp"
        | "notebooks"
        | "annotations"
        | "remotes"
        | "replications"
        | "instance"
        | "flows"
        | "functions";
}

Properties

id? name? org? orgID? type

Properties

Optionalid

id?: string

The ID of a specific resource. In a permission, applies the permission to only the resource with this ID.

Optionalname

name?: string

Optional: A name for the resource. Not all resource types have a name field.

Optionalorg

org?: string

Optional: The name of the organization with orgID.

OptionalorgID

orgID?: string

The ID of the organization that owns the resource. In a permission, applies the permission to all resources of type owned by this organization.

type

type:
    | "authorizations"
    | "buckets"
    | "dashboards"
    | "orgs"
    | "sources"
    | "tasks"
    | "telegrafs"
    | "users"
    | "variables"
    | "scrapers"
    | "secrets"
    | "labels"
    | "views"
    | "documents"
    | "notificationRules"
    | "notificationEndpoints"
    | "checks"
    | "dbrp"
    | "notebooks"
    | "annotations"
    | "remotes"
    | "replications"
    | "instance"
    | "flows"
    | "functions"

The type of resource. In a permission, applies the permission to all resources of this type.

Settings

Member Visibility

On This Page

Properties