mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2026-09-09 18:03:21 +00:00
[ACS-9980] Add SSO integration API (#11297)
* [ACS-9980] Add SSO integration API * [ACS-9980] CR fixes * [ACS-9980] CR fix
This commit is contained in:
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountUsername** | **string** | | [optional] [default to null]
|
||||
**alfrescoTenantId** | **string** | | [optional] [default to null]
|
||||
**authenticationType** | **string** | | [optional] [default to null]
|
||||
**created** | [**Date**](Date.md) | | [optional] [default to null]
|
||||
**id** | **number** | | [optional] [default to null]
|
||||
**lastUpdated** | [**Date**](Date.md) | | [optional] [default to null]
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
# IntegrationSSOApi
|
||||
|
||||
All URIs are relative to */activiti-app/api*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
|------------------------------------------------------------------------ | -------------------------------------------------------------- | ----------------------|
|
||||
| [**getAccountInformation**](#getAccountInformation) | **GET** /api/enterprise/integration/sso/{repositoryId}/account | Get account information |
|
||||
|
||||
|
||||
## getAccountInformation
|
||||
|
||||
Returns account information.
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, IntegrationSSOApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let integrationSSOApi = new IntegrationSSOApi(this.alfrescoApi);
|
||||
|
||||
integrationSSOApi.getAccountInformation('1').then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
| Name | Type | Description | Notes |
|
||||
|----------------- | ---------- | ------------------------------------------------- | ----- |
|
||||
| **repositoryId** | **string** | Alfresco Repository instance ID configured in APS | |
|
||||
|
||||
### Return type
|
||||
|
||||
`Promise<SSOUserAccountCredentialsRepresentation>`
|
||||
@@ -0,0 +1,10 @@
|
||||
# SSOUserAccountCredentialsRepresentation
|
||||
|
||||
## Properties
|
||||
| Name | Type | Description | Notes |
|
||||
|---------------------- | ---------- | ------------------------------------------------------------------------------ | ----- |
|
||||
| **authenticationURL** | **string** | Authentication URL that can be used to establish a session between IdP and APS | |
|
||||
| **expireDate** | **Date** | APS token expiry date | |
|
||||
| **name** | **string** | User account name | |
|
||||
| **ownerEmail** | **string** | User account owner email | |
|
||||
| **repositoryId** | **number** | Alfresco repository ID | |
|
||||
Reference in New Issue
Block a user