Apache Syncope 1.2.10

Namespaces

PrefixURIXSD
syncope1http://syncope.apache.org/1.2syncope1.xsd

REST resources

/configurations

REST operations for configuration.

Returns all configuration parameters.

Response

Content typesyncope1:conf
all configuration parameters
Media typesapplication/xml
application/json

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyconfiguration parameter keytemplatexs:string

Deletes the configuration parameter with matching key.

Response

Status204

Returns configuration parameter with matching key.

Response

Content typesyncope1:attribute
configuration parameter with matching key
Media typesapplication/xml
application/json

Creates / updates the configuration parameter with the given key.

Request

Content typesyncope1:attribute
parameter value
Media typesapplication/xml
application/json

Response

Status204

/mailTemplates

Returns a list of known mail-template names.

Response

Content typesyncope1:mailTemplates
a list of known mail-template names
Media typesapplication/xml
application/json

/stream

Exports internal storage content as downloadable XML file.

Response

Content type
internal storage content as downloadable XML file
Media types*/*

/validators

Returns a list of known validator names.

Response

Content typesyncope1:validators
a list of known validator names
Media typesapplication/xml
application/json

/connectors

REST operations for connector bundles and instances.

Returns a list of all connector instances with property keys in the matching language.

Parameters
NameDescriptionStyleTypeDefault
langlanguage to select property keys, null for default (English). An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length.queryxs:string

Request

Response

Content typesyncope1:connInstances
list of all connector instances with property keys in the matching language
Media typesapplication/xml
application/json

Creates a new connector instance.

Request

Content typesyncope1:connInstance
Media typesapplication/xml
application/json

Response

Featuring Location header of created connector instance

Content type
Media types*/*

/{connInstanceId}

Parameters
NameDescriptionStyleTypeDefault
connInstanceIdconnector instance id to be deletedtemplatexs:long

Deletes the connector instance matching the provided id.

Response

Status204

Returns connector instance with matching id.

Response

Content typesyncope1:connInstance
connector instance with matching id
Media typesapplication/xml
application/json

Updates the connector instance matching the provided id.

Request

Content typesyncope1:connInstance
connector instance to be stored
Media typesapplication/xml
application/json

Response

Status204

/{connInstanceId}/configuration

Parameters
NameDescriptionStyleTypeDefault
connInstanceIdconnector instance id to read configuration fromtemplatexs:long

Returns configuration for given connector instance.

Response

Content typesyncope1:connConfPropertys
configuration for given connector instance
Media typesapplication/xml
application/json

/{connInstanceId}/schemaNames

Parameters
NameDescriptionStyleTypeDefault
connInstanceIdconnector instance id to be used for schema lookuptemplatexs:long

Returns schema names for connector bundle matching the given connector instance id.

Parameters
NameDescriptionStyleTypeDefault
includeSpecialif set to true, special schema names (like '__PASSWORD__') will be included; default is falsequeryxs:booleanfalse

Request

Content typesyncope1:connInstance
connector instance object to provide special configuration properties
Media typesapplication/xml
application/json

Response

Content typesyncope1:schemas
schema names for connector bundle matching the given connector instance id
Media typesapplication/xml
application/json

/{connInstanceId}/supportedObjectClasses

Parameters
NameDescriptionStyleTypeDefault
connInstanceIdconnector instance id to be used for schema lookuptemplatexs:long

Returns supported object classes for connector bundle matching the given connector instance id.

Request

Content typesyncope1:connInstance
connector instance object to provide special configuration properties
Media typesapplication/xml
application/json

Response

Content typesyncope1:connIdObjectClasss
supported object classes for connector bundle matching the given connector instance id
Media typesapplication/xml
application/json

/bulk

Executes the provided bulk action.

Request

Content typesyncope1:bulkAction
list of connector instance ids against which the bulk action will be performed.
Media typesapplication/xml
application/json

Response

Content typesyncope1:bulkActionResult
Bulk action result
Media typesapplication/xml
application/json

/bundles

Returns available connector bundles with property keys in selected language.

Parameters
NameDescriptionStyleTypeDefault
langlanguage to select property keys; default language is Englishqueryxs:string

Request

Response

Content typesyncope1:connectorBundles
available connector bundles with property keys in selected language
Media typesapplication/xml
application/json

/byResource/{resourceName}

Parameters
NameDescriptionStyleTypeDefault
resourceNameresource name to be used for connector lookuptemplatexs:string

Returns connector instance for matching resource.

Response

Content typesyncope1:connInstance
connector instance for matching resource
Media typesapplication/xml
application/json

/check

Request

Content typesyncope1:connInstance
connector instance to be used for connection check
Media typesapplication/xml
application/json

Response

Content typexs:boolean
Media typesapplication/xml
application/json

/reload

Reload all connector bundles and instances.

Response

Status204

/entitlements

REST operations for entitlements.

Returns a list of all known entitlements.

Response

Content typesyncope1:entitlements
list of all known entitlements
Media typesapplication/xml
application/json

/own

Returns a list of entitlements assigned to user making the current request.

Response

Content typesyncope1:entitlements
list of entitlements assigned to user making the current request
Media typesapplication/xml
application/json

/logger

REST operations for logging and auditing.

/{type}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • LOG
  • AUDIT

Returns a list of loggers with matching type.

Response

Content typesyncope1:loggers
list of loggers with matching type
Media typesapplication/xml
application/json

/{type}/{name}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • LOG
  • AUDIT
nameLogger name to be deletedtemplatexs:string

Deletes the logger with matching name.

Response

Status204

Returns logger with matching type and name.

Response

Content typesyncope1:logger
logger with matching type and name
Media typesapplication/xml
application/json

Creates or updates (if existing) the logger with matching name.

Request

Content typesyncope1:logger
Logger to be created or updated
Media typesapplication/xml
application/json

Response

Status204

/events

Returns a list of all managed events in audit.

Response

Content typesyncope1:eventCategorys
list of all managed events in audit
Media typesapplication/xml
application/json

/notifications

REST operations for notifications.

Returns a list of all notifications.

Response

Content typesyncope1:notifications
list of all notifications.
Media typesapplication/xml
application/json

Creates a new notification.

Request

Content typesyncope1:notification
Media typesapplication/xml
application/json

Response

Featuring Location header of created notification

Content type
Media types*/*

/{notificationId}

Parameters
NameDescriptionStyleTypeDefault
notificationIdid for notification to be deletedtemplatexs:long

Deletes the notification matching the given id.

Response

Status204

Returns notification with matching id.

Response

Content typesyncope1:notification
notification with matching id
Media typesapplication/xml
application/json

Updates the notification matching the given id.

Request

Content typesyncope1:notification
notification to be stored
Media typesapplication/xml
application/json

Response

Status204

/policies

REST operations for policies.

Parameters
NameDescriptionStyleTypeDefault
typematrixxs:string
  • ACCOUNT
  • GLOBAL_ACCOUNT
  • PASSWORD
  • GLOBAL_PASSWORD
  • SYNC
  • GLOBAL_SYNC
  • PUSH
  • GLOBAL_PUSH

Returns a list of policies of the matching type.

Response

Content typesyncope1:abstractPolicys
list of policies with matching type
Media typesapplication/xml
application/json

Create a new policy.

Request

Content typesyncope1:abstractPolicy
Media typesapplication/xml
application/json

Response

Featuring Location header of created policy

Content type
Media types*/*

/{policyId}

Parameters
NameDescriptionStyleTypeDefault
policyIdid of policy to be deletedtemplatexs:long

Delete policy matching the given id.

Response

Status204

Returns the policy matching the given id.

Response

Content typesyncope1:abstractPolicy
policy with matching id
Media typesapplication/xml
application/json

Updates policy matching the given id.

Request

Content typesyncope1:abstractPolicy
Policy to replace existing policy
Media typesapplication/xml
application/json

Response

Status204

/global

Parameters
NameDescriptionStyleTypeDefault
typematrixxs:string
  • ACCOUNT
  • GLOBAL_ACCOUNT
  • PASSWORD
  • GLOBAL_PASSWORD
  • SYNC
  • GLOBAL_SYNC
  • PUSH
  • GLOBAL_PUSH

Returns the global policy for the given type.

Response

Content typesyncope1:abstractPolicy
global policy for matching type
Media typesapplication/xml
application/json

/syncCorrelationRuleClasses

Returns a list of classes to be used as correlation rules.

Response

Content typesyncope1:correlationRuleClasss
list of classes to be used as correlation rules
Media typesapplication/xml
application/json

/reports

REST operations for reports.

Returns a paged list of all existing reports matching page/size conditions.

Parameters
NameDescriptionStyleTypeDefault
orderbyselected page in relation to sizequeryxs:string

Request

Response

Content typesyncope1:pagedResult
paged list of existing reports matching page/size conditions
Media typesapplication/xml
application/json

Returns a paged list of all existing reports matching page/size conditions.

Response

Content typesyncope1:pagedResult
paged list of existing reports matching page/size conditions
Media typesapplication/xml
application/json

Returns a paged list of all existing reports matching page/size conditions.

Parameters
NameDescriptionStyleTypeDefault
pageselected page in relation to sizequeryxs:int1
sizenumber of entries per pagequeryxs:int25
orderbylist of ordering clauses, separated by commaqueryxs:string

Request

Response

Content typesyncope1:pagedResult
paged list of existing reports matching page/size conditions
Media typesapplication/xml
application/json

Returns a paged list of all existing reports matching page/size conditions.

Parameters
NameDescriptionStyleTypeDefault
pageselected page in relation to sizequeryxs:int1
sizenumber of entries per pagequeryxs:int25

Request

Response

Content typesyncope1:pagedResult
paged list of existing reports matching page/size conditions
Media typesapplication/xml
application/json

Creates a new report.

Request

Content typesyncope1:report
Media typesapplication/xml
application/json

Response

Featuring Location header of created report

Content type
Media types*/*

/{reportId}

Parameters
NameDescriptionStyleTypeDefault
reportIdDeletes report with matching idtemplatexs:long

Deletes report with matching id.

Response

Status204

Returns report with matching id.

Response

Content typesyncope1:report
report with matching id
Media typesapplication/xml
application/json

Execute a control action on an existing report

Parameters
NameDescriptionStyleTypeDefault
actionqueryxs:string
  • START
  • STOP

Request

Response

Status204

Updates report with matching id.

Request

Content typesyncope1:report
report to be stored
Media typesapplication/xml
application/json

Response

Status204

/{reportId}/execute

Parameters
NameDescriptionStyleTypeDefault
reportIdid of report to be executedtemplatexs:long

Executes the report with matching id.

Response

Content typesyncope1:reportExec
report execution result
Media typesapplication/xml
application/json

/{reportId}/executions

Parameters
NameDescriptionStyleTypeDefault
reportIdreport to which executions belongtemplatexs:long

Deletes the report executions belonging to the given report and matching the date conditions.

Parameters
NameDescriptionStyleTypeDefault
startedBeforeselects executions started before this timestampqueryxs:dateTime
startedAfterselects executions started after this timestampqueryxs:dateTime
endedBeforeselects executions ended before this timestampqueryxs:dateTime
endedAfterselects executions ended after this timestampqueryxs:dateTime

Request

Response

Content typesyncope1:bulkActionResult
bulk action result
Media typesapplication/xml
application/json

/executions/{executionId}

Parameters
NameDescriptionStyleTypeDefault
executionIdid of execution report to be deletedtemplatexs:long

Deletes report execution with matching id.

Response

Status204

Returns report execution with matching id.

Response

Content typesyncope1:reportExec
report execution with matching id
Media typesapplication/xml
application/json

/executions/{executionId}/stream

Parameters
NameDescriptionStyleTypeDefault
executionIdid of execution report to be selectedtemplatexs:long

Exports the report execution with matching id in the requested format.

Parameters
NameDescriptionStyleTypeDefault
formatqueryxs:string
  • XML
  • HTML
  • PDF
  • RTF
  • CSV

Request

Response

Content type
a stream for content download
Media types*/*

/jobs

Parameters
NameDescriptionStyleTypeDefault
typematrixxs:string
  • ALL
  • RUNNING
  • SCHEDULED

List report jobs of the given type

Response

Content typesyncope1:reportExecs
List of ReportExecTO
Media typesapplication/xml
application/json

/reportletConfClasses

Returns a list of available classes for reportlet configuration.

Response

Content typesyncope1:reportletConfClasss
list of available classes for reportlet configuration
Media typesapplication/xml
application/json

/resources

REST operations for external resources.

Returns a list of all resources.

Response

Content typesyncope1:resources
list of all resources
Media typesapplication/xml
application/json

Creates a new resource.

Request

Content typesyncope1:resource
Media typesapplication/xml
application/json

Response

Featuring Location header of created resource

Content type
Media types*/*

/{resourceName}

Parameters
NameDescriptionStyleTypeDefault
resourceNamename of resource to be deletedtemplatexs:string

Deletes the resource matching the given name.

Response

Status204

Returns the resource with matching name.

Response

Content typesyncope1:resource
resource with matching name
Media typesapplication/xml
application/json

Updates the resource matching the given name.

Request

Content typesyncope1:resource
resource to be stored
Media typesapplication/xml
application/json

Response

Status204

/{resourceName}/{type}/{id}

Parameters
NameDescriptionStyleTypeDefault
resourceNameName of resource to read connector object fromtemplatexs:string
typetemplatexs:string
  • USER
  • ROLE
iduser id / role idtemplatexs:long

Returns connector object from the external resource, for the given type and id.

Response

Content typesyncope1:connObject
connector object from the external resource, for the given type and id
Media typesapplication/xml
application/json

/{resourceName}/bulkDeassociation/{subjType}/{type}

Parameters
NameDescriptionStyleTypeDefault
resourceNamename of resourcetemplatexs:string
subjTypetemplatexs:string
  • USER
  • ROLE
typetemplatexs:string
  • UNLINK
  • DEPROVISION
  • UNASSIGN

De-associate users or roles (depending on the provided subject type) from the given resource.

Request

Content type
Media typesapplication/xml
application/json

Response

Featuring BulkActionResult as Entity

Content typesyncope1:bulkActionResult
Media typesapplication/xml
application/json

/bulk

Executes the provided bulk action.

Request

Content typesyncope1:bulkAction
list of resource names against which the bulk action will be performed
Media typesapplication/xml
application/json

Response

Content typesyncope1:bulkActionResult
Bulk action result
Media typesapplication/xml
application/json

/check

Checks wether the connection to resource could be established.

Request

Content typesyncope1:resource
resource to be checked
Media typesapplication/xml
application/json

Response

Content typexs:boolean
Media types*/*

/propagationActionsClasses

Returns a list of classes that can be used to customize the propagation process.

Response

Content typesyncope1:propagationActionClasss
list of classes that can be used to customize the propagation process
Media typesapplication/xml
application/json

/roles

REST operations for roles.

Returns a paged list of existing roles matching page/size conditions.

Parameters
NameDescriptionStyleTypeDefault
pageresult page numberqueryxs:int1
sizenumber of entries per pagequeryxs:int25
orderbylist of ordering clauses, separated by commaqueryxs:string
detailswhether include all details or not, defaults to truequeryxs:booleantrue

Request

Response

Content typesyncope1:pagedResult
paged list of existing roles matching page/size conditions
Media typesapplication/xml
application/json

Returns a paged list of existing roles matching page/size conditions.

Response

Content typesyncope1:pagedResult
paged list of existing roles matching page/size conditions
Media typesapplication/xml
application/json

Returns a paged list of existing roles matching page/size conditions.

Parameters
NameDescriptionStyleTypeDefault
orderbyresult page numberqueryxs:string

Request

Response

Content typesyncope1:pagedResult
paged list of existing roles matching page/size conditions
Media typesapplication/xml
application/json

Returns a paged list of existing roles matching page/size conditions.

Parameters
NameDescriptionStyleTypeDefault
pageresult page numberqueryxs:int1
sizenumber of entries per pagequeryxs:int25

Request

Response

Content typesyncope1:pagedResult
paged list of existing roles matching page/size conditions
Media typesapplication/xml
application/json

Creates a new role.

Request

Content typesyncope1:role
Media typesapplication/xml
application/json

Response

Featuring Location header of created role as well as the role itself enriched with propagation status information - RoleTO as Entity

Content type
Media typesapplication/xml
application/json

/{roleId}

Parameters
NameDescriptionStyleTypeDefault
roleIdid of role to be deletedtemplatexs:long

Deletes role matching provided roleId.

Response

Featuring the deleted role enriched with propagation status information - RoleTO as Entity

Content type
Media typesapplication/xml
application/json

Reads the role matching the provided roleId.

Response

Content typesyncope1:role
role with matching id
Media typesapplication/xml
application/json

Updates role matching the provided roleId.

Request

Content typesyncope1:roleMod
Media typesapplication/xml
application/json

Response

Featuring the updated role enriched with propagation status information - RoleTO as Entity

Content type
Media typesapplication/xml
application/json

/{roleId}/associate/{type}

Parameters
NameDescriptionStyleTypeDefault
roleIdrole id.templatexs:long
typetemplatexs:string
  • LINK
  • PROVISION
  • ASSIGN

Executes resource-related operations on given role.

Request

Content typesyncope1:resourceNames
Media typesapplication/xml
application/json

Response

Featuring BulkActionResult as Entity

Content type
Media typesapplication/xml
application/json

/{roleId}/associate/PROVISION/members

Parameters
NameDescriptionStyleTypeDefault
roleIdrole id.templatexs:long

Provision all members of the given role onto all the resources associated to it.

Response

Featuring BulkActionResult as Entity

Content typesyncope1:taskExec
Media types*/*

Deprovision all members of the given role from all the resources associated to it.

Response

Featuring BulkActionResult as Entity

Content typesyncope1:taskExec
Media types*/*

/{roleId}/children

Parameters
NameDescriptionStyleTypeDefault
roleIdid of role to get children fromtemplatexs:long

Returns children roles of given role.

Response

Content typesyncope1:roles
children roles of given role
Media typesapplication/xml
application/json

/{roleId}/deassociate/{type}

Parameters
NameDescriptionStyleTypeDefault
roleIdrole id.templatexs:long
typetemplatexs:string
  • UNLINK
  • DEPROVISION
  • UNASSIGN

Executes resource-related operations on given role.

Request

Content typesyncope1:resourceNames
Media typesapplication/xml
application/json

Response

Featuring BulkActionResult as Entity

Content type
Media typesapplication/xml
application/json

/{roleId}/own

Parameters
NameDescriptionStyleTypeDefault
roleIdid of role to be readtemplatexs:long

This method is similar to read(), but uses different authentication handling to ensure that a user can read his own roles.

Response

Content typesyncope1:role
Media typesapplication/xml
application/json

/{roleId}/parent

Parameters
NameDescriptionStyleTypeDefault
roleIdid of role to get parent role fromtemplatexs:long

Returns parent role of the given role (or null if no parent exists).

Response

Content typesyncope1:role
parent role of the given role (or null if no parent exists)
Media typesapplication/xml
application/json

/bulk

Executes the provided bulk action.

Request

Content typesyncope1:bulkAction
list of role ids against which the bulk action will be performed.
Media typesapplication/xml
application/json

Response

Content typesyncope1:bulkActionResult
Bulk action result
Media typesapplication/xml
application/json

/search

Returns a paged list of roles matching the provided FIQL search condition.

Parameters
NameDescriptionStyleTypeDefault
fiqlFIQL search expressionqueryxs:string
pageresult page numberqueryxs:int1
sizenumber of entries per pagequeryxs:int25
orderbylist of ordering clauses, separated by commaqueryxs:string
detailswhether include all details or not, defaults to truequeryxs:booleantrue

Request

Response

Content typesyncope1:pagedResult
paged list of roles matching the provided FIQL search condition
Media typesapplication/xml
application/json

Returns a paged list of roles matching the provided FIQL search condition.

Parameters
NameDescriptionStyleTypeDefault
fiqlFIQL search expressionqueryxs:string
orderbyresult page numberqueryxs:string

Request

Response

Content typesyncope1:pagedResult
paged list of roles matching the provided FIQL search condition
Media typesapplication/xml
application/json

Returns a paged list of roles matching the provided FIQL search condition.

Parameters
NameDescriptionStyleTypeDefault
fiqlFIQL search expressionqueryxs:string
pageresult page numberqueryxs:int1
sizenumber of entries per pagequeryxs:int25

Request

Response

Content typesyncope1:pagedResult
paged list of roles matching the provided FIQL search condition
Media typesapplication/xml
application/json

Returns a paged list of roles matching the provided FIQL search condition.

Parameters
NameDescriptionStyleTypeDefault
fiqlFIQL search expressionqueryxs:string

Request

Response

Content typesyncope1:pagedResult
paged list of roles matching the provided FIQL search condition
Media typesapplication/xml
application/json

/schemas/{kind}/{type}

REST operations for attribute schemas.

Parameters
NameDescriptionStyleTypeDefault
kindtemplatexs:string
  • USER
  • ROLE
  • MEMBERSHIP
  • CONFIGURATION
typetemplatexs:string
  • NORMAL
  • DERIVED
  • VIRTUAL

Returns a list of schemas with matching kind and type.

Response

Content typesyncope1:abstractSchemas
list of schemas with matching kind and type
Media typesapplication/xml
application/json

Creates a new schema.

Request

Content typesyncope1:abstractSchema
Media typesapplication/xml
application/json

Response

Featuring Location header of created schema

Content type
Media types*/*

/{name}

Parameters
NameDescriptionStyleTypeDefault
kindtemplatexs:string
  • USER
  • ROLE
  • MEMBERSHIP
  • CONFIGURATION
typetemplatexs:string
  • NORMAL
  • DERIVED
  • VIRTUAL
namename of schema to be deletedtemplatexs:string

Deletes the schema matching the given kind, type and name.

Response

Status204

Returns schema matching the given kind, type and name.

Response

Content typesyncope1:abstractSchema
schema matching the given kind, type and name
Media typesapplication/xml
application/json

Updates the schema matching the given kind, type and name.

Request

Content typesyncope1:abstractSchema
updated schema to be stored
Media typesapplication/xml
application/json

Response

Status204

/securityQuestions

REST operations for configuration.

Returns a list of all security questions.

Response

Content typesyncope1:securityQuestions
list of all security questions
Media typesapplication/xml
application/json

Creates a new security question.

Request

Content typesyncope1:securityQuestion
Media typesapplication/xml
application/json

Response

Featuring Location header of created security question

Content type
Media types*/*

/{securityQuestionId}

Parameters
NameDescriptionStyleTypeDefault
securityQuestionIdsecurity question id to be deletedtemplatexs:long

Deletes the security question matching the provided id.

Response

Status204

Returns security question with matching id.

Response

Content typesyncope1:securityQuestion
security question with matching id
Media typesapplication/xml
application/json

Updates the security question matching the provided id.

Request

Content typesyncope1:securityQuestion
security question to be stored
Media typesapplication/xml
application/json

Response

Status204

/byUser/{username}

Parameters
NameDescriptionStyleTypeDefault
usernameusername for which the security question is requestedtemplatexs:string

Ask for security question configured for the user matching the given username, if any.

Response

Content typesyncope1:securityQuestion
security question, if configured for the user matching the given username
Media typesapplication/xml
application/json

/tasks

REST operations for tasks.

Parameters
NameDescriptionStyleTypeDefault
typematrixxs:string
  • propagation
  • notification
  • sched
  • sync
  • push

Returns a paged list of existing tasks matching type and page/size conditions.

Response

Content typesyncope1:pagedResult
paged list of existing tasks matching type and page/size conditions
Media typesapplication/xml
application/json

Returns a paged list of existing tasks matching type and page/size conditions.

Parameters
NameDescriptionStyleTypeDefault
orderbypage number of tasks in relation to page sizequeryxs:string

Request

Response

Content typesyncope1:pagedResult
paged list of existing tasks matching type and page/size conditions
Media typesapplication/xml
application/json

Returns a paged list of existing tasks matching type and page/size conditions.

Parameters
NameDescriptionStyleTypeDefault
pagepage number of tasks in relation to page sizequeryxs:int1
sizenumber of tasks listed per pagequeryxs:int25
orderbylist of ordering clauses, separated by commaqueryxs:string
detailswhether include executions or not, defaults to truequeryxs:booleantrue

Request

Response

Content typesyncope1:pagedResult
paged list of existing tasks matching type and page/size conditions
Media typesapplication/xml
application/json

Returns a paged list of existing tasks matching type and page/size conditions.

Parameters
NameDescriptionStyleTypeDefault
pagepage number of tasks in relation to page sizequeryxs:int1
sizenumber of tasks listed per pagequeryxs:int25

Request

Response

Content typesyncope1:pagedResult
paged list of existing tasks matching type and page/size conditions
Media typesapplication/xml
application/json

Creates a new task.

Request

Content typesyncope1:schedTask
Media typesapplication/xml
application/json

Response

Featuring Location header of created task

Content type
Media types*/*

/{taskId}

Parameters
NameDescriptionStyleTypeDefault
taskIdid of task to be deletedtemplatexs:long

Deletes the task matching the provided id.

Response

Status204

Returns the task matching the given id.

Parameters
NameDescriptionStyleTypeDefault
detailswhether include executions or not, defaults to truequeryxs:booleantrue

Request

Response

Content typesyncope1:abstractTask
task with matching id
Media typesapplication/xml
application/json

Execute a control action on an existing task

Parameters
NameDescriptionStyleTypeDefault
actionqueryxs:string
  • START
  • STOP

Request

Response

Status204

Updates the task matching the provided id.

Request

Content typesyncope1:abstractTask
updated task to be stored
Media typesapplication/xml
application/json

Response

Status204

/{taskId}/execute

Parameters
NameDescriptionStyleTypeDefault
taskIdid of task to be executedtemplatexs:long

Executes the task matching the given id.

Parameters
NameDescriptionStyleTypeDefault
dryRunif true, task will only be simulatedqueryxs:booleanfalse

Request

Response

Content typesyncope1:taskExec
execution report for the task matching the given id
Media typesapplication/xml
application/json

/{taskId}/executions

Parameters
NameDescriptionStyleTypeDefault
taskIdtask to which executions belongtemplatexs:long

Deletes the task executions belonging to the given task and matching the date conditions.

Parameters
NameDescriptionStyleTypeDefault
startedBeforeselects executions started before this timestampqueryxs:dateTime
startedAfterselects executions started after this timestampqueryxs:dateTime
endedBeforeselects executions ended before this timestampqueryxs:dateTime
endedAfterselects executions ended after this timestampqueryxs:dateTime

Request

Response

Content typesyncope1:bulkActionResult
bulk action result
Media typesapplication/xml
application/json

Returns the task executions for the given task.

Parameters
NameDescriptionStyleTypeDefault
pagepage number of executions in relation to page sizequeryxs:int1
sizenumber of executions listed per pagequeryxs:int25

Request

Response

Content typesyncope1:pagedResult
list of task executions for the given task
Media typesapplication/xml
application/json

/bulk

Executes the provided bulk action.

Request

Content typesyncope1:bulkAction
list of task ids against which the bulk action will be performed.
Media typesapplication/xml
application/json

Response

Content typesyncope1:bulkActionResult
bulk action result
Media typesapplication/xml
application/json

/executions/{executionId}

Parameters
NameDescriptionStyleTypeDefault
executionIdid of task execution to be deletedtemplatexs:long

Deletes the task execution matching the provided id.

Response

Status204

Returns the task execution with the given id.

Response

Content typesyncope1:taskExec
task execution with matching Id
Media typesapplication/xml
application/json

/executions/{executionId}/report

Parameters
NameDescriptionStyleTypeDefault
executionIdid of task execution being reportedtemplatexs:long

Reports task execution result.

Request

Content typesyncope1:reportExec
execution being reported
Media typesapplication/xml
application/json

Response

Status204

/jobClasses

Returns a list of classes to be used for jobs.

Response

Content typesyncope1:jobClasss
list of classes to be used for jobs
Media typesapplication/xml
application/json

/jobs

Parameters
NameDescriptionStyleTypeDefault
typematrixxs:string
  • ALL
  • RUNNING
  • SCHEDULED

List task jobs of the given type

Response

Content typesyncope1:taskExecs
List of TaskExecTO
Media typesapplication/xml
application/json

/pushActionsClasses

Returns a list of classes to be used as push actions.

Response

Content typesyncope1:pushActionClasss
list of classes to be used as push actions
Media typesapplication/xml
application/json

/syncActionsClasses

Returns a list of classes to be used as synchronization actions.

Response

Content typesyncope1:syncActionClasss
list of classes to be used as synchronization actions
Media typesapplication/xml
application/json

/users

REST operations for users.

Returns a paged list of existing users matching page/size conditions.

Response

Content typesyncope1:pagedResult
paged list of existing users matching page/size conditions
Media typesapplication/xml
application/json

Returns a paged list of existing users matching page/size conditions.

Parameters
NameDescriptionStyleTypeDefault
orderbyresult page numberqueryxs:string

Request

Response

Content typesyncope1:pagedResult
paged list of existing users matching page/size conditions
Media typesapplication/xml
application/json

Returns a paged list of existing users matching page/size conditions.

Parameters
NameDescriptionStyleTypeDefault
pageresult page numberqueryxs:int1
sizenumber of entries per pagequeryxs:int25

Request

Response

Content typesyncope1:pagedResult
paged list of existing users matching page/size conditions
Media typesapplication/xml
application/json

Returns a paged list of existing users matching page/size conditions.

Parameters
NameDescriptionStyleTypeDefault
pageresult page numberqueryxs:int1
sizenumber of entries per pagequeryxs:int25
orderbylist of ordering clauses, separated by commaqueryxs:string
detailswhether include all details or not, defaults to truequeryxs:booleantrue

Request

Response

Content typesyncope1:pagedResult
paged list of existing users matching page/size conditions
Media typesapplication/xml
application/json

Creates a new user.

Parameters
NameDescriptionStyleTypeDefault
storePasswordwhether password shall be stored internallyqueryxs:booleantrue

Request

Content typesyncope1:user
Media typesapplication/xml
application/json

Response

Featuring Location header of created user as well as the user itself enriched with propagation status information - UserTO as Entity

Content type
Media typesapplication/xml
application/json

/{userId}

Parameters
NameDescriptionStyleTypeDefault
userIdid of user to be deletedtemplatexs:long

Deletes user matching provided userId.

Response

Featuring the deleted user enriched with propagation status information - UserTO as Entity

Content type
Media typesapplication/xml
application/json

Reads the user matching the provided userId.

Response

Content typesyncope1:user
User matching the provided userId
Media typesapplication/xml
application/json

Updates user matching the provided userId.

Request

Content typesyncope1:userMod
Media typesapplication/xml
application/json

Response

Featuring the updated user enriched with propagation status information - UserTO as Entity

Content type
Media typesapplication/xml
application/json

/{userId}/bulkAssociation/{type}

Parameters
NameDescriptionStyleTypeDefault
userIduser id.templatexs:long
typetemplatexs:string
  • LINK
  • PROVISION
  • ASSIGN

Executes resource-related operations on given user.

Request

Content typesyncope1:resourceAssociationMod
Media typesapplication/xml
application/json

Response

Featuring BulkActionResult as Entity

Content type
Media typesapplication/xml
application/json

/{userId}/bulkDeassociation/{type}

Parameters
NameDescriptionStyleTypeDefault
userIduser idtemplatexs:long
typetemplatexs:string
  • UNLINK
  • DEPROVISION
  • UNASSIGN

Executes resource-related operations on given user.

Request

Content typesyncope1:resourceNames
Media typesapplication/xml
application/json

Response

Featuring BulkActionResult as Entity

Content type
Media typesapplication/xml
application/json

/{userId}/status

Parameters
NameDescriptionStyleTypeDefault
userIdid of user to be subjected to status updatetemplatexs:long

Performs a status update on user matching provided userId.

Request

Content typesyncope1:statusMod
Media typesapplication/xml
application/json

Response

Featuring the updated user enriched with propagation status information - UserTO as Entity

Content type
Media typesapplication/xml
application/json

/{userId}/username

Parameters
NameDescriptionStyleTypeDefault
userIduser idtemplatexs:long

Gives the username for the provided user id.

Response

Featuring HTTP header with username matching the given userId

Content type
Media types*/*

/{username}/userId

Parameters
NameDescriptionStyleTypeDefault
usernameusernametemplatexs:string

Gives the user id for the provided username.

Response

Featuring HTTP header with userId matching the given username

Content type
Media types*/*

/bulk

Executes the provided bulk action.

Request

Content typesyncope1:bulkAction
list of user ids against which the bulk action will be performed.
Media typesapplication/xml
application/json

Response

Content typesyncope1:bulkActionResult
Bulk action result
Media typesapplication/xml
application/json

/search

Returns a paged list of users matching the provided FIQL search condition.

Parameters
NameDescriptionStyleTypeDefault
fiqlFIQL search expressionqueryxs:string
pageresult page numberqueryxs:int1
sizenumber of entries per pagequeryxs:int25

Request

Response

Content typesyncope1:pagedResult
paged list of users matching the provided FIQL search condition
Media typesapplication/xml
application/json

Returns a paged list of users matching the provided FIQL search condition.

Parameters
NameDescriptionStyleTypeDefault
fiqlFIQL search expressionqueryxs:string
pageresult page numberqueryxs:int1
sizenumber of entries per pagequeryxs:int25
orderbylist of ordering clauses, separated by commaqueryxs:string
detailswhether include all details or not, defaults to truequeryxs:booleantrue

Request

Response

Content typesyncope1:pagedResult
paged list of users matching the provided FIQL search condition
Media typesapplication/xml
application/json

Returns a paged list of users matching the provided FIQL search condition.

Parameters
NameDescriptionStyleTypeDefault
fiqlFIQL search expressionqueryxs:string
orderbyresult page numberqueryxs:string

Request

Response

Content typesyncope1:pagedResult
paged list of users matching the provided FIQL search condition
Media typesapplication/xml
application/json

Returns a paged list of users matching the provided FIQL search condition.

Parameters
NameDescriptionStyleTypeDefault
fiqlFIQL search expressionqueryxs:string

Request

Response

Content typesyncope1:pagedResult
paged list of users matching the provided FIQL search condition
Media typesapplication/xml
application/json

/users/self

REST operations for user self-management.

Self-deletes user.

Response

Featuring the deleted user - UserTO as Entity

Content type
Media typesapplication/xml
application/json

Returns the user making the service call.

Response

Content typesyncope1:user
calling user data
Media typesapplication/xml
application/json

Checks whether self-registration is allowed.

Response

Contains special Syncope HTTP header indicating if user self registration and / or password reset is allowed

Content type
Media types*/*

Self-registration for new user.

Parameters
NameDescriptionStyleTypeDefault
storePasswordwhether password shall be stored internallyqueryxs:booleantrue

Request

Content typesyncope1:user
Media typesapplication/xml
application/json

Response

Featuring Location header of self-registered user as well as the user itself - {@link UserTO} as Entity

Content type
Media typesapplication/xml
application/json

/{userId}

Parameters
NameDescriptionStyleTypeDefault
userIdid of user to be updatedtemplatexs:long

Self-updates user.

Request

Content typesyncope1:userMod
Media typesapplication/xml
application/json

Response

Featuring the updated user - UserTO as Entity

Content type
Media typesapplication/xml
application/json

/confirmPasswordReset

Reset the password value for the user matching the provided token, if available and still valid. If the token actually matches one of users, and if it is still valid at the time of submission, the matching user's password value is set as provided. The new password value will need anyway to comply with all relevant password policies.

Parameters
NameDescriptionStyleTypeDefault
tokenpassword reset tokenqueryxs:string

Request

Content typexs:string
Media types*/*

Response

Status204

/requestPasswordReset

Provides answer for the security question configured for user matching the given username, if any. If provided anwser matches the one stored for that user, a password reset token is internally generated, otherwise an error is returned.

Parameters
NameDescriptionStyleTypeDefault
usernameusername for which the security answer is providedqueryxs:string

Request

Content typexs:string
Media types*/*

Response

Status204

/userworkflow

REST operations related to user workflow.

/forms

Returns a list of all available workflow forms.

Response

Content typesyncope1:workflowForms
list of all available workflow forms
Media typesapplication/xml
application/json

Submits a workflow form.

Request

Content typesyncope1:workflowForm
workflow form.
Media typesapplication/xml
application/json

Response

Content typesyncope1:user
updated user
Media typesapplication/xml
application/json

/forms/{taskId}/claim

Parameters
NameDescriptionStyleTypeDefault
taskIdworkflow task idtemplatexs:string

Claims the form for the given task id.

Response

Content typesyncope1:workflowForm
the workflow form for the given task id
Media typesapplication/xml
application/json

/forms/{userId}

Parameters
NameDescriptionStyleTypeDefault
userIduser idtemplatexs:long

Returns a list of available forms for the given user id.

Response

Content typesyncope1:workflowForm
list of available forms for the given user id
Media typesapplication/xml
application/json

/tasks/{taskId}/execute

Parameters
NameDescriptionStyleTypeDefault
taskIdworkflow task idtemplatexs:string

Executes workflow task for matching id.

Request

Content typesyncope1:user
argument to be passed to workflow task
Media typesapplication/xml
application/json

Response

Content typesyncope1:user
updated user
Media typesapplication/xml
application/json

/workflows/{kind}

REST operations for workflow definition management.

Parameters
NameDescriptionStyleTypeDefault
kindtemplatexs:string
  • USER
  • ROLE

Exports workflow definition for matching kind.

Response

Content type
workflow definition for matching kind
Media typesapplication/xml
application/json

Checks whether Activiti is enabled (for users or roles).

Response

Contains special syncope HTTP header indicating if Activiti is enabled for users / roles

Content type
Media types*/*

Imports workflow definition for matching kind.

Request

Content typexs:string
Media typesapplication/xml
application/json

Response

Status204

/diagram.png

Parameters
NameDescriptionStyleTypeDefault
kindtemplatexs:string
  • USER
  • ROLE

Exports workflow diagram representation.

Response

Content type
workflow diagram representation
Media typesimage/png