This page has REST API details for Jira Active Directory Group Sync Plugin.
Table of Contents |
---|
Get Admin Active Directory Configuration
GET http://localhost:8080/rest/adgroupsync/1.0/utility/admin/ad/configuration
Response: [Status: 200]
Code Block |
---|
$ curl -u superadmin -XGET http://localhost:8080/rest/adgroupsync/1.0/utility/admin/ad/configuration Enter host password for user 'superadmin': {"ldapUrl":"ldaps://server","securityPrincipal":"user","securityPassword":"secret","groupSearchFilter":"(&(objectClass=*)(sAMAccountName={0}))",\ "groupMemberSearchFilter":"(&(objectClass=*)(memberOf={0}))","userMemberSearchFilter":"(&(objectClass=*)(memberOf={0}))",\ "userAttr":"sAMAccountName","baseDn":"DC=ad,DC=example,DC=com"} $ |
Get Auto Sync Configurations
GET http://localhost:8080/rest/adgroupsync/1.0/utility/list/admin/config
Response: [Status: 200]
Code Block |
---|
$ curl -u superadmin -XGET http://localhost:8080/rest/adgroupsync/1.0/utility/list/admin/config Enter host password for user 'superadmin': [{"id":1,"adGroup":"engineering.systems.and.infrastructure","jiraGroup":"engineering.systems.and.infrastructure","actionType":0}] $ |
Add Auto Sync Configuration
POST http://localhost:8080/rest/adgroupsync/1.0/utility/add/admin/config
Response: [Status: 200]
Delete Auto Sync Configuration
DELETE http://localhost:8080/rest/adgroupsync/1.0/utility/remove/admin/config/id/{configId}
Perform Sync By Admin
POST http://localhost:8080/rest/adgroupsync/1.0/utility/run/admin/sync
Required Schema Fields:
- adGroup (String)
- jiraGroup (String)
Response: [Status: 200]
Code Block |
---|
$ curl -u superadmin -XPOST -H "Content-Type: application/json" --data '{"adGroup":"engineering.systems.and.infrastructure",\ "jiraGroup":"engineering.systems.and.infrastructure"}' \ http://localhost:8080/rest/adgroupsync/1.0/utility/run/admin/sync Enter host password for user 'superadmin': {"message":"Sync Successful, Update Size ( 6 ). Took 2.84 Seconds","id":6} $ |
Perform Sync By User
POST http://localhost:8080/rest/adgroupsync/1.0/utility/run/user/sync
Same as above but this endpoint can execute any Jira user, it will create Jira group name same as ldap or Ad group name.
Required Schema Fields:
- adGroup (String)
- addAutoSync (Integer) ~ OPTIONAL
- Set 1 to add auto sync configuration
Response: [Status: 200]
Code Block |
---|
$ curl -u superadmin -XPOST -H "Content-Type: application/json" --data '{"adGroup":"engineering.systems.and.infrastructure"}'\ http://localhost:8080/rest/adgroupsync/1.0/utility/run/user/sync Enter host password for user 'superadmin': {"message":"Sync Successful, Update Size ( 6 ). Took 2.84 Seconds","id":6} $ |
Perform Sync By Auto Sync Config ID
POST http://localhost:8080/rest/adgroupsync/1.0/utility/run/admin/config/id/{configId}
Query Parameters:
- configId (Number) - AD Auto Sync Config ID
Response: [Status: 200]
Code Block |
---|
$ curl -u superadmin -XPOST http://localhost:8080/rest/adgroupsync/1.0/utility/run/admin/config/id/1 Enter host password for user 'superadmin': {"message":"Sync Successful, Update Size ( 6 ). Took 2.91 Seconds","id":6} $ |
Perform Sync for All Auto Sync Configurations
POST http://localhost:8080/rest/adgroupsync/1.0/utility/run/all/sync
Response: [Status: 200]