Apache Syncope 2.0.4-SNAPSHOT

Namespaces

PrefixURIXSDWADL
syncope2http://syncope.apache.org/2.0syncope2.xsdsyncope.wadl

REST resources

/

General info about this Apache Syncope deployment.

numbers

Response

Content typesyncope2:numbersInfo
Media typesapplication/json
application/xml

platform

Response

Content typesyncope2:platformInfo
Media typesapplication/json
application/xml

system

Response

Content typesyncope2:systemInfo
Media typesapplication/json
application/xml

/accessTokens

REST operations for access tokens.

Parameters
NameDescriptionStyleTypeDefault
pagequeryxs:int1
orderByqueryxs:string
sizequeryxs:int25

Request

Response

Content typesyncope2:pagedResult
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

/login

Response

Content type
Media types*/*

/logout

Response

Status204

/refresh

Response

Content type
Media types*/*

/anyObjects

REST operations for anyObjects.

Parameters
NameDescriptionStyleTypeDefault
realmmatrixxs:string/
Parameters
NameDescriptionStyleTypeDefault
detailsqueryxs:booleantrue
fiqlqueryxs:string
pagequeryxs:int1
orderByqueryxs:string
sizequeryxs:int25

Request

Response

Content typesyncope2:pagedResult
Media typesapplication/json
application/xml

Request

Content typesyncope2:anyTO
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Content type
Media typesapplication/json
application/xml

Response

Content typesyncope2:anyTO
Media typesapplication/json
application/xml

Request

Content typesyncope2:anyPatch
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

Request

Content typesyncope2:anyTO
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}/{schemaType}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL

Response

Content typesyncope2:attributes
Media typesapplication/json
application/xml

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

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL
schematemplatexs:string

Response

Status204

Response

Content typesyncope2:attribute
Media typesapplication/json
application/xml

Request

Content typesyncope2:attribute
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}/associate/{action}

Request

Content typesyncope2:associationPatch
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}/deassociate/{action}

Request

Content typesyncope2:deassociationPatch
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/bulk

Request

Content typesyncope2:bulkAction
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/anyTypeClasses

REST operations for any type classes.

Response

Content typesyncope2:anyTypeClasss
Media typesapplication/json
application/xml

Request

Content typesyncope2:anyTypeClass
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

Response

Content typesyncope2:anyTypeClass
Media typesapplication/json
application/xml

Request

Content typesyncope2:anyTypeClass
Media typesapplication/json
application/xml

Response

Status204

/anyTypes

REST operations for any types.

Response

Content typesyncope2:anyTypes
Media typesapplication/json
application/xml

Request

Content typesyncope2:anyType
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

Response

Content typesyncope2:anyType
Media typesapplication/json
application/xml

Request

Content typesyncope2:anyType
Media typesapplication/json
application/xml

Response

Status204

/camelRoutes

REST operations for Camel routes.

Parameters
NameDescriptionStyleTypeDefault
anyTypeKindmatrixxs:string
  • USER
  • GROUP
  • ANY_OBJECT

Response

Content typesyncope2:camelRoutes
Media typesapplication/json
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Content typesyncope2:camelRoute
Media typesapplication/json
application/xml

Request

Content typesyncope2:camelRoute
Media typesapplication/json
application/xml

Response

Status204

/metrics

Response

Content typesyncope2:camelMetrics
Media typesapplication/json
application/xml

/restartContext

Response

Status204

/configurations

REST operations for configuration.

Response

Content typesyncope2:attributes
Media typesapplication/json
application/xml

/{schema}

Parameters
NameDescriptionStyleTypeDefault
schematemplatexs:string

Response

Status204

Response

Content typesyncope2:attribute
Media typesapplication/json
application/xml

Request

Content typesyncope2:attribute
Media typesapplication/json
application/xml

Response

Status204

/stream

Response

Content type
Media types*/*

/connectors

REST operations for connector bundles and instances.

Parameters
NameDescriptionStyleTypeDefault
langqueryxs:string

Request

Response

Content typesyncope2:connInstances
Media typesapplication/json
application/xml

Request

Content typesyncope2:connInstance
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204
Parameters
NameDescriptionStyleTypeDefault
langqueryxs:string

Request

Response

Content typesyncope2:connInstance
Media typesapplication/json
application/xml

Request

Content typesyncope2:connInstance
Media typesapplication/json
application/xml

Response

Status204

/{key}/supportedObjectClasses

Parameters
NameDescriptionStyleTypeDefault
includeSpecialqueryxs:booleanfalse

Request

Content typesyncope2:connInstance
Media typesapplication/json
application/xml

Response

Content typesyncope2:connIdObjectClasss
Media typesapplication/json
application/xml

/bundles

Parameters
NameDescriptionStyleTypeDefault
langqueryxs:string

Request

Response

Content typesyncope2:connectorBundles
Media typesapplication/json
application/xml

/byResource/{resourceName}

Parameters
NameDescriptionStyleTypeDefault
resourceNametemplatexs:string
Parameters
NameDescriptionStyleTypeDefault
langqueryxs:string

Request

Response

Content typesyncope2:connInstance
Media typesapplication/json
application/xml

/check

Request

Content typesyncope2:connInstance
Media typesapplication/json
application/xml

Response

Status204

/reload

Response

Status204

/domains

REST operations for domains.

Response

Content typesyncope2:domains
Media typesapplication/json
application/xml

Request

Content typesyncope2:domain
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

Response

Content typesyncope2:domain
Media typesapplication/json
application/xml

Request

Content typesyncope2:domain
Media typesapplication/json
application/xml

Response

Status204

/groups

REST operations for groups.

Parameters
NameDescriptionStyleTypeDefault
realmmatrixxs:string/
Parameters
NameDescriptionStyleTypeDefault
detailsqueryxs:booleantrue
fiqlqueryxs:string
pagequeryxs:int1
orderByqueryxs:string
sizequeryxs:int25

Request

Response

Content typesyncope2:pagedResult
Media typesapplication/json
application/xml

Request

Content typesyncope2:anyTO
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Content type
Media typesapplication/json
application/xml

Response

Content typesyncope2:anyTO
Media typesapplication/json
application/xml

Request

Content typesyncope2:anyPatch
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

Request

Content typesyncope2:anyTO
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}/{anyTypeKey}/typeExtension

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
anyTypeKeytemplatexs:string

Response

Content typesyncope2:typeExtension
Media typesapplication/json
application/xml

/{key}/{schemaType}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL

Response

Content typesyncope2:attributes
Media typesapplication/json
application/xml

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

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL
schematemplatexs:string

Response

Status204

Response

Content typesyncope2:attribute
Media typesapplication/json
application/xml

Request

Content typesyncope2:attribute
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}/associate/{action}

Request

Content typesyncope2:associationPatch
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}/deassociate/{action}

Request

Content typesyncope2:deassociationPatch
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}/members/{actionType}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
actionTypetemplatexs:string
  • PROVISION
  • DEPROVISION

Response

Content typesyncope2:exec
Media types*/*

/bulk

Request

Content typesyncope2:bulkAction
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/own

Response

Content typesyncope2:groups
Media typesapplication/json
application/xml

/loggers

REST operations for logging and auditing.

/{type}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • LOG
  • AUDIT

Response

Content typesyncope2:loggers
Media typesapplication/json
application/xml

/{type}/{key}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • LOG
  • AUDIT

Request

Content typesyncope2:logger
Media typesapplication/json
application/xml

Response

Status204

/{type}/{name}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • LOG
  • AUDIT
nametemplatexs:string

Response

Status204

Response

Content typesyncope2:logger
Media typesapplication/json
application/xml

/events

Response

Content typesyncope2:eventCategorys
Media typesapplication/json
application/xml

/memoryAppenders

Response

Content type
Media typesapplication/json
application/xml

/memoryAppenders/{memoryAppender}/lastLogStatements

Parameters
NameDescriptionStyleTypeDefault
memoryAppendertemplatexs:string

Response

Content typesyncope2:logStatements
Media typesapplication/json
application/xml

/mailTemplates

REST operations for mail templates.

Response

Content typesyncope2:mailTemplates
Media typesapplication/json
application/xml

Request

Content typesyncope2:mailTemplate
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

Response

Content typesyncope2:mailTemplate
Media typesapplication/json
application/xml

/{key}/{format}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
formattemplatexs:string
  • HTML
  • TEXT

Response

Status204

Response

Content type
Media types*/*

Request

Content type
Media types*/*

Response

Status204

/notifications

REST operations for notifications.

Response

Content typesyncope2:notifications
Media typesapplication/json
application/xml

Request

Content typesyncope2:notification
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

Response

Content typesyncope2:notification
Media typesapplication/json
application/xml

Request

Content typesyncope2:notification
Media typesapplication/json
application/xml

Response

Status204

/job

Response

Content typesyncope2:job
Media typesapplication/json
application/xml
Parameters
NameDescriptionStyleTypeDefault
actionqueryxs:string
  • START
  • STOP

Request

Response

Status204

/policies

REST operations for policies.

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

Response

Content typesyncope2:abstractPolicys
Media typesapplication/json
application/xml

Request

Content typesyncope2:abstractPolicy
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

Response

Content typesyncope2:abstractPolicy
Media typesapplication/json
application/xml

Request

Content typesyncope2:abstractPolicy
Media typesapplication/json
application/xml

Response

Status204

/realms

REST operations for realms.

Response

Content typesyncope2:realms
Media typesapplication/json
application/xml

/{fullPath:.*}

Parameters
NameDescriptionStyleTypeDefault
fullPathtemplatexs:string

Response

Content type
Media types*/*

Response

Content typesyncope2:realms
Media typesapplication/json
application/xml

Request

Content typesyncope2:realm
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{parentPath:.*}

Parameters
NameDescriptionStyleTypeDefault
parentPathtemplatexs:string

Request

Content typesyncope2:realm
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/relationshipTypes

REST operations for relationship types.

Response

Content typesyncope2:relationshipTypes
Media typesapplication/json
application/xml

Request

Content typesyncope2:relationshipType
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

Response

Content typesyncope2:relationshipType
Media typesapplication/json
application/xml

Request

Content typesyncope2:relationshipType
Media typesapplication/json
application/xml

Response

Status204

/reports

REST operations for reports.

Response

Content typesyncope2:reports
Media typesapplication/json
application/xml

Request

Content typesyncope2:report
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

Response

Content typesyncope2:report
Media typesapplication/json
application/xml

Request

Content typesyncope2:report
Media typesapplication/json
application/xml

Response

Status204

/{key}/execute

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
Parameters
NameDescriptionStyleTypeDefault
startAtqueryxs:dateTime
dryRunqueryxs:booleanfalse

Request

Response

Content typesyncope2:exec
Media typesapplication/json
application/xml

/{key}/executions

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
Parameters
NameDescriptionStyleTypeDefault
startedAfterqueryxs:dateTime
endedBeforequeryxs:dateTime
endedAfterqueryxs:dateTime
startedBeforequeryxs:dateTime

Request

Response

Content typesyncope2:bulkActionResult
Media typesapplication/xml
application/json
Parameters
NameDescriptionStyleTypeDefault
pagequeryxs:int1
orderByqueryxs:string
sizequeryxs:int25

Request

Response

Content typesyncope2:pagedResult
Media typesapplication/json
application/xml

/executions/{executionKey}

Parameters
NameDescriptionStyleTypeDefault
executionKeytemplatexs:string

Response

Status204

/executions/{executionKey}/stream

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

Request

Response

Content type
Media types*/*

/executions/recent

Parameters
NameDescriptionStyleTypeDefault
maxqueryxs:int25

Request

Response

Content typesyncope2:execs
Media typesapplication/json
application/xml

/jobs

Response

Content typesyncope2:jobs
Media typesapplication/json
application/xml

/jobs/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
Parameters
NameDescriptionStyleTypeDefault
actionqueryxs:string
  • START
  • STOP

Request

Response

Status204

/reportTemplates

REST operations for report templates.

Response

Content typesyncope2:reportTemplates
Media typesapplication/json
application/xml

Request

Content typesyncope2:reportTemplate
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

Response

Content typesyncope2:reportTemplate
Media typesapplication/json
application/xml

/{key}/{format}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
formattemplatexs:string
  • FO
  • HTML
  • CSV

Response

Status204

Response

Content type
Media types*/*

Request

Content type
Media types*/*

Response

Status204

/resources

REST operations for external resources.

Response

Content typesyncope2:resources
Media typesapplication/json
application/xml

Request

Content typesyncope2:resource
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

Response

Content typesyncope2:resource
Media typesapplication/json
application/xml

Request

Content typesyncope2:resource
Media typesapplication/json
application/xml

Response

Status204

/{key}/{anyTypeKey}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
anyTypeKeytemplatexs:string

Response

Status204
Parameters
NameDescriptionStyleTypeDefault
pagedResultsCookiequeryxs:string
sizequeryxs:int25

Request

Response

Content typesyncope2:pagedConnObjectResult
Media typesapplication/json
application/xml

Response

Status204

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

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
anyTypeKeytemplatexs:string
anyKeytemplatexs:string

Response

Content typesyncope2:connObject
Media typesapplication/json
application/xml

/{key}/bulkDeassociation/{anyTypeKey}/{action}

Request

Content typesyncope2:resourceDeassociationPatch
Media typesapplication/json
application/xml

Response

Content typesyncope2:bulkActionResult
Media typesapplication/json
application/xml

/check

Request

Content typesyncope2:resource
Media typesapplication/json
application/xml

Response

Status204

/roles

REST operations for roles.

Response

Content typesyncope2:roles
Media typesapplication/json
application/xml

Request

Content typesyncope2:role
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

Response

Content typesyncope2:role
Media typesapplication/json
application/xml

Request

Content typesyncope2:role
Media typesapplication/json
application/xml

Response

Status204

/{key}/consoleLayout

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

Response

Content type
Media typesapplication/json

Request

Content type
Media typesapplication/json

Response

Status204

/saml2sp/identityProviders

REST operations for SAML 2.0 Identity Providers.

Response

Content typesyncope2:saml2idps
Media typesapplication/json
application/xml

Request

Content type
Media typesapplication/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

Response

Content typesyncope2:saml2idp
Media typesapplication/json
application/xml

Request

Content typesyncope2:saml2idp
Media typesapplication/json
application/xml

Response

Status204

/saml2sp/serviceProvider

REST operations for the provided SAML 2.0 Service Provider.

Parameters
NameDescriptionStyleTypeDefault
spEntityIDqueryxs:string
urlContextqueryxs:string

Request

Response

Content type
Media typesapplication/xml

/loginRequest

Parameters
NameDescriptionStyleTypeDefault
spEntityIDqueryxs:string
idpEntityIDqueryxs:string

Request

Response

Content typesyncope2:saml2request
Media typesapplication/json
application/xml

/loginResponse

Request

Content typesyncope2:saml2ReceivedResponse
Media typesapplication/json
application/xml

Response

Content typesyncope2:saml2LoginResponse
Media typesapplication/json
application/xml

/logoutRequest

Parameters
NameDescriptionStyleTypeDefault
spEntityIDqueryxs:string

Request

Response

Content typesyncope2:saml2request
Media typesapplication/json
application/xml

/logoutResponse

Request

Content typesyncope2:saml2ReceivedResponse
Media typesapplication/json
application/xml

Response

Status204

/schemas

REST operations for attribute schemas.

/{type}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL
Parameters
NameDescriptionStyleTypeDefault
anyTypeClassesqueryxs:string

Request

Response

Content typesyncope2:abstractSchemas
Media typesapplication/json
application/xml

Request

Content typesyncope2:abstractSchema
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{type}/{key}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL
keytemplatexs:string

Response

Status204

Response

Content typesyncope2:abstractSchema
Media typesapplication/json
application/xml

Request

Content typesyncope2:abstractSchema
Media typesapplication/json
application/xml

Response

Status204

/securityQuestions

REST operations for configuration.

Response

Content typesyncope2:securityQuestions
Media typesapplication/json
application/xml

Request

Content typesyncope2:securityQuestion
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204

Response

Content typesyncope2:securityQuestion
Media typesapplication/json
application/xml

Request

Content typesyncope2:securityQuestion
Media typesapplication/json
application/xml

Response

Status204

/byUser/{username}

Parameters
NameDescriptionStyleTypeDefault
usernametemplatexs:string

Response

Content typesyncope2:securityQuestion
Media typesapplication/json
application/xml

/tasks

REST operations for tasks.

Parameters
NameDescriptionStyleTypeDefault
typematrixxs:string
  • PROPAGATION
  • NOTIFICATION
  • SCHEDULED
  • PULL
  • PUSH
Parameters
NameDescriptionStyleTypeDefault
resourcequeryxs:string
notificationqueryxs:string
entityKeyqueryxs:string
anyTypeKindqueryxs:string
  • USER
  • GROUP
  • ANY_OBJECT
detailsqueryxs:booleantrue
pagequeryxs:int1
orderByqueryxs:string
sizequeryxs:int25

Request

Response

Content typesyncope2:pagedResult
Media typesapplication/json
application/xml

Request

Content typesyncope2:schedTask
Media typesapplication/json
application/xml

Response

Content type
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Status204
Parameters
NameDescriptionStyleTypeDefault
detailsqueryxs:booleantrue

Request

Response

Content typesyncope2:abstractTask
Media typesapplication/json
application/xml

Request

Content typesyncope2:abstractTask
Media typesapplication/json
application/xml

Response

Status204

/{key}/execute

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
Parameters
NameDescriptionStyleTypeDefault
startAtqueryxs:dateTime
dryRunqueryxs:booleanfalse

Request

Response

Content typesyncope2:exec
Media typesapplication/json
application/xml

/{key}/executions

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
Parameters
NameDescriptionStyleTypeDefault
startedAfterqueryxs:dateTime
endedBeforequeryxs:dateTime
endedAfterqueryxs:dateTime
startedBeforequeryxs:dateTime

Request

Response

Content typesyncope2:bulkActionResult
Media typesapplication/xml
application/json
Parameters
NameDescriptionStyleTypeDefault
pagequeryxs:int1
orderByqueryxs:string
sizequeryxs:int25

Request

Response

Content typesyncope2:pagedResult
Media typesapplication/json
application/xml

/bulk

Request

Content typesyncope2:bulkAction
Media typesapplication/json
application/xml

Response

Content typesyncope2:bulkActionResult
Media typesapplication/json
application/xml

/executions/{executionKey}

Parameters
NameDescriptionStyleTypeDefault
executionKeytemplatexs:string

Response

Status204

/executions/recent

Parameters
NameDescriptionStyleTypeDefault
maxqueryxs:int25

Request

Response

Content typesyncope2:execs
Media typesapplication/json
application/xml

/jobs

Response

Content typesyncope2:jobs
Media typesapplication/json
application/xml

/jobs/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
Parameters
NameDescriptionStyleTypeDefault
actionqueryxs:string
  • START
  • STOP

Request

Response

Status204

/users

REST operations for users.

Parameters
NameDescriptionStyleTypeDefault
realmmatrixxs:string/
Parameters
NameDescriptionStyleTypeDefault
detailsqueryxs:booleantrue
fiqlqueryxs:string
pagequeryxs:int1
orderByqueryxs:string
sizequeryxs:int25

Request

Response

Content typesyncope2:pagedResult
Media typesapplication/json
application/xml
Parameters
NameDescriptionStyleTypeDefault
storePasswordqueryxs:booleantrue

Request

Content typesyncope2:user
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

Request

Content typesyncope2:anyTO
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string

Response

Content type
Media typesapplication/json
application/xml

Response

Content typesyncope2:anyTO
Media typesapplication/json
application/xml

Request

Content typesyncope2:anyPatch
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

Request

Content typesyncope2:anyTO
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}/{schemaType}

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL

Response

Content typesyncope2:attributes
Media typesapplication/json
application/xml

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

Parameters
NameDescriptionStyleTypeDefault
keytemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL
schematemplatexs:string

Response

Status204

Response

Content typesyncope2:attribute
Media typesapplication/json
application/xml

Request

Content typesyncope2:attribute
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}/associate/{action}

Request

Content typesyncope2:associationPatch
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}/deassociate/{action}

Request

Content typesyncope2:deassociationPatch
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}/status

Request

Content typesyncope2:statusPatch
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/bulk

Request

Content typesyncope2:bulkAction
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/users/self

REST operations for user self-management.

Response

Content type
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml
Parameters
NameDescriptionStyleTypeDefault
storePasswordqueryxs:booleantrue

Request

Content typesyncope2:user
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/{key}

Request

Content typesyncope2:userPatch
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

Request

Content typesyncope2:user
Media typesapplication/json
application/xml

Response

Content type
Media typesapplication/json
application/xml

/changePassword

Parameters
NameDescriptionStyleTypeDefault
passwordqueryxs:string

Request

Response

Content type
Media typesapplication/json
application/xml

/confirmPasswordReset

Parameters
NameDescriptionStyleTypeDefault
tokenqueryxs:string

Request

Content typexs:string
Media types*/*

Response

Status204

/requestPasswordReset

Parameters
NameDescriptionStyleTypeDefault
usernamequeryxs:string

Request

Content typexs:string
Media types*/*

Response

Status204

/userworkflow

REST operations related to user workflow.

/forms

Response

Content typesyncope2:workflowForms
Media typesapplication/json
application/xml

Request

Content typesyncope2:workflowForm
Media typesapplication/json
application/xml

Response

Content typesyncope2:user
Media typesapplication/json
application/xml

/forms/{taskId}/claim

Parameters
NameDescriptionStyleTypeDefault
taskIdtemplatexs:string

Response

Content typesyncope2:workflowForm
Media typesapplication/json
application/xml

/forms/{userKey}

Parameters
NameDescriptionStyleTypeDefault
userKeytemplatexs:string

Response

Content typesyncope2:workflowForm
Media typesapplication/json
application/xml

/tasks/{taskId}/execute

Parameters
NameDescriptionStyleTypeDefault
taskIdtemplatexs:string

Request

Content typesyncope2:user
Media typesapplication/json
application/xml

Response

Content typesyncope2:user
Media typesapplication/json
application/xml

/workflows

REST operations for workflow definition.

/{anyType}

Parameters
NameDescriptionStyleTypeDefault
anyTypetemplatexs:string

Response

Content typesyncope2:workflowDefinitions
Media typesapplication/json
application/xml

/{anyType}/{key}

Parameters
NameDescriptionStyleTypeDefault
anyTypetemplatexs:string
keytemplatexs:string

Response

Status204

Response

Content type
Media typesapplication/json
application/xml

Request

Content typexs:string
Media typesapplication/json
application/xml

Response

Status204

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

Parameters
NameDescriptionStyleTypeDefault
anyTypetemplatexs:string
keytemplatexs:string

Response

Content type
Media typesimage/png