Apache Syncope 2.1.2-SNAPSHOT

Namespaces

PrefixURIXSDWADL
syncope21http://syncope.apache.org/2.1syncope21.xsdsyncope.wadl

REST resources

/

General info about this Apache Syncope deployment.

assignableGroups/{realm:.*}

Parameters
NameDescriptionStyleTypeDefault
realmgroups search termtemplatexs:string

Returns the list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm.

Parameters
NameDescriptionStyleTypeDefault
termof the User and Any Objects assignable to the returned Groupsqueryxs:string
pagesearch pagequeryxs:int1
sizesearch page sizequeryxs:int25

Request

Response

Content typesyncope21:pagedResult
list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm
Media typesapplication/json
application/yaml
application/xml

batch

Gets batch results, in case asynchronous was requested.

Response

Content type
batch results as Response entity
Media typesmultipart/mixed

Requests for batch execution.

Request

Content type
batch request
Media typesmultipart/mixed

Response

Content type
batch results returned as Response entity, in case no 'Prefer: respond-async' was specified
Media typesmultipart/mixed

numbers

Provides some numbers about the managed entities (users, groups, any objects...).

Response

Content typesyncope21:numbersInfo
some numbers about the managed entities (users, groups, any objects...)
Media typesapplication/json
application/yaml
application/xml

platform

Provides information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...).

Response

Content typesyncope21:platformInfo
information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...)
Media typesapplication/json
application/yaml
application/xml

system

Provides information about the underlying system (Operating System, CPU / memory usage, ...).

Response

Content typesyncope21:systemInfo
information about the underlying system (Operating System, CPU / memory usage, ...)
Media typesapplication/json
application/yaml
application/xml

userTypeExtension/{groupName}

Parameters
NameDescriptionStyleTypeDefault
groupNamegroup nametemplatexs:string

Extracts User type extension information, for the provided group.

Response

Content typesyncope21:typeExtension
User type extension information, for the provided group
Media typesapplication/json
application/yaml
application/xml

/accessTokens

REST operations for access tokens.

Returns a paged list of existing access tokens matching the given query.

Parameters
NameDescriptionStyleTypeDefault
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope21:pagedResult
paged list of existing access tokens matching the given query
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyaccess token keytemplatexs:string

Invalidates the access token matching the provided key.

Response

Status204

/login

Returns an empty response bearing the X-Syncope-Token header value, in case of successful authentication. The provided value is a signed JSON Web Token.

Response

Content type
empty response bearing the X-Syncope-Token header value, in case of successful authentication
Media typesapplication/json
application/yaml
application/xml

/logout

Invalidates the access token of the requesting user.

Response

Status204

/refresh

Returns an empty response bearing the X-Syncope-Token header value, with extended lifetime. The provided value is a signed JSON Web Token.

Response

Content type
an empty response bearing the X-Syncope-Token header value, with extended lifetime
Media typesapplication/json
application/yaml
application/xml

/anyObjects

REST operations for anyObjects.

Returns a paged list of any objects matching the given query.

Parameters
NameDescriptionStyleTypeDefault
realmquery conditionsqueryxs:string/
detailsquery conditionsqueryxs:booleantrue
fiqlquery conditionsqueryxs:string
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope21:pagedResult
paged list of any objects matching the given query
Media typesapplication/json
application/yaml
application/xml

Creates a new any object.

Request

Content typesyncope21:anyObject
any object to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created any object as well as the any object itself enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string

Deletes any object matching provided key.

Response

Content type
Response object featuring the deleted any object enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

Reads the any object matching the provided key.

Response

Content typesyncope21:anyObject
any object with matching key
Media typesapplication/json
application/yaml
application/xml

Updates any object matching the provided key.

Request

Content typesyncope21:anyObjectPatch
modification to be applied to any object matching the provided key
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring the updated any object enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

Updates any object matching the provided key.

Request

Content typesyncope21:anyObject
modification to be applied to any object matching the provided key
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring the updated any object enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

/{key}/{schemaType}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL

Reads the list of attributes owned by the given any object for the given schema type. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope21:attributes
list of attributes, owned by the given any object, for the given schema type
Media typesapplication/json
application/yaml
application/xml

/{key}/{schemaType}/{schema}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL
schemaschematemplatexs:string

Deletes the attribute, owned by the given any object, for the given schema type and schema.

Response

Status204

Reads the attribute, owned by the given any object, for the given schema type and schema. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope21:attribute
attribute, owned by the given any object, for the given schema type and schema
Media typesapplication/json
application/yaml
application/xml

Adds or replaces the attribute, owned by the given any object, for the given schema type and schema.

Request

Content typesyncope21:attribute
attribute
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring the updated any object attribute - as Entity
Media typesapplication/json
application/yaml
application/xml

/{key}/associate/{action}

Executes resource-related operations on given entity.

Request

Content typesyncope21:associationPatch
external resources to be used for propagation-related operations
Media typesapplication/json
application/yaml
application/xml

Response

Content type
batch results as Response entity
Media typesmultipart/mixed

/{key}/deassociate/{action}

Executes resource-related operations on given entity.

Request

Content typesyncope21:deassociationPatch
external resources to be used for propagation-related operations
Media typesapplication/json
application/yaml
application/xml

Response

Content type
batch results as Response entity
Media typesmultipart/mixed

/anyTypeClasses

REST operations for any type classes.

Returns a list of all anyTypeClasss.

Response

Content typesyncope21:anyTypeClasss
list of all anyTypeClasss.
Media typesapplication/json
application/yaml
application/xml

Creates a new anyTypeClass.

Request

Content typesyncope21:anyTypeClass
anyTypeClass to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created anyTypeClass
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyanyTypeClass key to be deletedtemplatexs:string

Deletes the anyTypeClass matching the provided key.

Response

Status204

Returns anyTypeClass with matching key.

Response

Content typesyncope21:anyTypeClass
anyTypeClass with matching key
Media typesapplication/json
application/yaml
application/xml

Updates the anyTypeClass matching the provided key.

Request

Content typesyncope21:anyTypeClass
anyTypeClass to be stored
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/anyTypes

REST operations for any types.

Returns a list of all anyTypes.

Response

Content typesyncope21:anyTypes
list of all anyTypes.
Media typesapplication/json
application/yaml
application/xml

Creates a new anyType.

Request

Content typesyncope21:anyType
anyType to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created anyType
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyanyType key to be deletedtemplatexs:string

Deletes the anyType matching the provided key.

Response

Status204

Returns anyType with matching key.

Response

Content typesyncope21:anyType
anyType with matching key
Media typesapplication/json
application/yaml
application/xml

Updates the anyType matching the provided key.

Request

Content typesyncope21:anyType
anyType to be stored
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/applications

REST operations for applications.

Returns a list of all applications.

Response

Content typesyncope21:applications
list of all applications.
Media typesapplication/json
application/yaml
application/xml

Creates a new application.

Request

Content typesyncope21:application
application to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created application
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyapplication key to be deletedtemplatexs:string

Deletes the application matching the provided key.

Response

Status204

Returns application with matching key.

Response

Content typesyncope21:application
application with matching key
Media typesapplication/json
application/yaml
application/xml

Updates the application matching the provided key.

Request

Content typesyncope21:application
application to be stored
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/privileges/{key}

Parameters
NameDescriptionStyleTypeDefault
keyprivilege key to be readtemplatexs:string

Returns privilege with matching key.

Response

Content typesyncope21:privilege
privilege with matching key
Media typesapplication/json
application/yaml
application/xml

/camelRoutes

REST operations for Camel routes.

/{anyTypeKind}

Parameters
NameDescriptionStyleTypeDefault
anyTypeKindtemplatexs:string
  • USER
  • GROUP
  • ANY_OBJECT

List all routes for the given any type kind.

Response

Content typesyncope21:camelRoutes
all routes for the given any type kind
Media typesapplication/json
application/yaml
application/xml

/{anyTypeKind}/{key}

Parameters
NameDescriptionStyleTypeDefault
anyTypeKindtemplatexs:string
  • USER
  • GROUP
  • ANY_OBJECT
keyroute keytemplatexs:string

Read the route with the given key.

Response

Content typesyncope21:camelRoute
route with given key
Media typesapplication/json
application/yaml
application/xml

Update the given route.

Request

Content typesyncope21:camelRoute
to be updated
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/metrics

Provides Camel metrics.

Response

Content typesyncope21:camelMetrics
Camel metrics
Media typesapplication/json
application/yaml
application/xml

/restartContext

Restart the underlying Apache Camel context.

Response

Status204

/configurations

REST operations for configuration.

Returns all configuration parameters.

Response

Content typesyncope21:attributes
all configuration parameters
Media typesapplication/json
application/yaml
application/xml

/{schema}

Parameters
NameDescriptionStyleTypeDefault
schemaconfiguration parameter schematemplatexs:string

Deletes the configuration parameter with matching schema.

Response

Status204

Returns configuration parameter with matching schema.

Response

Content typesyncope21:attribute
configuration parameter with matching schema
Media typesapplication/json
application/yaml
application/xml

Creates / updates the configuration parameter with the given schema.

Request

Content typesyncope21:attribute
parameter value
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/stream

Exports internal storage content as downloadable XML file.

Response

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

/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 typesyncope21:connInstances
list of all connector instances with property keys in the matching language
Media typesapplication/json
application/yaml
application/xml

Creates a new connector instance.

Request

Content typesyncope21:connInstance
connector instance to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created connector instance
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyconnector instance key to be deletedtemplatexs:string

Deletes the connector instance matching the provided key.

Response

Status204

Returns connector instance with matching key.

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 typesyncope21:connInstance
connector instance with matching key
Media typesapplication/json
application/yaml
application/xml

Updates the connector instance matching the provided key.

Request

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

Response

Status204

/{key}/supportedObjectClasses

Builds the list of ConnId object classes information for the connector bundle matching the given connector instance key, with the provided configuration.

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

Request

Content typesyncope21:connInstance
connector instance object providing configuration properties
Media typesapplication/json
application/yaml
application/xml

Response

Content typesyncope21:connIdObjectClasss
supported object classes info for the connector bundle matching the given connector instance key, with the provided configuration
Media typesapplication/json
application/yaml
application/xml

/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 typesyncope21:connectorBundles
available connector bundles with property keys in selected language
Media typesapplication/json
application/yaml
application/xml

/byResource/{resourceName}

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

Returns connector instance for matching resource.

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 typesyncope21:connInstance
connector instance for matching resource
Media typesapplication/json
application/yaml
application/xml

/check

Checks whether the connection to resource could be established.

Request

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

Response

Status204

/reload

Reload all connector bundles and instances.

Response

Status204

/connectorsHistory

REST operations for connector configuration versioning.

/{connectorKey}

Parameters
NameDescriptionStyleTypeDefault
connectorKeyconnector instance keytemplatexs:string

Returns a list of all connector configuration history instances for the given connector instance key.

Response

Content typesyncope21:connInstanceHistoryConfs
list of all connector configuration history instances for the given connector instance key
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyconnector configuration history instance key to be deletedtemplatexs:string

Deletes the connector configuration history instance matching the provided key.

Response

Status204

Restores the connector configuration history instance matching the provided key.

Response

Status204

/domains

REST operations for domains.

Returns a list of all domains.

Response

Content typesyncope21:domains
list of all domains.
Media typesapplication/json
application/yaml
application/xml

Creates a new domain.

Request

Content typesyncope21:domain
domain to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created domain
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keydomain key to be deletedtemplatexs:string

Deletes the domain matching the provided key.

Response

Status204

Returns domain with matching key.

Response

Content typesyncope21:domain
domain with matching key
Media typesapplication/json
application/yaml
application/xml

Updates the domain matching the provided key.

Request

Content typesyncope21:domain
domain to be stored
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/dynRealms

REST operations for dynamic realms.

Returns a list of all dynamic realms.

Response

Content typesyncope21:dynRealms
list of all dynamic realms.
Media typesapplication/json
application/yaml
application/xml

Creates a new dynamic realm.

Request

Content typesyncope21:dynRealm
dynamic realm to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created dynamic realm
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keydynamic realm key to be deletedtemplatexs:string

Deletes the dynamic realm matching the provided key.

Response

Status204

Returns dynamic realm with matching key.

Response

Content typesyncope21:dynRealm
dynamic realm with matching key
Media typesapplication/json
application/yaml
application/xml

Updates the dynamic realm matching the provided key.

Request

Content typesyncope21:dynRealm
dynamic realm to be stored
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/groups

REST operations for groups.

Returns a paged list of any objects matching the given query.

Parameters
NameDescriptionStyleTypeDefault
realmquery conditionsqueryxs:string/
detailsquery conditionsqueryxs:booleantrue
fiqlquery conditionsqueryxs:string
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope21:pagedResult
paged list of any objects matching the given query
Media typesapplication/json
application/yaml
application/xml

Creates a new group.

Request

Content typesyncope21:group
group to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created group as well as the any object itself enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string

Deletes any object matching provided key.

Response

Content type
Response object featuring the deleted any object enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

Reads the any object matching the provided key.

Response

Content typesyncope21:group
any object with matching key
Media typesapplication/json
application/yaml
application/xml

Updates group matching the provided key.

Request

Content typesyncope21:groupPatch
modification to be applied to group matching the provided key
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring the updated group enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

Updates group matching the provided key.

Request

Content typesyncope21:group
modification to be applied to group matching the provided key
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring the updated group enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

/{key}/{schemaType}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL

Reads the list of attributes owned by the given any object for the given schema type. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope21:attributes
list of attributes, owned by the given any object, for the given schema type
Media typesapplication/json
application/yaml
application/xml

/{key}/{schemaType}/{schema}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL
schemaschematemplatexs:string

Deletes the attribute, owned by the given any object, for the given schema type and schema.

Response

Status204

Reads the attribute, owned by the given any object, for the given schema type and schema. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope21:attribute
attribute, owned by the given any object, for the given schema type and schema
Media typesapplication/json
application/yaml
application/xml

Adds or replaces the attribute, owned by the given any object, for the given schema type and schema.

Request

Content typesyncope21:attribute
attribute
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring the updated any object attribute - as Entity
Media typesapplication/json
application/yaml
application/xml

/{key}/associate/{action}

Executes resource-related operations on given entity.

Request

Content typesyncope21:associationPatch
external resources to be used for propagation-related operations
Media typesapplication/json
application/yaml
application/xml

Response

Content type
batch results as Response entity
Media typesmultipart/mixed

/{key}/deassociate/{action}

Executes resource-related operations on given entity.

Request

Content typesyncope21:deassociationPatch
external resources to be used for propagation-related operations
Media typesapplication/json
application/yaml
application/xml

Response

Content type
batch results as Response entity
Media typesmultipart/mixed

/{key}/members/{action}

Parameters
NameDescriptionStyleTypeDefault
keygroup keytemplatexs:string
actiontemplatexs:string
  • PROVISION
  • DEPROVISION

(De)provision all members of the given group from / onto all the resources associated to it.

Response

Content typesyncope21:exec
execution report for the task generated on purpose
Media typesapplication/json
application/yaml
application/xml

/own

This method allows a user to read his own groups.

Response

Content typesyncope21:groups
own groups
Media typesapplication/json
application/yaml
application/xml

/implementations

REST operations for implementations.

/{type}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • JWT_SSO_PROVIDER
  • REPORTLET
  • ACCOUNT_RULE
  • PASSWORD_RULE
  • ITEM_TRANSFORMER
  • TASKJOB_DELEGATE
  • RECON_FILTER_BUILDER
  • LOGIC_ACTIONS
  • PROPAGATION_ACTIONS
  • PULL_ACTIONS
  • PUSH_ACTIONS
  • PULL_CORRELATION_RULE
  • PUSH_CORRELATION_RULE
  • VALIDATOR
  • RECIPIENTS_PROVIDER
  • AUDIT_APPENDER

Returns a list of all implementations of the given type.

Response

Content typesyncope21:implementations
list of all implementations.
Media typesapplication/json
application/yaml
application/xml

/{type}/{key}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • JWT_SSO_PROVIDER
  • REPORTLET
  • ACCOUNT_RULE
  • PASSWORD_RULE
  • ITEM_TRANSFORMER
  • TASKJOB_DELEGATE
  • RECON_FILTER_BUILDER
  • LOGIC_ACTIONS
  • PROPAGATION_ACTIONS
  • PULL_ACTIONS
  • PUSH_ACTIONS
  • PULL_CORRELATION_RULE
  • PUSH_CORRELATION_RULE
  • VALIDATOR
  • RECIPIENTS_PROVIDER
  • AUDIT_APPENDER
keykey for implementation to be deletedtemplatexs:string

Deletes the implementation matching the given key and type.

Response

Content type
an empty response if operation was successful
Media typesapplication/json
application/yaml
application/xml

Returns implementation with matching type and key.

Response

Content typesyncope21:implementation
implementation with matching key
Media typesapplication/json
application/yaml
application/xml

Creates a new implementation.

Request

Content typesyncope21:implementation
implementation.
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created implementation
Media typesapplication/json
application/yaml
application/xml

Updates an existing implementation.

Request

Content typesyncope21:implementation
implementation.
Media typesapplication/json
application/yaml
application/xml

Response

Content type
an empty response if operation was successful
Media typesapplication/json
application/yaml
application/xml

/loggers

REST operations for logging and auditing.

/{type}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • LOG
  • AUDIT

Returns a list of loggers with matching type.

Response

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

/{type}/{key}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • LOG
  • AUDIT

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

Request

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

Response

Status204

/{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 typesyncope21:logger
logger with matching type and name
Media typesapplication/json
application/yaml
application/xml

/events

Returns the list of all managed events in audit.

Response

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

/memoryAppenders

Returns the list of memory appenders available in the current logging configuration.

Response

Content type
the list of memory appenders available in the current logging configuration
Media typesapplication/json
application/yaml
application/xml

/memoryAppenders/{memoryAppender}/lastLogStatements

Parameters
NameDescriptionStyleTypeDefault
memoryAppendermemory appender nametemplatexs:string

Return the last log statements available in the provided memory appender.

Response

Content typesyncope21:logStatements
the last log statements available in the provided memory appender
Media typesapplication/json
application/yaml
application/xml

/mailTemplates

REST operations for mail templates.

Returns a list of all mail templates.

Response

Content typesyncope21:mailTemplates
list of all mail templates.
Media typesapplication/json
application/yaml
application/xml

Creates a new mail template.

Request

Content typesyncope21:mailTemplate
Creates a new mail template.
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created mail template
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keykey for mail template to be deletedtemplatexs:string

Deletes the mail template matching the given key.

Response

Status204

Returns mail template with matching key.

Response

Content typesyncope21:mailTemplate
mail template with matching key
Media typesapplication/json
application/yaml
application/xml

/{key}/{format}

Parameters
NameDescriptionStyleTypeDefault
keymail templatetemplatexs:string
formattemplatexs:string
  • HTML
  • TEXT

Removes the template for the given key and format, if available.

Response

Status204

Gets the template for the given key and format, if available.

Response

Content type
mail template with matching key and format, if available
Media types*/*

Sets the template for the given key and format, if available.

Request

Content type
template to be set
Media types*/*

Response

Status204

/notifications

REST operations for notifications.

Returns a list of all notifications.

Response

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

Creates a new notification.

Request

Content typesyncope21:notification
Creates a new notification.
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created notification
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keykey for notification to be deletedtemplatexs:string

Deletes the notification matching the given key.

Response

Status204

Returns notification with matching key.

Response

Content typesyncope21:notification
notification with matching key
Media typesapplication/json
application/yaml
application/xml

Updates the notification matching the given key.

Request

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

Response

Status204

/job

Returns details about notification job.

Response

Content typesyncope21:job
details about notification job
Media typesapplication/json
application/yaml
application/xml

Executes an action on the notification job.

Parameters
NameDescriptionStyleTypeDefault
actionqueryxs:string
  • START
  • STOP
  • DELETE

Request

Response

Status204

/oidcclient/clients

REST operations for OpenID Connect Clients.

/login

Uses the provided authorization code to go through the OpenID Connect tokens process and finally creates JWT for the matching user, if found.

Parameters
NameDescriptionStyleTypeDefault
redirect_uriredirect URIqueryxs:string
authorizationCodeauthorization code generated by the remote OpenID Connect Providerqueryxs:string
opOpenID Connect Providerqueryxs:string

Request

Response

Content typesyncope21:oidcLoginResponse
JWT for the matching user plus attributes returned in the response
Media typesapplication/json
application/yaml
application/xml

/loginRequest

Generates OpenID Connect authentication request for the Provider matching the provided op.

Parameters
NameDescriptionStyleTypeDefault
redirect_uriredirect URIqueryxs:string
opOpenID Connect Providerqueryxs:string

Request

Response

Content typesyncope21:oidcLoginRequest
OpenID Connect authentication request
Media typesapplication/json
application/yaml
application/xml

/logout

Returns the endSession endpoint for the provided op.

Parameters
NameDescriptionStyleTypeDefault
opOpenID Connect Providerqueryxs:string

Request

Response

Content typesyncope21:oidcLogoutRequest
endSession endpoint for the provided op
Media typesapplication/json
application/yaml
application/xml

/oidcclient/providers

REST operations for OpenID Connect Providers.

Returns a list of all defined OIDC Providers.

Response

Content typesyncope21:oidcproviders
list of all defined OIDC Providers
Media typesapplication/json
application/yaml
application/xml

Creates a new OIDC Provider.

Request

Content typesyncope21:oidcprovider
OpenID Connect Provider configuration to be stored
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created OIDC Provider
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyOIDC Provider keytemplatexs:string

Deletes the OIDC Provider with matching key.

Response

Status204

Returns the OIDC Provider with matching key, if available.

Response

Content typesyncope21:oidcprovider
OIDC Providers with matching key, if available
Media typesapplication/json
application/yaml
application/xml

Updates the OIDC Provider with matching key.

Request

Content typesyncope21:oidcprovider
OpenID Connect Provider configuration to be stored
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/actionsClasses

Returns the list of available OIDCProviderActions implementations.

Response

Content type
the list of available OIDCProviderActions implementations
Media typesapplication/json

/fromDiscovery

Creates a new OIDC Provider by using its Discovery Document.

Request

Content typesyncope21:oidcprovider
OpenID Connect Provider configuration to be stored
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created OIDC Provider
Media typesapplication/json
application/yaml
application/xml

/policies

REST operations for policies.

/{type}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • ACCOUNT
  • PASSWORD
  • PULL
  • PUSH

Returns a list of policies of the matching type.

Response

Content typesyncope21:policys
list of policies with matching type
Media typesapplication/json
application/yaml
application/xml

Create a new policy.

Request

Content typesyncope21:policy
Policy to be created (needs to match type)
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created policy
Media typesapplication/json
application/yaml
application/xml

/{type}/{key}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • ACCOUNT
  • PASSWORD
  • PULL
  • PUSH
keykey of policy to be deletedtemplatexs:string

Delete policy matching the given key.

Response

Status204

Returns the policy matching the given key.

Response

Content typesyncope21:policy
policy with matching id
Media typesapplication/json
application/yaml
application/xml

Updates policy matching the given key.

Request

Content typesyncope21:policy
Policy to replace existing policy
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/realms

REST operations for realms.

Returns a list of all realms.

Response

Content typesyncope21:realms
list of all realms.
Media typesapplication/json
application/yaml
application/xml

/{fullPath:.*}

Parameters
NameDescriptionStyleTypeDefault
fullPathrealm pathtemplatexs:string

Deletes the realm under the given path.

Response

Content type
Response object featuring the deleted realm enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

Returns realms rooted at the given path.

Response

Content typesyncope21:realms
realms rooted at the given path
Media typesapplication/json
application/yaml
application/xml

Updates the realm under the given path.

Request

Content typesyncope21:realm
realm to be stored
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring the updated realm enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

/{parentPath:.*}

Parameters
NameDescriptionStyleTypeDefault
parentPathfull path of the parent realmtemplatexs:string

Creates a new realm under the given path.

Request

Content typesyncope21:realm
new realm.
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created realm as well as the realm itself enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

/reconciliation

REST operations for reconciliation.

Gets current attributes on Syncope and on the given External Resource, related to given user, group or any object.

Parameters
NameDescriptionStyleTypeDefault
anyTypeKindqueryxs:string
  • USER
  • GROUP
  • ANY_OBJECT
anyKeyuser, group or any object: if value looks like a UUID then it is interpreted as key, otherwise as a (user)namequeryxs:string
resourceKeyresource keyqueryxs:string

Request

Response

Content typesyncope21:reconStatus
reconciliation status
Media typesapplication/json
application/yaml
application/xml

/pull

Pulls the given user, group or any object from the External Resource into Syncope.

Parameters
NameDescriptionStyleTypeDefault
anyTypeKindqueryxs:string
  • USER
  • GROUP
  • ANY_OBJECT
anyKeyuser, group or any object: if value looks like a UUID then it is interpreted as key, otherwise as a (user)namequeryxs:string
resourceKeyresource keyqueryxs:string

Request

Content typesyncope21:pullTask
pull specification
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/push

Pushes the given user, group or any object in Syncope onto the External Resource.

Parameters
NameDescriptionStyleTypeDefault
anyTypeKindqueryxs:string
  • USER
  • GROUP
  • ANY_OBJECT
anyKeyuser, group or any object: if value looks like a UUID then it is interpreted as key, otherwise as a (user)namequeryxs:string
resourceKeyresource keyqueryxs:string

Request

Content typesyncope21:pushTask
push specification
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/relationshipTypes

REST operations for relationship types.

Returns a list of all relationshipTypes.

Response

Content typesyncope21:relationshipTypes
list of all relationshipTypes.
Media typesapplication/json
application/yaml
application/xml

Creates a new relationshipType.

Request

Content typesyncope21:relationshipType
relationshipType to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created relationshipType
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyrelationshipType key to be deletedtemplatexs:string

Deletes the relationshipType matching the provided key.

Response

Status204

Returns relationshipType with matching key.

Response

Content typesyncope21:relationshipType
relationshipType with matching key
Media typesapplication/json
application/yaml
application/xml

Updates the relationshipType matching the provided key.

Request

Content typesyncope21:relationshipType
relationshipType to be stored
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/remediations

REST operations for remediations.

Returns a list of all remediations.

Parameters
NameDescriptionStyleTypeDefault
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope21:pagedResult
list of all remediations.
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keykey for remediation to be deletedtemplatexs:string

Deletes the remediation matching the given key.

Response

Content type
an empty response if operation was successful
Media typesapplication/json
application/yaml
application/xml

Returns remediation with matching key.

Response

Content typesyncope21:remediation
remediation with matching key
Media typesapplication/json
application/yaml
application/xml

/{remediationKey}

Parameters
NameDescriptionStyleTypeDefault
remediationKeykey for remediation to act ontemplatexs:string

Perform remediation by creating the provided user, group or any object.

Request

Content typesyncope21:anyPatch
user, group or any object to create
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created object as well as the object itself enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

Perform remediation by creating the provided user, group or any object.

Request

Content typesyncope21:anyTO
user, group or any object to create
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created object as well as the object itself enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

/{remediationKey}/{anyKey}

Parameters
NameDescriptionStyleTypeDefault
remediationKeykey for remediation to act ontemplatexs:string
anyKeyuser, group or any object to createtemplatexs:string

Perform remediation by creating the provided user, group or any object.

Response

Content type
Response object featuring Location header of created object as well as the object itself enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

/reports

REST operations for reports.

Returns a list of all existing reports.

Response

Content typesyncope21:reports
paged list of existing reports matching the given query
Media typesapplication/json
application/yaml
application/xml

Creates a new report.

Request

Content typesyncope21:report
report to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created report
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyDeletes report with matching keytemplatexs:string

Deletes report with matching key.

Response

Status204

Returns report with matching key.

Response

Content typesyncope21:report
report with matching key
Media typesapplication/json
application/yaml
application/xml

Updates report with matching key.

Request

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

Response

Status204

/{key}/execute

Parameters
NameDescriptionStyleTypeDefault
keyquery conditionstemplatexs:string

Executes the executable matching the given query.

Parameters
NameDescriptionStyleTypeDefault
startAtquery conditionsqueryxs:dateTime
dryRunquery conditionsqueryxs:booleanfalse

Request

Response

Content typesyncope21:exec
execution report for the executable matching the given query
Media typesapplication/json
application/yaml
application/xml

/{key}/executions

Parameters
NameDescriptionStyleTypeDefault
keyquery conditionstemplatexs:string

Deletes the executions belonging matching the given query.

Parameters
NameDescriptionStyleTypeDefault
startedBeforequery conditionsqueryxs:dateTime
startedAfterquery conditionsqueryxs:dateTime
endedBeforequery conditionsqueryxs:dateTime
endedAfterquery conditionsqueryxs:dateTime

Request

Response

Content type
batch results as Response entity
Media typesmultipart/mixed

Returns a paged list of executions matching the given query.

Parameters
NameDescriptionStyleTypeDefault
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope21:pagedResult
paged list of executions the given query
Media typesapplication/json
application/yaml
application/xml

/executions/{executionKey}

Parameters
NameDescriptionStyleTypeDefault
executionKeykey of executable execution to be deletedtemplatexs:string

Deletes the executable execution matching the provided key.

Response

Status204

/executions/{executionKey}/stream

Parameters
NameDescriptionStyleTypeDefault
executionKeykey of execution report to be selectedtemplatexs:string

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

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

Request

Response

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

/executions/recent

Returns the list of recently completed executions, ordered by end date descendent.

Parameters
NameDescriptionStyleTypeDefault
maxthe maximum number of executions to returnqueryxs:int25

Request

Response

Content typesyncope21:execs
list of recently completed executions, ordered by end date descendent
Media typesapplication/json
application/yaml
application/xml

/jobs

List jobs (running and / or scheduled).

Response

Content typesyncope21:jobs
jobs (running and / or scheduled)
Media typesapplication/json
application/yaml
application/xml

/jobs/{key}

Parameters
NameDescriptionStyleTypeDefault
keyexecutable keytemplatexs:string

Returns job (running or scheduled) for the executable matching the given key.

Response

Content typesyncope21:job
job (running or scheduled) for the given key
Media typesapplication/json
application/yaml
application/xml

Executes an action on an existing executable's job.

Parameters
NameDescriptionStyleTypeDefault
actionqueryxs:string
  • START
  • STOP
  • DELETE

Request

Response

Status204

/reportTemplates

REST operations for report templates.

Returns a list of all report templates.

Response

Content typesyncope21:reportTemplates
list of all report templates.
Media typesapplication/json
application/yaml
application/xml

Creates a new report template.

Request

Content typesyncope21:reportTemplate
Creates a new report template.
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created report template
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keykey for report template to be deletedtemplatexs:string

Deletes the report template matching the given key.

Response

Status204

Returns report template with matching key.

Response

Content typesyncope21:reportTemplate
report template with matching key
Media typesapplication/json
application/yaml
application/xml

/{key}/{format}

Parameters
NameDescriptionStyleTypeDefault
keyreport templatetemplatexs:string
formattemplatexs:string
  • FO
  • HTML
  • CSV

Removes the template for the given key and format, if available.

Response

Status204

Gets the template for the given key and format, if available.

Response

Content type
report template with matching key and format, if available
Media types*/*

Sets the template for the given key and format, if available.

Request

Content type
template to be set
Media types*/*

Response

Status204

/resources

REST operations for external resources.

Returns a list of all resources.

Response

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

Creates a new resource.

Request

Content typesyncope21:resource
Resource to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created resource
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyname of resource to be deletedtemplatexs:string

Deletes the resource matching the given name.

Response

Status204

Returns the resource with matching name.

Response

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

Updates the resource matching the given name.

Request

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

Response

Status204

/{key}/{anyTypeKey}

Parameters
NameDescriptionStyleTypeDefault
keyresourcetemplatexs:string
anyTypeKeyany typetemplatexs:string

Removes the sync token value associated to the given any type from the given resource.

Response

Status204

Returns a paged list of connector objects from external resource, for the given type, matching page/size conditions.

Parameters
NameDescriptionStyleTypeDefault
pagedResultsCookiename of resource to read connector object fromqueryxs:string
sizename of resource to read connector object fromqueryxs:int25

Request

Response

Content typesyncope21:pagedConnObjectResult
connector objects from the external resource, for the given type
Media typesapplication/json
application/yaml
application/xml

Queries the connector underlying the given resource for the latest sync token value associated to the given any type and stores the value internally, for later usage.

Response

Status204

/{key}/{anyTypeKey}/{anyKey}

Parameters
NameDescriptionStyleTypeDefault
keyname of resource to read connector object fromtemplatexs:string
anyTypeKeyany object typetemplatexs:string
anyKeyany object keytemplatexs:string

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

Response

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

/check

Checks whether the connection to resource could be established.

Request

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

Response

Status204

/resourcesHistory

REST operations for resource configuration versioning.

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyresource configuration history key to be deletedtemplatexs:string

Deletes the resource configuration history matching the provided key.

Response

Status204

Restores the resource configuration history matching the provided key.

Response

Status204

/{resourceKey}

Parameters
NameDescriptionStyleTypeDefault
resourceKeyresource keytemplatexs:string

Returns a list of all resource configuration history for the given resource key.

Response

Content typesyncope21:resourceHistoryConfs
list of all resource configuration history for the given resource key
Media typesapplication/json
application/yaml
application/xml

/roles

REST operations for roles.

Returns a list of all roles.

Response

Content typesyncope21:roles
list of all roles.
Media typesapplication/json
application/yaml
application/xml

Creates a new role.

Request

Content typesyncope21:role
role to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created role
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyrole key to be deletedtemplatexs:string

Deletes the role matching the provided key.

Response

Status204

Returns role with matching key.

Response

Content typesyncope21:role
role with matching key
Media typesapplication/json
application/yaml
application/xml

Updates the role matching the provided key.

Request

Content typesyncope21:role
role to be stored
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/{key}/consoleLayout

Parameters
NameDescriptionStyleTypeDefault
keyrole keytemplatexs:string

Removes the console layout information for the role with the given key, if available.

Response

Status204

Gets the console layout information as JSON string for the role with the given key, if available.

Response

Content type
console layout information as JSON string for the role with the given key, if available
Media typesapplication/json

Sets the console layout information as JSON string for the role with the given key, if available.

Request

Content type
console layout information to be set
Media typesapplication/json

Response

Status204

/saml2sp/identityProviders

REST operations for SAML 2.0 Identity Providers.

Returns a list of all defined SAML 2.0 Identity Providers.

Response

Content typesyncope21:saml2idps
list of all defined SAML 2.0 Identity Providers
Media typesapplication/json
application/yaml
application/xml

Imports the SAML 2.0 Identity Provider definitions available in the provided XML metadata.

Request

Content type
XML metadata
Media typesapplication/xml

Response

Content type
the entityID values for all imported SAML 2.0 Identity Providers
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keySAML 2.0 Identity Provider's entityIDtemplatexs:string

Deletes the SAML 2.0 Identity Provider with matching entityID.

Response

Status204

Returns the SAML 2.0 Identity Provider with matching entityID, if available.

Response

Content typesyncope21:saml2idp
SAML 2.0 Identity Provider with matching entityID, if available
Media typesapplication/json
application/yaml
application/xml

Updates the SAML 2.0 Identity Provider with matching entityID.

Request

Content typesyncope21:saml2idp
idp configuration to be stored
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/actionsClasses

Returns the list of available SAML2IdPActions implementations.

Response

Content type
the list of available SAML2IdPActions implementations
Media typesapplication/json

/saml2sp/serviceProvider

REST operations for the provided SAML 2.0 Service Provider.

Returns the XML metadata for the provided SAML 2.0 Service Provider.

Parameters
NameDescriptionStyleTypeDefault
spEntityIDSAML 2.0 SP entity ID.queryxs:string
urlContextSAML 2.0 SP agent URL contextqueryxs:string

Request

Response

Content type
XML metadata for the provided SAML 2.0 Service Provider
Media typesapplication/xml

/loginRequest

Generates SAML 2.0 authentication request for the IdP matching the provided entity ID.

Parameters
NameDescriptionStyleTypeDefault
spEntityIDSAML 2.0 SP entity ID.queryxs:string
idpEntityIDSAML 2.0 IdP entity ID.queryxs:string

Request

Response

Content typesyncope21:saml2request
SAML 2.0 authentication request
Media typesapplication/json
application/yaml
application/xml

/loginResponse

Validates the received SAML 2.0 authentication response and creates JWT for the matching user, if found.

Request

Content typesyncope21:saml2ReceivedResponse
SAML response and relay state
Media typesapplication/json
application/yaml
application/xml

Response

Content typesyncope21:saml2LoginResponse
JWT for the matching user plus attributes returned in the response
Media typesapplication/json
application/yaml
application/xml

/logoutRequest

Generates SAML 2.0 logout request for the IdP matching the requesting access token.

Parameters
NameDescriptionStyleTypeDefault
spEntityIDSAML 2.0 SP entity ID.queryxs:string

Request

Response

Content typesyncope21:saml2request
SAML 2.0 logout request
Media typesapplication/json
application/yaml
application/xml

/logoutResponse

Validates the received SAML 2.0 logout response.

Request

Content typesyncope21:saml2ReceivedResponse
SAML response and relay state
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/schemas

REST operations for attribute schemas.

/{type}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL

Returns a list of schemas matching the given query.

Parameters
NameDescriptionStyleTypeDefault
keywordactual SchemaTOqueryxs:string
anyTypeClassesactual SchemaTOqueryxs:string

Request

Response

Content typesyncope21:schemas
list of schemas with matching type, for the given anyTypeClass if provided, with keys containing keyword if provided
Media typesapplication/json
application/yaml
application/xml

Creates a new schema.

Request

Content typesyncope21:schema
schema to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created schema
Media typesapplication/json
application/yaml
application/xml

/{type}/{key}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL
keyname of schema to be deletedtemplatexs:string

Deletes the schema matching the given type and key.

Response

Status204

Returns schema matching the given type and key.

Response

Content typesyncope21:schema
schema matching the given type and name
Media typesapplication/json
application/yaml
application/xml

Updates the schema matching the given type and key.

Request

Content typesyncope21:schema
updated schema to be stored
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/scimv2conf

REST operations for SCIM 2.0 configuration.

Reads SCIM configuration, generates empty if missing.

Response

Content type
SCIM configuration
Media typesapplication/json
application/yaml
application/xml

Sets SCIM configuration.

Request

Content type
SCIM configuration
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/securityQuestions

REST operations for configuration.

Returns a list of all security questions.

Response

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

Creates a new security question.

Request

Content typesyncope21:securityQuestion
security question to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created security question
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keysecurity question key to be deletedtemplatexs:string

Deletes the security question matching the provided key.

Response

Status204

Returns security question with matching key.

Response

Content typesyncope21:securityQuestion
security question with matching key
Media typesapplication/json
application/yaml
application/xml

Updates the security question matching the provided key.

Request

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

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 typesyncope21:securityQuestion
security question, if configured for the user matching the given username
Media typesapplication/json
application/yaml
application/xml

/tasks

REST operations for tasks.

/{key}/execute

Parameters
NameDescriptionStyleTypeDefault
keyquery conditionstemplatexs:string

Executes the executable matching the given query.

Parameters
NameDescriptionStyleTypeDefault
startAtquery conditionsqueryxs:dateTime
dryRunquery conditionsqueryxs:booleanfalse

Request

Response

Content typesyncope21:exec
execution report for the executable matching the given query
Media typesapplication/json
application/yaml
application/xml

/{key}/executions

Parameters
NameDescriptionStyleTypeDefault
keyquery conditionstemplatexs:string

Deletes the executions belonging matching the given query.

Parameters
NameDescriptionStyleTypeDefault
startedBeforequery conditionsqueryxs:dateTime
startedAfterquery conditionsqueryxs:dateTime
endedBeforequery conditionsqueryxs:dateTime
endedAfterquery conditionsqueryxs:dateTime

Request

Response

Content type
batch results as Response entity
Media typesmultipart/mixed

Returns a paged list of executions matching the given query.

Parameters
NameDescriptionStyleTypeDefault
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope21:pagedResult
paged list of executions the given query
Media typesapplication/json
application/yaml
application/xml

/{type}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • PROPAGATION
  • NOTIFICATION
  • SCHEDULED
  • PULL
  • PUSH

Returns a paged list of existing tasks matching the given query.

Parameters
NameDescriptionStyleTypeDefault
detailstype of taskTOqueryxs:booleantrue
resourcetype of taskTOqueryxs:string
notificationtype of taskTOqueryxs:string
entityKeytype of taskTOqueryxs:string
anyTypeKindqueryxs:string
  • USER
  • GROUP
  • ANY_OBJECT
pagetype of taskTOqueryxs:int1
orderBytype of taskTOqueryxs:string
sizetype of taskTOqueryxs:int25

Request

Response

Content typesyncope21:pagedResult
paged list of existing tasks matching the given query
Media typesapplication/json
application/yaml
application/xml

Creates a new task.

Request

Content typesyncope21:schedTask
task to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created task
Media typesapplication/json
application/yaml
application/xml

/{type}/{key}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • PROPAGATION
  • NOTIFICATION
  • SCHEDULED
  • PULL
  • PUSH
keykey of task to be deletedtemplatexs:string

Deletes the task matching the provided key.

Response

Status204

Returns the task matching the given key.

Parameters
NameDescriptionStyleTypeDefault
detailskey of task to be readqueryxs:booleantrue

Request

Response

Content typesyncope21:task
task with matching id
Media typesapplication/json
application/yaml
application/xml

Updates the task matching the provided key.

Request

Content typesyncope21:schedTask
updated task to be stored
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/executions/{executionKey}

Parameters
NameDescriptionStyleTypeDefault
executionKeykey of executable execution to be deletedtemplatexs:string

Deletes the executable execution matching the provided key.

Response

Status204

/executions/recent

Returns the list of recently completed executions, ordered by end date descendent.

Parameters
NameDescriptionStyleTypeDefault
maxthe maximum number of executions to returnqueryxs:int25

Request

Response

Content typesyncope21:execs
list of recently completed executions, ordered by end date descendent
Media typesapplication/json
application/yaml
application/xml

/jobs

List jobs (running and / or scheduled).

Response

Content typesyncope21:jobs
jobs (running and / or scheduled)
Media typesapplication/json
application/yaml
application/xml

/jobs/{key}

Parameters
NameDescriptionStyleTypeDefault
keyexecutable keytemplatexs:string

Returns job (running or scheduled) for the executable matching the given key.

Response

Content typesyncope21:job
job (running or scheduled) for the given key
Media typesapplication/json
application/yaml
application/xml

Executes an action on an existing executable's job.

Parameters
NameDescriptionStyleTypeDefault
actionqueryxs:string
  • START
  • STOP
  • DELETE

Request

Response

Status204

/users

REST operations for users.

Returns a paged list of any objects matching the given query.

Parameters
NameDescriptionStyleTypeDefault
realmquery conditionsqueryxs:string/
detailsquery conditionsqueryxs:booleantrue
fiqlquery conditionsqueryxs:string
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope21:pagedResult
paged list of any objects matching the given query
Media typesapplication/json
application/yaml
application/xml

Creates a new user.

Parameters
NameDescriptionStyleTypeDefault
storePasswordwhether password shall be stored internallyqueryxs:booleantrue

Request

Content typesyncope21:user
user to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of created user as well as the user itself enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string

Deletes any object matching provided key.

Response

Content type
Response object featuring the deleted any object enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

Reads the any object matching the provided key.

Response

Content typesyncope21:user
any object with matching key
Media typesapplication/json
application/yaml
application/xml

Updates user matching the provided key.

Request

Content typesyncope21:userPatch
modification to be applied to user matching the provided key
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring the updated user enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

Updates user matching the provided key.

Request

Content typesyncope21:user
modification to be applied to user matching the provided key
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring the updated user enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

/{key}/{schemaType}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL

Reads the list of attributes owned by the given any object for the given schema type. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope21:attributes
list of attributes, owned by the given any object, for the given schema type
Media typesapplication/json
application/yaml
application/xml

/{key}/{schemaType}/{schema}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL
schemaschematemplatexs:string

Deletes the attribute, owned by the given any object, for the given schema type and schema.

Response

Status204

Reads the attribute, owned by the given any object, for the given schema type and schema. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope21:attribute
attribute, owned by the given any object, for the given schema type and schema
Media typesapplication/json
application/yaml
application/xml

Adds or replaces the attribute, owned by the given any object, for the given schema type and schema.

Request

Content typesyncope21:attribute
attribute
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring the updated any object attribute - as Entity
Media typesapplication/json
application/yaml
application/xml

/{key}/associate/{action}

Executes resource-related operations on given entity.

Request

Content typesyncope21:associationPatch
external resources to be used for propagation-related operations
Media typesapplication/json
application/yaml
application/xml

Response

Content type
batch results as Response entity
Media typesmultipart/mixed

/{key}/deassociate/{action}

Executes resource-related operations on given entity.

Request

Content typesyncope21:deassociationPatch
external resources to be used for propagation-related operations
Media typesapplication/json
application/yaml
application/xml

Response

Content type
batch results as Response entity
Media typesmultipart/mixed

/{key}/status

Performs a status update on given user.

Request

Content typesyncope21:statusPatch
status update details
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring the updated user enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

/users/self

REST operations for user self-management.

Self-deletes user.

Response

Content type
Response object featuring the deleted user
Media typesapplication/json
application/yaml
application/xml

Returns the user making the service call.

Response

Content type
calling user data, including own UUID and entitlements
Media typesapplication/json
application/yaml
application/xml

Self-registration for new user.

Parameters
NameDescriptionStyleTypeDefault
storePasswordwhether password shall be stored internallyqueryxs:booleantrue

Request

Content typesyncope21:user
user to be created
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring Location header of self-registered user as well as the user itself enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

/{key}

Self-updates user.

Request

Content typesyncope21:userPatch
modification to be applied to self
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring the updated user
Media typesapplication/json
application/yaml
application/xml

Self-updates user.

Request

Content typesyncope21:user
modification to be applied to self
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring the updated user
Media typesapplication/json
application/yaml
application/xml

/{key}/status

Self-perform a status update.

Request

Content typesyncope21:statusPatch
status update details
Media typesapplication/json
application/yaml
application/xml

Response

Content type
Response object featuring the updated user enriched with propagation status information
Media typesapplication/json
application/yaml
application/xml

/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

/mustChangePassword

Changes own password when change was forced by an administrator.

Request

Content typexs:string
Media types*/*

Response

Content type
Response object featuring the updated user
Media typesapplication/json
application/yaml
application/xml

/requestPasswordReset

Provides answer for the security question configured for user matching the given username, if any. If provided answer 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.

Parameters
NameDescriptionStyleTypeDefault
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope21:pagedResult
list of all available workflow forms
Media typesapplication/json
application/yaml
application/xml

Submits a workflow form.

Request

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

Response

Content typesyncope21:user
updated user
Media typesapplication/json
application/yaml
application/xml

/forms/{taskId}/claim

Parameters
NameDescriptionStyleTypeDefault
taskIdworkflow task idtemplatexs:string

Claims the form for the given task id.

Response

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

/forms/{userKey}

Parameters
NameDescriptionStyleTypeDefault
userKeyuser keytemplatexs:string

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

Response

Content typesyncope21:workflowForm
list of available forms for the given user key
Media typesapplication/json
application/yaml
application/xml

/tasks/{taskId}/execute

Parameters
NameDescriptionStyleTypeDefault
taskIdworkflow task idtemplatexs:string

Executes workflow task for matching id.

Request

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

Response

Content typesyncope21:user
updated user
Media typesapplication/json
application/yaml
application/xml

/tasks/{userKey}

Parameters
NameDescriptionStyleTypeDefault
userKeyuser keytemplatexs:string

Returns a list of available tasks for the given user key.

Response

Content typesyncope21:workflowTasks
list of available tasks for the given user key
Media types*/*

/workflows

REST operations for workflow definition.

/{anyType}

Parameters
NameDescriptionStyleTypeDefault
anyTypeany object typetemplatexs:string

Lists the available workflow definitions, for the given any object type.

Response

Content typesyncope21:workflowDefinitions
available workflow definitions, for the given any object type
Media typesapplication/json
application/yaml
application/xml

/{anyType}/{key}

Parameters
NameDescriptionStyleTypeDefault
anyTypeany object typetemplatexs:string
keyworkflow definition keytemplatexs:string

Removes the workflow definition for matching any object type, under the provided key.

Response

Status204

Exports the workflow definition for matching any object type and key.

Response

Content type
workflow definition for matching any object type and key
Media typesapplication/json
application/yaml
application/xml

Imports the workflow definition for matching any object type, under the provided key.

Request

Content typexs:string
Media typesapplication/json
application/yaml
application/xml

Response

Status204

/{anyType}/{key}/diagram.png

Parameters
NameDescriptionStyleTypeDefault
anyTypeany object typetemplatexs:string
keyworkflow definition keytemplatexs:string

Exports the workflow diagram representation (if available), for matching any object type and key.

Response

Content type
workflow diagram representation
Media typesimage/png