Skip to content

Commit 985e69a

Browse files
committed
update README
1 parent ff5faab commit 985e69a

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,40 @@ This a plugin for LSC, using Microsoft Graph API
99
The object of this plugin is to synchronize users from a Microsoft Azure active directory to a referential.
1010
For example it can be used to synchronize the users in an Azure AD to an LDAP repository.
1111

12-
### Architecture
12+
### Configuration
1313

14-
WIP
14+
The plugin connects to Microsoft Graph API as a [deamon app](https://docs.microsoft.com/en-us/azure/active-directory/develop/scenario-daemon-overview). More information on how to register it on Microsoft Azure can
15+
be found [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/scenario-daemon-app-registration).
1516

16-
### Configuration
17+
The application must have the `Application permission` `User.Read.All` permission granted. The documentation about permissions and consent can be found [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-permissions-and-consent).
1718

18-
WIP
19+
At the time being the plugin only allows to connect to the API using a client secret.
1920

2021
### Usage
2122

22-
WIP
23+
There are examples of configuration in the `sample` directory. The `lsc.xml` file describes a synchronization from Microsoft Graph API to an LDAP repository.
24+
25+
The values to configure are:
26+
27+
#### Source service
28+
29+
##### Connection
30+
31+
- `connections.pluginConnection.msGraphApiConnectionSettings.clientId`: The client id for the application
32+
- `connections.pluginConnection.msGraphApiConnectionSettings.clientSecret`: The client secret used to connect to the application
33+
- `connections.pluginConnection.msGraphApiConnectionSettings.tenant`: The Azure AD tenant
34+
35+
##### API parameters
36+
37+
- `tasks.task.pluginSourceService.filter`: (Optional, default none) The filter to use for fetching the list of pivots. For the syntax to use in those filters the syntax can be found [here](https://docs.microsoft.com/en-us/graph/query-parameters#filter-parameter).
38+
- `tasks.task.pluginSourceService.pivot`: (Optional, default `mail`) The field to use as pivot.
39+
- `tasks.task.pluginSourceService.pageSize`: (Optional, default none) The page size used to paginate the results from the graph API. Default is no page size, but the API has a `100` default page size.
40+
- `tasks.task.pluginSourceService.select`: (Optional, default none) The comma separated list of fields to gather when getting the details of a user. The syntax to use can be found [here](https://docs.microsoft.com/en-us/graph/query-parameters#select-parameter). By default the API returns a default set of properties.
2341

42+
The jar of the Microsoft graph API LSC plugin must be copied in the `lib` directory of your LSC installation. Then you can launch it with the following command line:
43+
```
44+
`̀`` JAVA_OPTS="-DLSC.PLUGINS.PACKAGEPATH=org.lsc.plugins.connectors.msgraphapi.generated" bin/lsc --config /path/to/sample/msgraphapi-to-ldap/ --synchronize users --clean users --threads 5
45+
```
2446
### Packaging
2547

2648
WIP

0 commit comments

Comments
 (0)