Type Alias SetUserApiKeyRequest

SetUserApiKeyRequest: {
    dataset_ids?: string[] | null;
    name: string;
    organization_ids?: string[] | null;
    role: number;
    scopes?: string[] | null;
}

Type declaration

  • Optionaldataset_ids?: string[] | null

    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.

  • Optionalorganization_ids?: string[] | null

    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: number

    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.

  • Optionalscopes?: string[] | null

    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"].

Settings

Member Visibility