Confluence Active Directory Group Sync REST API

Perform Sync

POST http://localhost:8090/rest/ldapgroupsync/1.0/utility/run/admin/sync

Required Schema Fields:

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]

$ curl -u username -XPOST -H "Content-Type: application/json" --data '{"adGroup": \
"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 ad group name.

Required Schema Fields:

adGroup (String)
directoryType (Number)
- 0 - LDAP
- 1 - Microsoft Azure AD
- 2 - Google G-Suite
- 3 - Okta
provisionUsers (Boolean)
dryRun (Boolean)

Response: [Status: 200]

$ curl -u username -XPOST -H "Content-Type: application/json" --data '{"adGroup": \
"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}
$

POST http://localhost:8090/rest/ldapgroupsync/1.0/utility/run/admin/config/id/{configId}

Path Parameters:

configId (Number) - AD Sync Map Config ID

Response: [Status: 200]

$ curl -u username -XPOST http://localhost:8090/rest/ldapgroupsync/1.0/utility/run/admin/config/id/6 \
-XPOST -H "Content-Type: application/json"
Enter host password for user 'username ':
{"message":"Successful, Update Size(9). Took 1.21 Seconds","id":0}
$