inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/lib/js-api/src/api/activiti-rest-api/docs/AdminUsersApi.md
Denys Vuika ea2c0ce229
[PRODENG-211] integrate JS-API with monorepo (part 1) (#9081) 
* integrate JS-API with monorepo

* [ci:force] fix token issue

[ci:force] migrate docs folder

[ci:force] clean personal tokens

* [ci:force] gha workflow support

* [ci:force] npm publish target

* fix js-api test linting

* [ci:force] fix test linting, mocks, https scheme

* [ci:force] fix https scheme

* [ci:force] typescript mappings

* [ci:force] update scripts

* lint fixes

* linting fixes

* fix linting

* [ci:force] linting fixes

* linting fixes

* [ci:force] remove js-api upstream and corresponding scripts

* [ci:force] jsdoc fixes

* fix jsdoc linting

* [ci:force] jsdoc fixes

* [ci:force] jsdoc fixes

* jsdoc fixes

* jsdoc fixes

* jsdoc fixes

* [ci:force] fix jsdoc

* [ci:force] reduce code duplication

* replace 'chai' expect with node.js assert

* replace 'chai' expect with node.js assert

* [ci:force] remove chai and chai-spies for js-api testing

* [ci:force] cleanup and fix imports

* [ci:force] fix linting

* [ci:force] fix unit test

* [ci:force] fix sonar linting findings

* [ci:force] switch activiti api models to interfaces (-2.5% reduction of bundle)

* [ci:force] switch activiti api models to interfaces

* [ci:force] switch AGS api models to interfaces

* [ci:force] switch AGS api models to interfaces

* [ci:force] switch search api models to interfaces

* [ci:force] switch content api models to interfaces where applicable
2023-11-21 05:27:51 -05:00

5.9 KiB
Raw Blame History

AdminusersApi

All URIs are relative to /activiti-app/api

Method HTTP request Description
bulkUpdateUsers PUT /enterprise/admin/users Bulk update a list of users
createNewUser POST /enterprise/admin/users Create a user
getUser GET /enterprise/admin/users/{userId} Get a user
getUsers GET /enterprise/admin/users Query users
updateUserDetails PUT /enterprise/admin/users/{userId} Update a user

bulkUpdateUsers

bulkUpdateUsers(update)

Bulk update a list of users

Example

import AdminusersApi from 'src/api/activiti-rest-api/docs/AdminUsersApi';
import {AlfrescoApi} from '@alfresco/js-api';

this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
    hostEcm: 'http://127.0.0.1:8080'
});

let adminusersApi = new AdminusersApi(this.alfrescoApi);


adminusersApi.bulkUpdateUsers(update).then(() => {
    console.log('API called successfully.');
}, function (error) {
    console.error(error);
});

Parameters

Name Type Description Notes
update BulkUserUpdateRepresentation update

Return type

null (empty response body)

createNewUser

UserRepresentation createNewUser(userRepresentation)

Create a user

Example

import AdminusersApi from 'src/api/activiti-rest-api/docs/AdminUsersApi';
import {AlfrescoApi} from '@alfresco/js-api';

this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
    hostEcm: 'http://127.0.0.1:8080'
});

let adminusersApi = new AdminusersApi(this.alfrescoApi);


adminusersApi.createNewUser(userRepresentation).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
}, function (error) {
    console.error(error);
});

Parameters

Name Type Description Notes
userRepresentation UserRepresentation userRepresentation

Return type

UserRepresentation

getUser

AbstractUserRepresentation getUser(userIdopts)

Get a user

Example

import AdminusersApi from 'src/api/activiti-rest-api/docs/AdminUsersApi';
import {AlfrescoApi} from '@alfresco/js-api';

this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
    hostEcm: 'http://127.0.0.1:8080'
});

let adminusersApi = new AdminusersApi(this.alfrescoApi);

let opts = {
    'summary': true //  | summary
};

adminusersApi.getUser(userIdopts).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
}, function (error) {
    console.error(error);
});

Parameters

Name Type Description Notes
userId number userId
summary boolean summary [optional]

Return type

AbstractUserRepresentation

getUsers

ResultListDataRepresentationAbstractUserRepresentation getUsers(opts)

Query users

Example

import AdminusersApi from 'src/api/activiti-rest-api/docs/AdminUsersApi';
import {AlfrescoApi} from '@alfresco/js-api';

this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
    hostEcm: 'http://127.0.0.1:8080'
});

let adminusersApi = new AdminusersApi(this.alfrescoApi);

let opts = {
    'filter': filter_example //  | filter
    'status': status_example //  | status
    'accountType': accountType_example //  | accountType
    'sort': sort_example //  | sort
    'company': company_example //  | company
    'start': 56 //  | start
    'page': 56 //  | page
    'size': 56 //  | size
    'groupId': 789 //  | groupId
    'tenantId': 789 //  | tenantId
    'summary': true //  | summary
};

adminusersApi.getUsers(opts).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
}, function (error) {
    console.error(error);
});

Parameters

Name Type Description Notes
filter string filter [optional]
status string status [optional]
accountType string accountType [optional]
sort string sort [optional]
company string company [optional]
start number start [optional]
page number page [optional]
size number size [optional]
groupId number groupId [optional]
tenantId number tenantId [optional]
summary boolean summary [optional]

Return type

ResultListDataRepresentationAbstractUserRepresentation

updateUserDetails

updateUserDetails(userIduserRepresentation)

Update a user

Example

import AdminusersApi from 'src/api/activiti-rest-api/docs/AdminUsersApi';
import {AlfrescoApi} from '@alfresco/js-api';

this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
    hostEcm: 'http://127.0.0.1:8080'
});

let adminusersApi = new AdminusersApi(this.alfrescoApi);


adminusersApi.updateUserDetails(userIduserRepresentation).then(() => {
    console.log('API called successfully.');
}, function (error) {
    console.error(error);
});

Parameters

Name Type Description Notes
userId number userId
userRepresentation UserRepresentation userRepresentation

Return type

null (empty response body)