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/AdminEndpointsApi.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

10 KiB
Raw Blame History

AdminEndpointsApi

All URIs are relative to /activiti-app/api

Method HTTP request Description
createBasicAuthConfiguration POST /enterprise/admin/basic-auths Add an endpoint authorization
createEndpointConfiguration POST /enterprise/admin/endpoints Create an endpoint
getBasicAuthConfiguration GET /enterprise/admin/basic-auths/{basicAuthId} Get an endpoint authorization
getBasicAuthConfigurations GET /enterprise/admin/basic-auths List endpoint authorizations
getEndpointConfiguration GET /enterprise/admin/endpoints/{endpointConfigurationId} Get an endpoint
getEndpointConfigurations GET /enterprise/admin/endpoints List endpoints
removeBasicAuthConfiguration DELETE /enterprise/admin/basic-auths/{basicAuthId} Delete an endpoint authorization
removeEndpointConfiguration DELETE /enterprise/admin/endpoints/{endpointConfigurationId} Delete an endpoint
updateBasicAuthConfiguration PUT /enterprise/admin/basic-auths/{basicAuthId} Update an endpoint authorization
updateEndpointConfiguration PUT /enterprise/admin/endpoints/{endpointConfigurationId} Update an endpoint

createBasicAuthConfiguration

Add an endpoint authorization

Parameters

Name Type
createRepresentation CreateEndpointBasicAuthRepresentation

Return type: EndpointBasicAuthRepresentation

Example

import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const createRepresentation = {};

adminEndpointsApi.createBasicAuthConfiguration(createRepresentation).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
});

createEndpointConfiguration

Create an endpoint

Parameters

Name Type
representation EndpointConfigurationRepresentation

Return type: EndpointConfigurationRepresentation

Example

import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const representation = {};

adminEndpointsApi.createEndpointConfiguration(representation).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
});

getBasicAuthConfiguration

Get an endpoint authorization

Parameters

Name Type Description
basicAuthId number basicAuthId
tenantId number tenantId

Return type: EndpointBasicAuthRepresentation

Example

import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const authId = 0;
const tenantId = 0;

adminEndpointsApi.getBasicAuthConfiguration(authId, tenantId).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
});

getBasicAuthConfigurations

List endpoint authorizations

Parameters

Name Type
tenantId number

Return type: EndpointBasicAuthRepresentation

Example

import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const tenantId = 0;

adminEndpointsApi.getBasicAuthConfigurations(tenantId).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
});

getEndpointConfiguration

Get an endpoint

Parameters

Name Type
endpointConfigurationId number
tenantId number

Return type: EndpointConfigurationRepresentation

Example

import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const endpointConfigurationId = 0;
const tenantId = 0;

adminEndpointsApi.getEndpointConfiguration(endpointConfigurationId, tenantId).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
});

getEndpointConfigurations

List endpoints

Parameters

Name Type
tenantId number

Return type: EndpointConfigurationRepresentation

Example

import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const tenantId = 0;

adminEndpointsApi.getEndpointConfigurations(tenantId).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
});

removeBasicAuthConfiguration

Delete an endpoint authorization

Parameters

Name Type
basicAuthId number
tenantId number

Example

import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const basicAuthId = 0;
const tenantId = 0;

adminEndpointsApi.removeBasicAuthConfiguration(basicAuthId, tenantId).then(() => {
    console.log('API called successfully.');
});

removeEndpointConfiguration

Delete an endpoint

Parameters

Name Type
endpointConfigurationId number
tenantId number

Example

import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const endpointConfigurationId = 0;
const tenantId = 0;

adminendpointsApi.removeEndpointConfiguration(endpointConfigurationId, tenantId).then(() => {
    console.log('API called successfully.');
});

updateBasicAuthConfiguration

Update an endpoint authorization

Parameters

Name Type
basicAuthId number
createRepresentation CreateEndpointBasicAuthRepresentation

Return type: EndpointBasicAuthRepresentation

Example

import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const basicAuthId = 0;
const createRepresentation = {};

adminEndpointsApi.updateBasicAuthConfiguration(basicAuthId, createRepresentation).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
});

updateEndpointConfiguration

Update an endpoint

Parameters

Name Type
endpointConfigurationId number
representation EndpointConfigurationRepresentation

Return type: EndpointConfigurationRepresentation

Example

import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const endpointConfigurationId = 0;
const representation = {};

adminendpointsApi.updateEndpointConfiguration(endpointConfigurationId, representation).then((data) => {
    console.log('API called successfully. Returned data: ' + data);
});

Models

CreateEndpointBasicAuthRepresentation

Properties

Name Type
name string
password string
tenantId number
username string

EndpointBasicAuthRepresentation

Properties

Name Type
created Date
id number
lastUpdated Date
name string
tenantId number
username string