Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/windmill/windmill-api/GranularAclApi.md

Windmill deno client (separated from the main repo because most of the code is auto-generated from the openapi and not worth committing)
Go to Latest
File

.GranularAclApi

All URIs are relative to /api

Method HTTP request Description
addGranularAcls POST /w/{workspace}/acls/add/{kind}/{path} add granular acls
getGranularAcls GET /w/{workspace}/acls/get/{kind}/{path} get granular acls
removeGranularAcls POST /w/{workspace}/acls/remove/{kind}/{path} remove granular acls

addGranularAcls

string addGranularAcls(inlineObject23)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .GranularAclApi(configuration);

let body:.GranularAclApiAddGranularAclsRequest = {
  // string
  workspace: "workspace_example",
  // string
  path: "path_example",
  // 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow'
  kind: "script",
  // InlineObject23
  inlineObject23: {
    owner: "owner_example",
    write: true,
  },
};

apiInstance.addGranularAcls(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
inlineObject23 InlineObject23
workspace [string] defaults to undefined
path [string] defaults to undefined
kind [**'script' 'group_' 'resource'

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 granular acl added -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGranularAcls

{ [key: string]: boolean; } getGranularAcls()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .GranularAclApi(configuration);

let body:.GranularAclApiGetGranularAclsRequest = {
  // string
  workspace: "workspace_example",
  // string
  path: "path_example",
  // 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow'
  kind: "script",
};

apiInstance.getGranularAcls(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
path [string] defaults to undefined
kind [**'script' 'group_' 'resource'

Return type

{ [key: string]: boolean; }

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 acls -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeGranularAcls

string removeGranularAcls(inlineObject24)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .GranularAclApi(configuration);

let body:.GranularAclApiRemoveGranularAclsRequest = {
  // string
  workspace: "workspace_example",
  // string
  path: "path_example",
  // 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow'
  kind: "script",
  // InlineObject24
  inlineObject24: {
    owner: "owner_example",
  },
};

apiInstance.removeGranularAcls(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
inlineObject24 InlineObject24
workspace [string] defaults to undefined
path [string] defaults to undefined
kind [**'script' 'group_' 'resource'

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 granular acl removed -

[Back to top] [Back to API list] [Back to Model list] [Back to README]