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

x/windmill/windmill-api/GroupApi.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

.GroupApi

All URIs are relative to /api

Method HTTP request Description
addUserToGroup POST /w/{workspace}/groups/adduser/{name} add user to group
createGroup POST /w/{workspace}/groups/create create group
deleteGroup DELETE /w/{workspace}/groups/delete/{name} delete group
getGroup GET /w/{workspace}/groups/get/{name} get group
listGroupNames GET /w/{workspace}/groups/listnames list group names
listGroups GET /w/{workspace}/groups/list list groups
removeUserToGroup POST /w/{workspace}/groups/removeuser/{name} remove user to group
updateGroup POST /w/{workspace}/groups/update/{name} update group

addUserToGroup

string addUserToGroup(inlineObject21)

Example

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

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

let body:.GroupApiAddUserToGroupRequest = {
  // string
  workspace: "workspace_example",
  // string
  name: "name_example",
  // InlineObject21
  inlineObject21: {
    username: "username_example",
  },
};

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

Parameters

Name Type Description Notes
inlineObject21 InlineObject21
workspace [string] defaults to undefined
name [string] defaults to undefined

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 user added to group -

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

createGroup

string createGroup(inlineObject19)

Example

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

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

let body:.GroupApiCreateGroupRequest = {
  // string
  workspace: "workspace_example",
  // InlineObject19
  inlineObject19: {
    name: "name_example",
    summary: "summary_example",
  },
};

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

Parameters

Name Type Description Notes
inlineObject19 InlineObject19
workspace [string] defaults to undefined

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 group created -

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

deleteGroup

string deleteGroup()

Example

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

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

let body:.GroupApiDeleteGroupRequest = {
  // string
  workspace: "workspace_example",
  // string
  name: "name_example",
};

apiInstance.deleteGroup(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
name [string] defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 group deleted -

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

getGroup

Group getGroup()

Example

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

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

let body:.GroupApiGetGroupRequest = {
  // string
  workspace: "workspace_example",
  // string
  name: "name_example",
};

apiInstance.getGroup(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
name [string] defaults to undefined

Return type

Group

Authorization

bearerAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 group -

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

listGroupNames

Array listGroupNames()

Example

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

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

let body:.GroupApiListGroupNamesRequest = {
  // string
  workspace: "workspace_example",
};

apiInstance.listGroupNames(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

Return type

Array

Authorization

bearerAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 group list -

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

listGroups

Array listGroups()

Example

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

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

let body:.GroupApiListGroupsRequest = {
  // string
  workspace: "workspace_example",
  // number | which page to return (start at 1, default 1) (optional)
  page: 1,
  // number | number of items to return for a given page (default 30, max 100) (optional)
  perPage: 1,
};

apiInstance.listGroups(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
page [number] which page to return (start at 1, default 1) (optional) defaults to undefined
perPage [number] number of items to return for a given page (default 30, max 100) (optional) defaults to undefined

Return type

Array

Authorization

bearerAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 group list -

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

removeUserToGroup

string removeUserToGroup(inlineObject22)

Example

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

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

let body:.GroupApiRemoveUserToGroupRequest = {
  // string
  workspace: "workspace_example",
  // string
  name: "name_example",
  // InlineObject22
  inlineObject22: {
    username: "username_example",
  },
};

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

Parameters

Name Type Description Notes
inlineObject22 InlineObject22
workspace [string] defaults to undefined
name [string] defaults to undefined

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 user removed from group -

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

updateGroup

string updateGroup(inlineObject20)

Example

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

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

let body:.GroupApiUpdateGroupRequest = {
  // string
  workspace: "workspace_example",
  // string
  name: "name_example",
  // InlineObject20
  inlineObject20: {
    summary: "summary_example",
  },
};

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

Parameters

Name Type Description Notes
inlineObject20 InlineObject20
workspace [string] defaults to undefined
name [string] defaults to undefined

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 group updated -

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