Auto Sync Configurations
GET http://localhost:8090/rest/ldapgroupsync/1.0/utility/admin/config/list
| Code Block |
|---|
$ curl -u username -XGET http://localhost:8090/rest/ldapgroupsync/1.0/utility/admin/config/list
Enter host password for user 'username ':
[{"configId":3,"ldapGroup":"scm.engineers","confluenceGroup":"scm.engineers"}]
$ |
Perform Sync
POST http://localhost:8090/rest/ldapgroupsync/1.0/utility/run/admin/sync
Required Schema Fields:
- ldapGroup adGroup (String)
- confluenceGroup (String)
- directoryType (Number)
- 0 - LDAP
- 1 - Microsoft Azure AD
- 2 - Google G-Suite
- 3 - Okta
- provisionUsers (Boolean)
- dryRun (Boolean)
Response: [Status: 200]
| Code Block |
|---|
$ curl -u username -XPOST -H "Content-Type: application/json" --data '{"ldapGroupadGroup": \
"scm.engineers","confluenceGroup": "scm.engineers"}' http://localhost:8090/rest/ldapgroupsync\
/1.0/utility/run/admin/sync
Enter host password for user 'username ':
{"message":"Sync Successful, Update Size ( 2 ). Took 2.86 Seconds","id":0}
$ |
Self Service Endpoint API
POST http://localhost:8090/rest/ldapgroupsync/1.0/utility/run/user/sync
Same as above but this endpoint can execute any confluence user, it will create confluence group name same as ldap ad group name.
Required Schema Fields:
- ldapGroup adGroup (String)
- directoryType (Number)
- 0 - LDAP
- 1 - Microsoft Azure AD
- 2 - Google G-Suite
- 3 - Okta
- provisionUsers (Boolean)
- dryRun (Boolean)
Response: [Status: 200]
| Code Block |
|---|
$ curl -u username -XPOST -H "Content-Type: application/json" --data '{"ldapGroupadGroup": \
"scm.engineers"}' http://localhost:8090/rest/ldapgroupsync/1.0/utility/run/admin/sync
Enter host password for user 'username ':
{"message":"Sync Successful, Update Size ( 2 ). Took 2.86 Seconds","id":0}
$ |
...
Path Parameters:
- configId (Number) - LDAP AD Sync Map Config ID
Response: [Status: 200]
...