Jira Server - Okta Groups Sync - REST API

This page has REST API details for Jira Okta Group Sync Plugin.

Get Auto Sync Configurations

GET http://localhost:8080/rest/oktagroupsync/1.0/utility/run/list/config

Response: [Status: 200]

$ curl -u superadmin -XGET http://localhost:8080/rest/oktagroupsync/1.0/utility/run/list/config
Enter host password for user 'superadmin':
[{"id":1,"oktaGroup":"engineering.systems.and.infrastructure","jiraGroup":"engineering.systems.and.infrastructure","actionType":0}]
$

Perform Sync By Admin

POST http://localhost:8080/rest/oktagroupsync/1.0/utility/run/admin/sync

Required Schema Fields:

oktaGroup (String)
jiraGroup (String)

Response: [Status: 200]

$ curl -u superadmin -XPOST -H "Content-Type: application/json" --data '{"oktaGroup":"engineering.systems.and.infrastructure",\
"jiraGroup":"engineering.systems.and.infrastructure"}' \
http://localhost:8080/rest/oktagroupsync/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/oktagroupsync/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 Okta group name.

Required Schema Fields:

oktaGroup (String)

Response: [Status: 200]

$ curl -u superadmin -XPOST -H "Content-Type: application/json" --data '{"oktaGroup":"engineering.systems.and.infrastructure"}'\
http://localhost:8080/rest/oktagroupsync/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 Config ID

POST http://localhost:8080/rest/oktagroupsync/1.0/utility/run/admin/sync/config/id/{configId}

Query Parameters:

configId (Number) - Okta Auto Sync Config ID

Response: [Status: 200]

$ curl -u superadmin -XPOST http://localhost:8080/rest/oktagroupsync/1.0/utility/run/admin/sync/config/id/1
Enter host password for user 'superadmin':
{"message":"Sync Successful, Update Size ( 6 ). Took 2.91 Seconds","id":6}
$