Prefix | URI | XSD | WADL |
---|---|---|---|
syncope21 | http://syncope.apache.org/2.1 | syncope21.xsd | syncope.wadl |
General info about this Apache Syncope deployment.
Name | Description | Style | Type | Default |
---|---|---|---|---|
realm | template | xs:string |
Name | Description | Style | Type | Default |
---|---|---|---|---|
term | query | xs:string | ||
page | query | xs:int | 1 | |
size | query | xs:int | 25 |
Content type | syncope21:pagedResult |
Media types | application/json application/yaml application/xml |
Gets batch results, in case asynchronous was requested.
Content type | batch results as Response entity |
Media types | multipart/mixed |
Requests for batch execution.
Content type | batch request |
Media types | multipart/mixed |
Content type | batch results returned as Response entity, in case no 'Prefer: respond-async' was specified |
Media types | multipart/mixed |
Evicts all entities from cache.
Status | 204 |
Provides some numbers about the managed entities (users, groups, any objects...).
Content type | syncope21:numbersInfo some numbers about the managed entities (users, groups, any objects...) |
Media types | application/json application/yaml application/xml |
Provides information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...).
Content type | syncope21:platformInfo information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...) |
Media types | application/json application/yaml application/xml |
Provides entity cache statistics information.
Content type | cache statistics |
Media types | application/json application/yaml application/xml |
Operates on entity cache statistics.
Name | Description | Style | Type | Default |
---|---|---|---|---|
operation | enable, disable or reset entity cache statistics | query | xs:string |
Content type | |
Media types | application/json application/yaml application/xml |
Provides information about the underlying system (Operating System, CPU / memory usage, ...).
Content type | syncope21:systemInfo information about the underlying system (Operating System, CPU / memory usage, ...) |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
groupName | group name | template | xs:string |
Extracts User type extension information, for the provided group.
Content type | syncope21:typeExtension User type extension information, for the provided group |
Media types | application/json application/yaml application/xml |
REST operations for access tokens.
Returns a paged list of existing access tokens matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
size | query conditions | query | xs:int | 25 |
orderBy | query conditions | query | xs:string | |
page | query conditions | query | xs:int | 1 |
Content type | syncope21:pagedResult paged list of existing access tokens matching the given query |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | access token key | template | xs:string |
Invalidates the access token matching the provided key.
Status | 204 |
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.
Content type | empty response bearing the X-Syncope-Token header value, in case of successful authentication |
Media types | application/json application/yaml application/xml |
Invalidates the access token of the requesting user.
Status | 204 |
Returns an empty response bearing the X-Syncope-Token header value, with extended lifetime. The provided value is a signed JSON Web Token.
Content type | an empty response bearing the X-Syncope-Token header value, with extended lifetime |
Media types | application/json application/yaml application/xml |
REST operations for anyObjects.
Returns a paged list of any objects matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
realm | query conditions | query | xs:string | / |
fiql | query conditions | query | xs:string | |
details | query conditions | query | xs:boolean | true |
size | query conditions | query | xs:int | 25 |
orderBy | query conditions | query | xs:string | |
page | query conditions | query | xs:int | 1 |
Content type | syncope21:pagedResult paged list of any objects matching the given query |
Media types | application/json application/yaml application/xml |
Creates a new any object.
Content type | syncope21:anyObject any object to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created any object as well as the any object itself enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | any object key or name | template | xs:string |
Deletes any object matching provided key.
Content type | Response object featuring the deleted any object enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Reads the any object matching the provided key.
Content type | syncope21:anyObject any object with matching key |
Media types | application/json application/yaml application/xml |
Updates any object matching the provided key.
Content type | syncope21:anyObjectPatch modification to be applied to any object matching the provided key |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated any object enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Updates any object matching the provided key.
Content type | syncope21:anyObject modification to be applied to any object matching the provided key |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated any object enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | any object key or name | template | xs:string | |
schemaType | template | xs:string
|
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.
Content type | syncope21:attributes list of attributes, owned by the given any object, for the given schema type |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | any object key or name | template | xs:string | |
schemaType | template | xs:string
| ||
schema | schema | template | xs:string |
Deletes the attribute, owned by the given any object, for the given schema type and schema.
Status | 204 |
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.
Content type | syncope21:attribute attribute, owned by the given any object, for the given schema type and schema |
Media types | application/json application/yaml application/xml |
Adds or replaces the attribute, owned by the given any object, for the given schema type and schema.
Content type | syncope21:attribute attribute |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated any object attribute - as Entity |
Media types | application/json application/yaml application/xml |
Executes resource-related operations on given entity.
Content type | syncope21:associationPatch external resources to be used for propagation-related operations |
Media types | application/json application/yaml application/xml |
Content type | batch results as Response entity |
Media types | multipart/mixed |
Executes resource-related operations on given entity.
Content type | syncope21:deassociationPatch external resources to be used for propagation-related operations |
Media types | application/json application/yaml application/xml |
Content type | batch results as Response entity |
Media types | multipart/mixed |
REST operations for any type classes.
Returns a list of all anyTypeClasss.
Content type | syncope21:anyTypeClasss list of all anyTypeClasss. |
Media types | application/json application/yaml application/xml |
Creates a new anyTypeClass.
Content type | syncope21:anyTypeClass anyTypeClass to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created anyTypeClass |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | anyTypeClass key to be deleted | template | xs:string |
Deletes the anyTypeClass matching the provided key.
Status | 204 |
Returns anyTypeClass with matching key.
Content type | syncope21:anyTypeClass anyTypeClass with matching key |
Media types | application/json application/yaml application/xml |
Updates the anyTypeClass matching the provided key.
Content type | syncope21:anyTypeClass anyTypeClass to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
REST operations for any types.
Returns a list of all anyTypes.
Content type | syncope21:anyTypes list of all anyTypes. |
Media types | application/json application/yaml application/xml |
Creates a new anyType.
Content type | syncope21:anyType anyType to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created anyType |
Media types | */* |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | anyType key to be deleted | template | xs:string |
Deletes the anyType matching the provided key.
Status | 204 |
Returns anyType with matching key.
Content type | syncope21:anyType anyType with matching key |
Media types | application/json application/yaml application/xml |
Updates the anyType matching the provided key.
Content type | syncope21:anyType anyType to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
REST operations for applications.
Returns a list of all applications.
Content type | syncope21:applications list of all applications. |
Media types | application/json application/yaml application/xml |
Creates a new application.
Content type | syncope21:application application to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created application |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | application key to be deleted | template | xs:string |
Deletes the application matching the provided key.
Status | 204 |
Returns application with matching key.
Content type | syncope21:application application with matching key |
Media types | application/json application/yaml application/xml |
Updates the application matching the provided key.
Content type | syncope21:application application to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | privilege key to be read | template | xs:string |
Returns privilege with matching key.
Content type | syncope21:privilege privilege with matching key |
Media types | application/json application/yaml application/xml |
REST operations for Camel routes.
Name | Description | Style | Type | Default |
---|---|---|---|---|
anyTypeKind | template | xs:string
|
List all routes for the given any type kind.
Content type | syncope21:camelRoutes all routes for the given any type kind |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
anyTypeKind | template | xs:string
| ||
key | route key | template | xs:string |
Read the route with the given key.
Content type | syncope21:camelRoute route with given key |
Media types | application/json application/yaml application/xml |
Update the given route.
Content type | syncope21:camelRoute to be updated |
Media types | application/json application/yaml application/xml |
Status | 204 |
Provides Camel metrics.
Content type | syncope21:camelMetrics Camel metrics |
Media types | application/json application/yaml application/xml |
Restart the underlying Apache Camel context.
Status | 204 |
REST operations for configuration.
Returns all configuration parameters.
Content type | syncope21:attributes all configuration parameters |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
schema | configuration parameter schema | template | xs:string |
Deletes the configuration parameter with matching schema.
Status | 204 |
Returns configuration parameter with matching schema.
Content type | syncope21:attribute configuration parameter with matching schema |
Media types | application/json application/yaml application/xml |
Creates / updates the configuration parameter with the given schema.
Content type | syncope21:attribute parameter value |
Media types | application/json application/yaml application/xml |
Status | 204 |
Exports internal storage content as downloadable XML file.
Content type | internal storage content as downloadable XML file |
Media types | */* |
REST operations for connector bundles and instances.
Returns a list of all connector instances with property keys in the matching language.
Name | Description | Style | Type | Default |
---|---|---|---|---|
lang | language 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. | query | xs:string |
Content type | syncope21:connInstances list of all connector instances with property keys in the matching language |
Media types | application/json application/yaml application/xml |
Creates a new connector instance.
Content type | syncope21:connInstance connector instance to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created connector instance |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | connector instance key to be deleted | template | xs:string |
Deletes the connector instance matching the provided key.
Status | 204 |
Returns connector instance with matching key.
Name | Description | Style | Type | Default |
---|---|---|---|---|
lang | language 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. | query | xs:string |
Content type | syncope21:connInstance connector instance with matching key |
Media types | application/json application/yaml application/xml |
Updates the connector instance matching the provided key.
Content type | syncope21:connInstance connector instance to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
Builds the list of ConnId object classes information for the connector bundle matching the given connector instance key, with the provided configuration.
Name | Description | Style | Type | Default |
---|---|---|---|---|
includeSpecial | if set to true, special schema names (like '__PASSWORD__') will be included; default is false | query | xs:boolean | false |
Content type | syncope21:connInstance connector instance object providing configuration properties |
Media types | application/json application/yaml application/xml |
Content type | syncope21:connIdObjectClasss supported object classes info for the connector bundle matching the given connector instance key, with the provided configuration |
Media types | application/json application/yaml application/xml |
Returns available connector bundles with property keys in selected language.
Name | Description | Style | Type | Default |
---|---|---|---|---|
lang | language to select property keys; default language is English | query | xs:string |
Content type | syncope21:connectorBundles available connector bundles with property keys in selected language |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
resourceName | resource name to be used for connector lookup | template | xs:string |
Returns connector instance for matching resource.
Name | Description | Style | Type | Default |
---|---|---|---|---|
lang | language 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. | query | xs:string |
Content type | syncope21:connInstance connector instance for matching resource |
Media types | application/json application/yaml application/xml |
Checks whether the connection to resource could be established.
Content type | syncope21:connInstance connector instance to be used for connection check |
Media types | application/json application/yaml application/xml |
Status | 204 |
Reload all connector bundles and instances.
Status | 204 |
REST operations for delegations.
Returns a list of all delegations.
Content type | syncope21:delegations list of all delegations. |
Media types | application/json application/yaml application/xml |
Creates a new delegation.
Content type | syncope21:delegation delegation to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created delegation |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | delegation key to be deleted | template | xs:string |
Deletes the delegation matching the provided key.
Status | 204 |
Returns delegation with matching key.
Content type | syncope21:delegation delegation with matching key |
Media types | application/json application/yaml application/xml |
Updates the delegation matching the provided key.
Content type | syncope21:delegation delegation to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
REST operations for domains.
Returns a list of all domains.
Content type | syncope21:domains list of all domains. |
Media types | application/json application/yaml application/xml |
Creates a new domain.
Content type | syncope21:domain domain to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created domain |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | domain key to be deleted | template | xs:string |
Deletes the domain matching the provided key.
Status | 204 |
Returns domain with matching key.
Content type | syncope21:domain domain with matching key |
Media types | application/json application/yaml application/xml |
Updates the domain matching the provided key.
Content type | syncope21:domain domain to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
REST operations for dynamic realms.
Returns a list of all dynamic realms.
Content type | syncope21:dynRealms list of all dynamic realms. |
Media types | application/json application/yaml application/xml |
Creates a new dynamic realm.
Content type | syncope21:dynRealm dynamic realm to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created dynamic realm |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | dynamic realm key to be deleted | template | xs:string |
Deletes the dynamic realm matching the provided key.
Status | 204 |
Returns dynamic realm with matching key.
Content type | syncope21:dynRealm dynamic realm with matching key |
Media types | application/json application/yaml application/xml |
Updates the dynamic realm matching the provided key.
Content type | syncope21:dynRealm dynamic realm to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
REST operations for BPMN processes.
Lists the available BPMN processes.
Content type | syncope21:bpmnProcesss available BPMN processs |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | BPMN process key | template | xs:string |
Removes the BPMN process under the provided key.
Status | 204 |
Exports the BPMN process for matching key.
Content type | BPMN process for matching key |
Media types | application/json application/xml |
Imports the BPMN process under the provided key.
Content type | xs:string |
Media types | application/json application/xml |
Status | 204 |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | BPMN process key | template | xs:string |
Exports the BPMN diagram representation (if available), for matching key.
Content type | BPMN diagram representation |
Media types | image/png |
REST operations related to user workflow.
Returns a list of running user requests matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
user | query conditions | query | xs:string | |
size | query conditions | query | xs:int | 25 |
orderBy | query conditions | query | xs:string | |
page | query conditions | query | xs:int | 1 |
Content type | syncope21:pagedResult list of all running user requests |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
executionId | execution id | template | xs:string |
Cancel a running user request.
Name | Description | Style | Type | Default |
---|---|---|---|---|
reason | reason to cancel the user request | query | xs:string |
Status | 204 |
Returns a list of user request forms matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
user | query conditions | query | xs:string | |
size | query conditions | query | xs:int | 25 |
orderBy | query conditions | query | xs:string | |
page | query conditions | query | xs:int | 1 |
Content type | syncope21:pagedResult list of all available user request forms |
Media types | application/json application/yaml application/xml |
Submits a user request form.
Content type | syncope21:userRequestForm user request form. |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated user enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
taskId | workflow task id | template | xs:string |
Requests to manage the form for the given task id.
Content type | syncope21:userRequestForm the form for the given task id |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
taskId | workflow task id | template | xs:string |
Cancels request to manage the form for the given task id.
Content type | syncope21:userRequestForm the workflow form for the given task id |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
username | username of the logged user | template | xs:string | |
taskId | workflow task id | template | xs:string |
Returns a user request form matching the given task id.
Content type | syncope21:userRequestForm the form for the given task id |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
bpmnProcess | BPMN process | template | xs:string |
Starts a new request for the given BPMN Process and user (if provided) or requesting user (if not provided).
Name | Description | Style | Type | Default |
---|---|---|---|---|
user | if value looks like a UUID then it is interpreted as key otherwise as a username | query | xs:string |
Content type | syncope21:workflowTaskExecInput initial request variables |
Media types | */* |
Content type | syncope21:userRequest data about the started request service, including execution id |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
userKey | user key | template | xs:string |
Returns a list of available tasks for the given user key.
Content type | syncope21:workflowTasks list of available tasks for the given user key |
Media types | application/json application/yaml application/xml |
Executes the next workflow task available, for matching user key.
Content type | syncope21:workflowTaskExecInput input for task execution |
Media types | application/json application/yaml application/xml |
Content type | syncope21:user updated user |
Media types | application/json application/yaml application/xml |
REST operations for groups.
Returns a paged list of any objects matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
realm | query conditions | query | xs:string | / |
fiql | query conditions | query | xs:string | |
details | query conditions | query | xs:boolean | true |
size | query conditions | query | xs:int | 25 |
orderBy | query conditions | query | xs:string | |
page | query conditions | query | xs:int | 1 |
Content type | syncope21:pagedResult paged list of any objects matching the given query |
Media types | application/json application/yaml application/xml |
Creates a new group.
Content type | syncope21:group group to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created group as well as the any object itself enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | any object key or name | template | xs:string |
Deletes any object matching provided key.
Content type | Response object featuring the deleted any object enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Reads the any object matching the provided key.
Content type | syncope21:group any object with matching key |
Media types | application/json application/yaml application/xml |
Updates group matching the provided key.
Content type | syncope21:groupPatch modification to be applied to group matching the provided key |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated group enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Updates group matching the provided key.
Content type | syncope21:group modification to be applied to group matching the provided key |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated group enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | any object key or name | template | xs:string | |
schemaType | template | xs:string
|
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.
Content type | syncope21:attributes list of attributes, owned by the given any object, for the given schema type |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | any object key or name | template | xs:string | |
schemaType | template | xs:string
| ||
schema | schema | template | xs:string |
Deletes the attribute, owned by the given any object, for the given schema type and schema.
Status | 204 |
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.
Content type | syncope21:attribute attribute, owned by the given any object, for the given schema type and schema |
Media types | application/json application/yaml application/xml |
Adds or replaces the attribute, owned by the given any object, for the given schema type and schema.
Content type | syncope21:attribute attribute |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated any object attribute - as Entity |
Media types | application/json application/yaml application/xml |
Executes resource-related operations on given entity.
Content type | syncope21:associationPatch external resources to be used for propagation-related operations |
Media types | application/json application/yaml application/xml |
Content type | batch results as Response entity |
Media types | multipart/mixed |
Executes resource-related operations on given entity.
Content type | syncope21:deassociationPatch external resources to be used for propagation-related operations |
Media types | application/json application/yaml application/xml |
Content type | batch results as Response entity |
Media types | multipart/mixed |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | group key | template | xs:string | |
action | template | xs:string
|
(De)provision all members of the given group from / onto all the resources associated to it.
Content type | syncope21:exec execution report for the task generated on purpose |
Media types | application/json application/yaml application/xml |
This method allows a user to read his own groups.
Content type | syncope21:groups own groups |
Media types | application/json application/yaml application/xml |
REST operations for implementations.
Name | Description | Style | Type | Default |
---|---|---|---|---|
type | template | xs:string
|
Returns a list of all implementations of the given type.
Content type | syncope21:implementations list of all implementations. |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
type | template | xs:string
| ||
key | key for implementation to be deleted | template | xs:string |
Deletes the implementation matching the given key and type.
Content type | an empty response if operation was successful |
Media types | application/json application/yaml application/xml |
Returns implementation with matching type and key.
Content type | syncope21:implementation implementation with matching key |
Media types | application/json application/yaml application/xml |
Creates a new implementation.
Content type | syncope21:implementation implementation. |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created implementation |
Media types | application/json application/yaml application/xml |
Updates an existing implementation.
Content type | syncope21:implementation implementation. |
Media types | application/json application/yaml application/xml |
Content type | an empty response if operation was successful |
Media types | application/json application/yaml application/xml |
REST operations for logging and auditing.
Name | Description | Style | Type | Default |
---|---|---|---|---|
type | template | xs:string
|
Returns a list of loggers with matching type.
Content type | syncope21:loggers list of loggers with matching type |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
type | template | xs:string
|
Creates or updates (if existing) the logger with matching name.
Content type | syncope21:logger Logger to be created or updated |
Media types | application/json application/yaml application/xml |
Status | 204 |
Name | Description | Style | Type | Default |
---|---|---|---|---|
type | template | xs:string
| ||
name | Logger name to be deleted | template | xs:string |
Deletes the logger with matching name.
Status | 204 |
Returns logger with matching type and name.
Content type | syncope21:logger logger with matching type and name |
Media types | application/json application/yaml application/xml |
Returns a paged list of audit entries matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
type | query | xs:string
| ||
result | query | xs:string
| ||
category | query conditions | query | xs:string | |
events | query conditions | query | xs:string | |
subcategory | query conditions | query | xs:string | |
entityKey | query conditions | query | xs:string | |
size | query conditions | query | xs:int | 25 |
orderBy | query conditions | query | xs:string | |
page | query conditions | query | xs:int | 1 |
Content type | syncope21:pagedResult paged list of audit entries matching the given query |
Media types | application/json application/yaml application/xml |
Returns the list of all managed events in audit.
Content type | syncope21:eventCategorys list of all managed events in audit |
Media types | application/json application/yaml application/xml |
Returns the list of memory appenders available in the current logging configuration.
Content type | syncope21:logAppenders the list of memory appenders available in the current logging configuration |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
memoryAppender | memory appender name | template | xs:string |
Return the last log statements available in the provided memory appender.
Content type | syncope21:logStatements the last log statements available in the provided memory appender |
Media types | application/json application/yaml application/xml |
REST operations for mail templates.
Returns a list of all mail templates.
Content type | syncope21:mailTemplates list of all mail templates. |
Media types | application/json application/yaml application/xml |
Creates a new mail template.
Content type | syncope21:mailTemplate Creates a new mail template. |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created mail template |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | key for mail template to be deleted | template | xs:string |
Deletes the mail template matching the given key.
Status | 204 |
Returns mail template with matching key.
Content type | syncope21:mailTemplate mail template with matching key |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | mail template | template | xs:string | |
format | template | xs:string
|
Removes the template for the given key and format, if available.
Status | 204 |
Gets the template for the given key and format, if available.
Content type | mail template with matching key and format, if available |
Media types | */* |
Sets the template for the given key and format, if available.
Content type | template to be set |
Media types | */* |
Status | 204 |
REST operations for notifications.
Returns a list of all notifications.
Content type | syncope21:notifications list of all notifications. |
Media types | application/json application/yaml application/xml |
Creates a new notification.
Content type | syncope21:notification Creates a new notification. |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created notification |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | key for notification to be deleted | template | xs:string |
Deletes the notification matching the given key.
Status | 204 |
Returns notification with matching key.
Content type | syncope21:notification notification with matching key |
Media types | application/json application/yaml application/xml |
Updates the notification matching the given key.
Content type | syncope21:notification notification to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
Returns details about notification job.
Content type | syncope21:job details about notification job |
Media types | application/json application/yaml application/xml |
Executes an action on the notification job.
Name | Description | Style | Type | Default |
---|---|---|---|---|
action | query | xs:string
|
Status | 204 |
REST operations for OpenID Connect Clients.
Uses the provided authorization code to go through the OpenID Connect tokens process and finally creates JWT for the matching user, if found.
Name | Description | Style | Type | Default |
---|---|---|---|---|
redirect_uri | redirect URI | query | xs:string | |
authorizationCode | authorization code generated by the remote OpenID Connect Provider | query | xs:string | |
op | OpenID Connect Provider | query | xs:string |
Content type | syncope21:oidcLoginResponse JWT for the matching user plus attributes returned in the response |
Media types | application/json application/yaml application/xml |
Generates OpenID Connect authentication request for the Provider matching the provided op.
Name | Description | Style | Type | Default |
---|---|---|---|---|
redirect_uri | redirect URI | query | xs:string | |
op | OpenID Connect Provider | query | xs:string |
Content type | syncope21:oidcLoginRequest OpenID Connect authentication request |
Media types | application/json application/yaml application/xml |
Returns the endSession endpoint for the provided op.
Name | Description | Style | Type | Default |
---|---|---|---|---|
op | OpenID Connect Provider | query | xs:string |
Content type | syncope21:oidcLogoutRequest endSession endpoint for the provided op |
Media types | application/json application/yaml application/xml |
REST operations for OpenID Connect Providers.
Returns a list of all defined OIDC Providers.
Content type | syncope21:oidcproviders list of all defined OIDC Providers |
Media types | application/json application/yaml application/xml |
Creates a new OIDC Provider.
Content type | syncope21:oidcprovider OpenID Connect Provider configuration to be stored |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created OIDC Provider |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | OIDC Provider key | template | xs:string |
Deletes the OIDC Provider with matching key.
Status | 204 |
Returns the OIDC Provider with matching key, if available.
Content type | syncope21:oidcprovider OIDC Providers with matching key, if available |
Media types | application/json application/yaml application/xml |
Updates the OIDC Provider with matching key.
Content type | syncope21:oidcprovider OpenID Connect Provider configuration to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
Returns the list of available OIDCProviderActions implementations.
Content type | the list of available OIDCProviderActions implementations |
Media types | application/json |
Creates a new OIDC Provider by using its Discovery Document.
Content type | syncope21:oidcprovider OpenID Connect Provider configuration to be stored |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created OIDC Provider |
Media types | application/json application/yaml application/xml |
REST operations for policies.
Name | Description | Style | Type | Default |
---|---|---|---|---|
type | template | xs:string
|
Returns a list of policies of the matching type.
Content type | syncope21:policys list of policies with matching type |
Media types | application/json application/yaml application/xml |
Create a new policy.
Content type | syncope21:policy Policy to be created (needs to match type) |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created policy |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
type | template | xs:string
| ||
key | key of policy to be deleted | template | xs:string |
Delete policy matching the given key.
Status | 204 |
Returns the policy matching the given key.
Content type | syncope21:policy policy with matching id |
Media types | application/json application/yaml application/xml |
Updates policy matching the given key.
Content type | syncope21:policy Policy to replace existing policy |
Media types | application/json application/yaml application/xml |
Status | 204 |
REST operations for realms.
Name | Description | Style | Type | Default |
---|---|---|---|---|
fullPath | realm path | template | xs:string |
Deletes the realm under the given path.
Content type | Response object featuring the deleted realm enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Returns realms rooted at the given path, including descendant realms.
Content type | syncope21:realms realms rooted at the given path, including descendant realms |
Media types | application/json application/yaml application/xml |
Updates the realm under the given path.
Content type | syncope21:realm realm to be stored |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated realm enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
parentPath | full path of the parent realm | template | xs:string |
Creates a new realm under the given path.
Content type | syncope21:realm new realm |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created realm as well as the realm itself enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Returns a list of existing realms matching the given query (not including descendant realms) and the total number of descendant realms.
Name | Description | Style | Type | Default |
---|---|---|---|---|
keyword | query conditions | query | xs:string | |
base | query conditions | query | xs:string |
Content type | syncope21:pagedResult list of existing realms matching the given query (not including descendant realms) and the total number of descedant realms |
Media types | application/json application/yaml application/xml |
REST operations for reconciliation.
Gets compared status between attributes in Syncope and on the given External Resource.
Name | Description | Style | Type | Default |
---|---|---|---|---|
moreAttrsToGet | query conditions | query | xs:string | |
resourceKey | query conditions | query | xs:string | |
fiql | query conditions | query | xs:string | |
anyKey | query conditions | query | xs:string | |
anyTypeKey | query conditions | query | xs:string |
Content type | syncope21:reconStatus reconciliation status |
Media types | application/json application/yaml application/xml |
Pulls the matching user, group, any object or linked account from the External Resource into Syncope.
Name | Description | Style | Type | Default |
---|---|---|---|---|
ignoreColumns | query conditions | query | xs:string | |
pullCorrelationRule | query conditions | query | xs:string | |
keyColumn | query conditions | query | xs:string | |
destinationRealm | query conditions | query | xs:string | |
remediation | query conditions | query | xs:boolean | |
conflictResolutionAction | query | xs:string
| ||
provisioningActions | query conditions | query | xs:string | |
escapeChar | query conditions | query | ||
lineSeparator | query conditions | query | xs:string | |
nullValue | query conditions | query | xs:string | |
columnSeparator | query conditions | query | ||
arrayElementSeparator | query conditions | query | xs:string | |
quoteChar | query conditions | query | ||
allowComments | query conditions | query | xs:boolean | |
matchingRule | query | xs:string
| ||
unmatchingRule | query | xs:string
| ||
anyTypeKey | query conditions | query | xs:string |
Content type | pull specification |
Media types | text/csv |
Content type | syncope21:provisioningReports pull report |
Media types | application/json application/yaml application/xml |
Pushes the matching user, group, any object or linked account in Syncope onto the External Resource.
Name | Description | Style | Type | Default |
---|---|---|---|---|
realm | query conditions | query | xs:string | / |
fiql | query conditions | query | xs:string | |
details | query conditions | query | xs:boolean | true |
size | query conditions | query | xs:int | 25 |
orderBy | query conditions | query | xs:string | |
page | query conditions | query | xs:int | 1 |
plainAttrs | query conditions | query | xs:string | |
derAttrs | query conditions | query | xs:string | |
virAttrs | query conditions | query | xs:string | |
ignorePaging | query conditions | query | xs:boolean | false |
propagationActions | query conditions | query | xs:string | |
fields | query conditions | query | xs:string | |
provisioningActions | query conditions | query | xs:string | |
escapeChar | query conditions | query | ||
lineSeparator | query conditions | query | xs:string | |
nullValue | query conditions | query | xs:string | |
columnSeparator | query conditions | query | ||
arrayElementSeparator | query conditions | query | xs:string | |
quoteChar | query conditions | query | ||
allowComments | query conditions | query | xs:boolean | |
matchingRule | query | xs:string
| ||
unmatchingRule | query | xs:string
| ||
anyTypeKey | query conditions | query | xs:string | |
realm | query conditions | query | xs:string | / |
fiql | query conditions | query | xs:string | |
details | query conditions | query | xs:boolean | true |
size | query conditions | query | xs:int | 25 |
orderBy | query conditions | query | xs:string | |
page | query conditions | query | xs:int | 1 |
plainAttrs | query conditions | query | xs:string | |
derAttrs | query conditions | query | xs:string | |
virAttrs | query conditions | query | xs:string | |
ignorePaging | query conditions | query | xs:boolean | false |
propagationActions | query conditions | query | xs:string | |
fields | query conditions | query | xs:string | |
provisioningActions | query conditions | query | xs:string | |
escapeChar | query conditions | query | ||
lineSeparator | query conditions | query | xs:string | |
nullValue | query conditions | query | xs:string | |
columnSeparator | query conditions | query | ||
arrayElementSeparator | query conditions | query | xs:string | |
quoteChar | query conditions | query | ||
allowComments | query conditions | query | xs:boolean | |
matchingRule | query | xs:string
| ||
unmatchingRule | query | xs:string
| ||
anyTypeKey | query conditions | query | xs:string |
Content type | push report |
Media types | text/csv |
Pulls the matching user, group, any object or linked account from the External Resource into Syncope.
Name | Description | Style | Type | Default |
---|---|---|---|---|
moreAttrsToGet | query conditions | query | xs:string | |
resourceKey | query conditions | query | xs:string | |
fiql | query conditions | query | xs:string | |
anyKey | query conditions | query | xs:string | |
anyTypeKey | query conditions | query | xs:string |
Content type | syncope21:pullTask pull specification |
Media types | application/json application/yaml application/xml |
Content type | syncope21:provisioningReports pull report |
Media types | application/json application/yaml application/xml |
Pushes the matching user, group, any object or linked account in Syncope onto the External Resource.
Name | Description | Style | Type | Default |
---|---|---|---|---|
moreAttrsToGet | query conditions | query | xs:string | |
resourceKey | query conditions | query | xs:string | |
fiql | query conditions | query | xs:string | |
anyKey | query conditions | query | xs:string | |
anyTypeKey | query conditions | query | xs:string |
Content type | syncope21:pushTask push specification |
Media types | application/json application/yaml application/xml |
Content type | syncope21:provisioningReports push report |
Media types | application/json application/yaml application/xml |
REST operations for relationship types.
Returns a list of all relationshipTypes.
Content type | syncope21:relationshipTypes list of all relationshipTypes. |
Media types | application/json application/yaml application/xml |
Creates a new relationshipType.
Content type | syncope21:relationshipType relationshipType to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created relationshipType |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | relationshipType key to be deleted | template | xs:string |
Deletes the relationshipType matching the provided key.
Status | 204 |
Returns relationshipType with matching key.
Content type | syncope21:relationshipType relationshipType with matching key |
Media types | application/json application/yaml application/xml |
Updates the relationshipType matching the provided key.
Content type | syncope21:relationshipType relationshipType to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
REST operations for remediations.
Returns a list of all remediations.
Name | Description | Style | Type | Default |
---|---|---|---|---|
size | query conditions | query | xs:int | 25 |
orderBy | query conditions | query | xs:string | |
page | query conditions | query | xs:int | 1 |
Content type | syncope21:pagedResult list of all remediations. |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | key for remediation to be deleted | template | xs:string |
Deletes the remediation matching the given key.
Content type | an empty response if operation was successful |
Media types | application/json application/yaml application/xml |
Returns remediation with matching key.
Content type | syncope21:remediation remediation with matching key |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
remediationKey | key for remediation to act on | template | xs:string |
Perform remediation by creating the provided user, group or any object.
Content type | syncope21:anyPatch user, group or any object to create |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created object as well as the object itself enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Perform remediation by creating the provided user, group or any object.
Content type | syncope21:anyTO user, group or any object to create |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created object as well as the object itself enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
remediationKey | key for remediation to act on | template | xs:string | |
anyKey | user, group or any object to create | template | xs:string |
Perform remediation by creating the provided user, group or any object.
Content type | Response object featuring Location header of created object as well as the object itself enriched with propagation status information |
Media types | application/json application/yaml application/xml |
REST operations for reports.
Returns a list of all existing reports.
Content type | syncope21:reports paged list of existing reports matching the given query |
Media types | application/json application/yaml application/xml |
Creates a new report.
Content type | syncope21:report report to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created report |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | Deletes report with matching key | template | xs:string |
Deletes report with matching key.
Status | 204 |
Returns report with matching key.
Content type | syncope21:report report with matching key |
Media types | application/json application/yaml application/xml |
Updates report with matching key.
Content type | syncope21:report report to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | query conditions | template | xs:string |
Executes the executable matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
dryRun | query conditions | query | xs:boolean | false |
startAt | query conditions | query | xs:dateTime |
Content type | syncope21:exec execution report for the executable matching the given query |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | query conditions | template | xs:string |
Deletes the executions belonging matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
endedBefore | query conditions | query | xs:dateTime | |
endedAfter | query conditions | query | xs:dateTime | |
startedBefore | query conditions | query | xs:dateTime | |
startedAfter | query conditions | query | xs:dateTime |
Content type | batch results as Response entity |
Media types | multipart/mixed |
Returns a paged list of executions matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
size | query conditions | query | xs:int | 25 |
orderBy | query conditions | query | xs:string | |
page | query conditions | query | xs:int | 1 |
Content type | syncope21:pagedResult paged list of executions the given query |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
executionKey | key of executable execution to be deleted | template | xs:string |
Deletes the executable execution matching the provided key.
Status | 204 |
Name | Description | Style | Type | Default |
---|---|---|---|---|
executionKey | key of execution report to be selected | template | xs:string |
Exports the report execution with matching key in the requested format.
Name | Description | Style | Type | Default |
---|---|---|---|---|
format | query | xs:string
|
Content type | a stream for content download |
Media types | */* |
Returns the list of recently completed executions, ordered by end date descendent.
Name | Description | Style | Type | Default |
---|---|---|---|---|
max | the maximum number of executions to return | query | xs:int | 25 |
Content type | syncope21:execs list of recently completed executions, ordered by end date descendent |
Media types | application/json application/yaml application/xml |
List jobs (running and / or scheduled).
Content type | syncope21:jobs jobs (running and / or scheduled) |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | executable key | template | xs:string |
Returns job (running or scheduled) for the executable matching the given key.
Content type | syncope21:job job (running or scheduled) for the given key |
Media types | application/json application/yaml application/xml |
Executes an action on an existing executable's job.
Name | Description | Style | Type | Default |
---|---|---|---|---|
action | query | xs:string
|
Status | 204 |
REST operations for report templates.
Returns a list of all report templates.
Content type | syncope21:reportTemplates list of all report templates. |
Media types | application/json application/yaml application/xml |
Creates a new report template.
Content type | syncope21:reportTemplate Creates a new report template. |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created report template |
Media types | */* |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | key for report template to be deleted | template | xs:string |
Deletes the report template matching the given key.
Status | 204 |
Returns report template with matching key.
Content type | syncope21:reportTemplate report template with matching key |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | report template | template | xs:string | |
format | template | xs:string
|
Removes the template for the given key and format, if available.
Status | 204 |
Gets the template for the given key and format, if available.
Content type | report template with matching key and format, if available |
Media types | */* |
Sets the template for the given key and format, if available.
Content type | template to be set |
Media types | */* |
Status | 204 |
REST operations for external resources.
Returns a list of all resources.
Content type | syncope21:resources list of all resources |
Media types | application/json application/yaml application/xml |
Creates a new resource.
Content type | syncope21:resource Resource to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created resource |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | name of resource to be deleted | template | xs:string |
Deletes the resource matching the given name.
Status | 204 |
Returns the resource with matching name.
Content type | syncope21:resource resource with matching name |
Media types | application/json application/yaml application/xml |
Updates the resource matching the given name.
Content type | syncope21:resource resource to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | resource | template | xs:string | |
anyTypeKey | any type | template | xs:string |
Removes the sync token value associated to the given any type from the given resource.
Status | 204 |
Returns a paged list of connector objects from external resource, for the given type, matching page/size conditions.
Name | Description | Style | Type | Default |
---|---|---|---|---|
moreAttrsToGet | name of resource to read connector object from | query | xs:string | |
size | name of resource to read connector object from | query | xs:int | 25 |
fiql | name of resource to read connector object from | query | xs:string | |
pagedResultsCookie | name of resource to read connector object from | query | xs:string |
Content type | syncope21:pagedConnObjectResult connector objects from the external resource, for the given type |
Media types | application/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.
Status | 204 |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | name of resource to read connector object from | template | xs:string | |
anyTypeKey | any object type | template | xs:string | |
anyKey | user, group or any object key | template | xs:string |
Returns the calculated connObjectKey value for the given type and key.
Content type | connObjectKey value for the external resource, for the given type and key |
Media types | */* |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | name of resource to read connector object from | template | xs:string | |
anyTypeKey | any object type | template | xs:string | |
value | if value looks like a UUID then it is interpreted as user, group or any object key, otherwise as key value on the resource | template | xs:string |
Returns connector object from the external resource, for the given type and key.
Content type | syncope21:connObject connector object from the external resource, for the given type and key |
Media types | application/json application/yaml application/xml |
Checks whether the connection to resource could be established.
Content type | syncope21:resource resource to be checked |
Media types | application/json application/yaml application/xml |
Status | 204 |
REST operations for roles.
Returns a list of all roles.
Content type | syncope21:roles list of all roles. |
Media types | application/json application/yaml application/xml |
Creates a new role.
Content type | syncope21:role role to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created role |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | role key to be deleted | template | xs:string |
Deletes the role matching the provided key.
Status | 204 |
Returns role with matching key.
Content type | syncope21:role role with matching key |
Media types | application/json application/yaml application/xml |
Updates the role matching the provided key.
Content type | syncope21:role role to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | role key | template | xs:string |
Removes the console layout information for the role with the given key, if available.
Status | 204 |
Gets the console layout information as JSON string for the role with the given key, if available.
Content type | console layout information as JSON string for the role with the given key, if available |
Media types | application/json |
Sets the console layout information as JSON string for the role with the given key, if available.
Content type | console layout information to be set |
Media types | application/json |
Status | 204 |
REST operations for SAML 2.0 Identity Providers.
Returns a list of all defined SAML 2.0 Identity Providers.
Content type | syncope21:saml2idps list of all defined SAML 2.0 Identity Providers |
Media types | application/json application/yaml application/xml |
Imports the SAML 2.0 Identity Provider definitions available in the provided XML metadata.
Content type | XML metadata |
Media types | application/xml |
Content type | the entityID values for all imported SAML 2.0 Identity Providers |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | SAML 2.0 Identity Provider's entityID | template | xs:string |
Deletes the SAML 2.0 Identity Provider with matching entityID.
Status | 204 |
Returns the SAML 2.0 Identity Provider with matching entityID, if available.
Content type | syncope21:saml2idp SAML 2.0 Identity Provider with matching entityID, if available |
Media types | application/json application/yaml application/xml |
Updates the SAML 2.0 Identity Provider with matching entityID.
Content type | syncope21:saml2idp idp configuration to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
Returns the list of available SAML2IdPActions implementations.
Content type | the list of available SAML2IdPActions implementations |
Media types | application/json |
Returns the list of available RequestedAuthnContextProviders implementations.
Content type | the list of available RequestedAuthnContextProviders implementations |
Media types | application/json |
REST operations for the provided SAML 2.0 Service Provider.
Returns the XML metadata for the provided SAML 2.0 Service Provider.
Name | Description | Style | Type | Default |
---|---|---|---|---|
spEntityID | SAML 2.0 SP entity ID. | query | xs:string | |
urlContext | SAML 2.0 SP agent URL context | query | xs:string |
Content type | XML metadata for the provided SAML 2.0 Service Provider |
Media types | application/xml |
Generates SAML 2.0 authentication request for the IdP matching the provided entity ID.
Name | Description | Style | Type | Default |
---|---|---|---|---|
spEntityID | SAML 2.0 SP entity ID. | query | xs:string | |
idpEntityID | SAML 2.0 IdP entity ID. | query | xs:string |
Content type | syncope21:saml2request SAML 2.0 authentication request |
Media types | application/json application/yaml application/xml |
Validates the received SAML 2.0 authentication response and creates JWT for the matching user, if found.
Content type | syncope21:saml2ReceivedResponse SAML response and relay state |
Media types | application/json application/yaml application/xml |
Content type | syncope21:saml2LoginResponse JWT for the matching user plus attributes returned in the response |
Media types | application/json application/yaml application/xml |
Generates SAML 2.0 logout request for the IdP matching the requesting access token.
Name | Description | Style | Type | Default |
---|---|---|---|---|
spEntityID | SAML 2.0 SP entity ID. | query | xs:string |
Content type | syncope21:saml2request SAML 2.0 logout request |
Media types | application/json application/yaml application/xml |
Validates the received SAML 2.0 logout response.
Content type | syncope21:saml2ReceivedResponse SAML response and relay state |
Media types | application/json application/yaml application/xml |
Status | 204 |
REST operations for attribute schemas.
Name | Description | Style | Type | Default |
---|---|---|---|---|
type | template | xs:string
|
Returns a list of schemas matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
anyTypeClasses | actual SchemaTO | query | xs:string | |
keyword | actual SchemaTO | query | xs:string |
Content type | syncope21:schemas list of schemas with matching type, for the given anyTypeClass if provided, with keys containing keyword if provided |
Media types | application/json application/yaml application/xml |
Creates a new schema.
Content type | syncope21:schema schema to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created schema |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
type | template | xs:string
| ||
key | name of schema to be deleted | template | xs:string |
Deletes the schema matching the given type and key.
Status | 204 |
Returns schema matching the given type and key.
Content type | syncope21:schema schema matching the given type and name |
Media types | application/json application/yaml application/xml |
Updates the schema matching the given type and key.
Content type | syncope21:schema updated schema to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
REST operations for SCIM 2.0 configuration.
Reads SCIM configuration, generates empty if missing.
Content type | SCIM configuration |
Media types | application/json application/yaml application/xml |
Sets SCIM configuration.
Content type | SCIM configuration |
Media types | application/json application/yaml application/xml |
Status | 204 |
REST operations for security questions.
Returns a list of all security questions.
Content type | syncope21:securityQuestions list of all security questions |
Media types | application/json application/yaml application/xml |
Creates a new security question.
Content type | syncope21:securityQuestion security question to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created security question |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | security question key to be deleted | template | xs:string |
Deletes the security question matching the provided key.
Status | 204 |
Returns security question with matching key.
Content type | syncope21:securityQuestion security question with matching key |
Media types | application/json application/yaml application/xml |
Updates the security question matching the provided key.
Content type | syncope21:securityQuestion security question to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
Name | Description | Style | Type | Default |
---|---|---|---|---|
username | username for which the security question is requested | template | xs:string |
Ask for security question configured for the user matching the given username, if any.
Content type | syncope21:securityQuestion security question, if configured for the user matching the given username |
Media types | application/json application/yaml application/xml |
REST operations for tasks.
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | query conditions | template | xs:string |
Executes the executable matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
dryRun | query conditions | query | xs:boolean | false |
startAt | query conditions | query | xs:dateTime |
Content type | syncope21:exec execution report for the executable matching the given query |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | query conditions | template | xs:string |
Deletes the executions belonging matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
endedBefore | query conditions | query | xs:dateTime | |
endedAfter | query conditions | query | xs:dateTime | |
startedBefore | query conditions | query | xs:dateTime | |
startedAfter | query conditions | query | xs:dateTime |
Content type | batch results as Response entity |
Media types | multipart/mixed |
Returns a paged list of executions matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
size | query conditions | query | xs:int | 25 |
orderBy | query conditions | query | xs:string | |
page | query conditions | query | xs:int | 1 |
Content type | syncope21:pagedResult paged list of executions the given query |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
type | template | xs:string
|
Returns a paged list of existing tasks matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
resource | type of taskTO | query | xs:string | |
details | type of taskTO | query | xs:boolean | true |
anyTypeKind | query | xs:string
| ||
entityKey | type of taskTO | query | xs:string | |
notification | type of taskTO | query | xs:string | |
size | type of taskTO | query | xs:int | 25 |
orderBy | type of taskTO | query | xs:string | |
page | type of taskTO | query | xs:int | 1 |
Content type | syncope21:pagedResult paged list of existing tasks matching the given query |
Media types | application/json application/yaml application/xml |
Creates a new task.
Content type | syncope21:schedTask task to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created task |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
type | template | xs:string
| ||
key | key of task to be deleted | template | xs:string |
Deletes the task matching the provided key.
Status | 204 |
Returns the task matching the given key.
Name | Description | Style | Type | Default |
---|---|---|---|---|
details | key of task to be read | query | xs:boolean | true |
Content type | syncope21:task task with matching id |
Media types | application/json application/yaml application/xml |
Updates the task matching the provided key.
Content type | syncope21:schedTask updated task to be stored |
Media types | application/json application/yaml application/xml |
Status | 204 |
Name | Description | Style | Type | Default |
---|---|---|---|---|
executionKey | key of executable execution to be deleted | template | xs:string |
Deletes the executable execution matching the provided key.
Status | 204 |
Returns the list of recently completed executions, ordered by end date descendent.
Name | Description | Style | Type | Default |
---|---|---|---|---|
max | the maximum number of executions to return | query | xs:int | 25 |
Content type | syncope21:execs list of recently completed executions, ordered by end date descendent |
Media types | application/json application/yaml application/xml |
List jobs (running and / or scheduled).
Content type | syncope21:jobs jobs (running and / or scheduled) |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | executable key | template | xs:string |
Returns job (running or scheduled) for the executable matching the given key.
Content type | syncope21:job job (running or scheduled) for the given key |
Media types | application/json application/yaml application/xml |
Executes an action on an existing executable's job.
Name | Description | Style | Type | Default |
---|---|---|---|---|
action | query | xs:string
|
Status | 204 |
Deletes all the propagation tasks whose latest execution is matching the given conditions. At least one matching condition must be specified.
Name | Description | Style | Type | Default |
---|---|---|---|---|
since | match all executions started afterwards | query | xs:dateTime | |
statuses | query | xs:string
| ||
resources | external resource(s) to match | query | xs:string |
Content type | deleted propagation tasks |
Media types | application/json application/yaml application/xml |
REST operations for users.
Returns a paged list of any objects matching the given query.
Name | Description | Style | Type | Default |
---|---|---|---|---|
realm | query conditions | query | xs:string | / |
fiql | query conditions | query | xs:string | |
details | query conditions | query | xs:boolean | true |
size | query conditions | query | xs:int | 25 |
orderBy | query conditions | query | xs:string | |
page | query conditions | query | xs:int | 1 |
Content type | syncope21:pagedResult paged list of any objects matching the given query |
Media types | application/json application/yaml application/xml |
Creates a new user.
Name | Description | Style | Type | Default |
---|---|---|---|---|
storePassword | whether password shall be stored internally | query | xs:boolean | true |
Content type | syncope21:user user to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of created user as well as the user itself enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | any object key or name | template | xs:string |
Deletes any object matching provided key.
Content type | Response object featuring the deleted any object enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Reads the any object matching the provided key.
Content type | syncope21:user any object with matching key |
Media types | application/json application/yaml application/xml |
Updates user matching the provided key.
Content type | syncope21:userPatch modification to be applied to user matching the provided key |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated user enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Updates user matching the provided key.
Content type | syncope21:user modification to be applied to user matching the provided key |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated user enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | any object key or name | template | xs:string | |
schemaType | template | xs:string
|
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.
Content type | syncope21:attributes list of attributes, owned by the given any object, for the given schema type |
Media types | application/json application/yaml application/xml |
Name | Description | Style | Type | Default |
---|---|---|---|---|
key | any object key or name | template | xs:string | |
schemaType | template | xs:string
| ||
schema | schema | template | xs:string |
Deletes the attribute, owned by the given any object, for the given schema type and schema.
Status | 204 |
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.
Content type | syncope21:attribute attribute, owned by the given any object, for the given schema type and schema |
Media types | application/json application/yaml application/xml |
Adds or replaces the attribute, owned by the given any object, for the given schema type and schema.
Content type | syncope21:attribute attribute |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated any object attribute - as Entity |
Media types | application/json application/yaml application/xml |
Executes resource-related operations on given entity.
Content type | syncope21:associationPatch external resources to be used for propagation-related operations |
Media types | application/json application/yaml application/xml |
Content type | batch results as Response entity |
Media types | multipart/mixed |
Executes resource-related operations on given entity.
Content type | syncope21:deassociationPatch external resources to be used for propagation-related operations |
Media types | application/json application/yaml application/xml |
Content type | batch results as Response entity |
Media types | multipart/mixed |
Performs a status update on given user.
Content type | syncope21:statusPatch status update details |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated user enriched with propagation status information |
Media types | application/json application/yaml application/xml |
REST operations for user self-management.
Self-deletes user.
Content type | Response object featuring the deleted user |
Media types | application/json application/yaml application/xml |
Returns the user making the service call.
Content type | calling user data, including own UUID, entitlements and delegations |
Media types | application/json application/yaml application/xml |
Self-registration for new user.
Name | Description | Style | Type | Default |
---|---|---|---|---|
storePassword | whether password shall be stored internally | query | xs:boolean | true |
Content type | syncope21:user user to be created |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring Location header of self-registered user as well as the user itself enriched with propagation status information |
Media types | application/json application/yaml application/xml |
Self-updates user.
Content type | syncope21:userPatch modification to be applied to self |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated user |
Media types | application/json application/yaml application/xml |
Self-updates user.
Content type | syncope21:user modification to be applied to self |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated user |
Media types | application/json application/yaml application/xml |
Self-perform a status update.
Content type | syncope21:statusPatch status update details |
Media types | application/json application/yaml application/xml |
Content type | Response object featuring the updated user enriched with propagation status information |
Media types | application/json application/yaml application/xml |
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.
Name | Description | Style | Type | Default |
---|---|---|---|---|
token | password reset token | query | xs:string |
Content type | xs:string |
Media types | */* |
Status | 204 |
Changes own password when change was forced by an administrator.
Content type | xs:string |
Media types | */* |
Content type | Response object featuring the updated user |
Media types | application/json application/yaml application/xml |
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.
Name | Description | Style | Type | Default |
---|---|---|---|---|
username | username for which the security answer is provided | query | xs:string |
Content type | xs:string |
Media types | */* |
Status | 204 |