alfresco-ng2-components/lib/js-api/src/api/auth-rest-api/docs/AuthenticationApi.md

AuthenticationApi

All URIs are relative to https://localhost/alfresco/api/-default-/public/authentication/versions/1

Method	HTTP request	Description
createTicket	POST /tickets	Create ticket (login)
deleteTicket	DELETE /tickets/-me-	Delete ticket (logout)
validateTicket	GET /tickets/-me-	Validate ticket

createTicket

TicketEntry createTicket(ticketBodyCreate)

Create ticket (login)

Note: this endpoint is available in Alfresco 5.2 and newer versions.

Logs in and returns the new authentication ticket.

The userId and password properties are mandatory in the request body. For example: JSON { "userId": "jbloggs", "password": "password" }

To use the ticket in future requests you should pass it in the request header. For example using Javascript: Javascript request.setRequestHeader ("Authorization", "Basic " + btoa(ticket));

Example

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

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

const authenticationApi = new AuthenticationApi(alfrescoApi);


authenticationApi.createTicket(ticketBodyCreate).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
ticketBodyCreate	TicketBody	The user credential.

Return type

TicketEntry

deleteTicket

deleteTicket()

Delete ticket (logout)

Note: this endpoint is available in Alfresco 5.2 and newer versions.

Deletes logged in ticket (logout).

Example

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

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

const authenticationApi = new AuthenticationApi(alfrescoApi);

authenticationApi.deleteTicket().then(() => {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

validateTicket

ValidTicketEntry validateTicket()

Validate ticket

Note: this endpoint is available in Alfresco 5.2 and newer versions.

Validates the specified ticket (derived from Authorization header) is still valid.

For example, you can pass the Authorization request header using Javascript: Javascript request.setRequestHeader ("Authorization", "Basic " + btoa(ticket));

Example

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

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

const authenticationApi = new AuthenticationApi(alfrescoApi);

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

Parameters

This endpoint does not need any parameter.

Return type

ValidTicketEntry