openapi: 3.0.0 info: title: Adobe Experience Manager (AEM) API description: >- Swagger AEM is an OpenAPI specification for Adobe Experience Manager (AEM) API version: 3.7.1-pre.0 contact: name: Shine Solutions url: http://shinesolutions.com email: opensource@shinesolutions.com security: - aemAuth: [] paths: /system/console/configMgr: get: operationId: getConfigMgr responses: '200': description: OK content: text/xml: schema: type: string 5XX: description: Unexpected error. tags: - console /libs/granite/core/content/login.html: get: operationId: getLoginPage security: [] responses: default: description: Default response content: text/html: schema: type: string tags: - cq /.cqactions.html: post: operationId: postCqActions parameters: - name: authorizableId in: query required: true schema: type: string - name: changelog in: query required: true schema: type: string tags: - cq responses: default: description: Default response /{path}/: post: operationId: postPath parameters: - name: path in: path required: true schema: type: string - name: jcr:primaryType in: query required: true schema: type: string - name: ':name' in: query required: true schema: type: string tags: - sling responses: default: description: Default response /{path}/{name}: get: operationId: getNode parameters: - name: path in: path required: true schema: type: string - name: name in: path required: true schema: type: string tags: - sling responses: default: description: Default response post: operationId: postNode parameters: - name: path in: path required: true schema: type: string - name: name in: path required: true schema: type: string - name: ':operation' in: query required: false schema: type: string - name: deleteAuthorizable in: query required: false schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary tags: - sling responses: default: description: Default response delete: operationId: deleteNode parameters: - name: path in: path required: true schema: type: string - name: name in: path required: true schema: type: string tags: - sling responses: default: description: Default response /{path}/{name}.rw.html: post: operationId: postNodeRw parameters: - name: path in: path required: true schema: type: string - name: name in: path required: true schema: type: string - name: addMembers in: query required: false schema: type: string tags: - sling responses: default: description: Default response /apps/system/config/{configNodeName}: post: operationId: postConfigProperty parameters: - name: configNodeName in: path required: true schema: type: string tags: - sling responses: default: description: Default response /apps/system/config/org.apache.felix.http: post: operationId: postConfigApacheFelixJettyBasedHttpService parameters: - name: org.apache.felix.https.nio in: query required: false schema: type: boolean - name: org.apache.felix.https.nio@TypeHint in: query required: false schema: type: string - name: org.apache.felix.https.keystore in: query required: false schema: type: string - name: org.apache.felix.https.keystore@TypeHint in: query required: false schema: type: string - name: org.apache.felix.https.keystore.password in: query required: false schema: type: string - name: org.apache.felix.https.keystore.password@TypeHint in: query required: false schema: type: string - name: org.apache.felix.https.keystore.key in: query required: false schema: type: string - name: org.apache.felix.https.keystore.key@TypeHint in: query required: false schema: type: string - name: org.apache.felix.https.keystore.key.password in: query required: false schema: type: string - name: org.apache.felix.https.keystore.key.password@TypeHint in: query required: false schema: type: string - name: org.apache.felix.https.truststore in: query required: false schema: type: string - name: org.apache.felix.https.truststore@TypeHint in: query required: false schema: type: string - name: org.apache.felix.https.truststore.password in: query required: false schema: type: string - name: org.apache.felix.https.truststore.password@TypeHint in: query required: false schema: type: string - name: org.apache.felix.https.clientcertificate in: query required: false schema: type: string - name: org.apache.felix.https.clientcertificate@TypeHint in: query required: false schema: type: string - name: org.apache.felix.https.enable in: query required: false schema: type: boolean - name: org.apache.felix.https.enable@TypeHint in: query required: false schema: type: string - name: org.osgi.service.http.port.secure in: query required: false schema: type: string - name: org.osgi.service.http.port.secure@TypeHint in: query required: false schema: type: string tags: - sling responses: default: description: Default response /apps/system/config/org.apache.sling.servlets.get.DefaultGetServlet: post: operationId: postConfigApacheSlingGetServlet parameters: - name: json.maximumresults in: query required: false schema: type: string - name: json.maximumresults@TypeHint in: query required: false schema: type: string - name: enable.html in: query required: false schema: type: boolean - name: enable.html@TypeHint in: query required: false schema: type: string - name: enable.txt in: query required: false schema: type: boolean - name: enable.txt@TypeHint in: query required: false schema: type: string - name: enable.xml in: query required: false schema: type: boolean - name: enable.xml@TypeHint in: query required: false schema: type: string tags: - sling responses: default: description: Default response /apps/system/config/org.apache.sling.security.impl.ReferrerFilter: post: operationId: postConfigApacheSlingReferrerFilter parameters: - name: allow.empty in: query required: false schema: type: boolean - name: allow.empty@TypeHint in: query required: false schema: type: string - name: allow.hosts in: query required: false schema: type: string - name: allow.hosts@TypeHint in: query required: false schema: type: string - name: allow.hosts.regexp in: query required: false schema: type: string - name: allow.hosts.regexp@TypeHint in: query required: false schema: type: string - name: filter.methods in: query required: false schema: type: string - name: filter.methods@TypeHint in: query required: false schema: type: string tags: - sling responses: default: description: Default response /apps/system/config/org.apache.sling.jcr.davex.impl.servlets.SlingDavExServlet: post: operationId: postConfigApacheSlingDavExServlet parameters: - name: alias in: query required: false schema: type: string - name: alias@TypeHint in: query required: false schema: type: string - name: dav.create-absolute-uri in: query required: false schema: type: boolean - name: dav.create-absolute-uri@TypeHint in: query required: false schema: type: string tags: - sling responses: default: description: Default response /apps/system/config/com.shinesolutions.aem.passwordreset.Activator: post: operationId: postConfigAemPasswordReset parameters: - name: pwdreset.authorizables in: query required: false explode: true schema: type: array items: type: string - name: pwdreset.authorizables@TypeHint in: query required: false schema: type: string tags: - custom responses: default: description: Default response /apps/system/config/com.shinesolutions.healthcheck.hc.impl.ActiveBundleHealthCheck: post: operationId: postConfigAemHealthCheckServlet parameters: - name: bundles.ignored in: query required: false explode: true schema: type: array items: type: string - name: bundles.ignored@TypeHint in: query required: false schema: type: string tags: - custom responses: default: description: Default response /bin/querybuilder.json: get: operationId: getQuery parameters: - name: path in: query required: true schema: type: string - name: p.limit in: query required: true schema: type: number - name: 1_property in: query required: true schema: type: string - name: 1_property.value in: query required: true schema: type: string responses: default: description: Default response content: application/json: schema: type: string tags: - sling post: operationId: postQuery parameters: - name: path in: query required: true schema: type: string - name: p.limit in: query required: true schema: type: number - name: 1_property in: query required: true schema: type: string - name: 1_property.value in: query required: true schema: type: string responses: default: description: Default response content: application/json: schema: type: string tags: - sling /etc/packages/{group}/{name}-{version}.zip: get: operationId: getPackage parameters: - name: group in: path required: true schema: type: string - name: name in: path required: true schema: type: string - name: version in: path required: true schema: type: string responses: default: description: Default response content: application/octet-stream: schema: type: string format: binary tags: - sling /etc/packages/{group}/{name}-{version}.zip/jcr:content/vlt:definition/filter.tidy.2.json: get: operationId: getPackageFilter parameters: - name: group in: path required: true schema: type: string - name: name in: path required: true schema: type: string - name: version in: path required: true schema: type: string responses: default: description: Default response content: application/json: schema: type: string tags: - sling /etc/replication/agents.{runmode}.-1.json: get: operationId: getAgents parameters: - name: runmode in: path required: true schema: type: string responses: default: description: Default response content: application/json: schema: type: string tags: - sling /etc/replication/agents.{runmode}/{name}: get: operationId: getAgent parameters: - name: runmode in: path required: true schema: type: string - name: name in: path required: true schema: type: string tags: - sling responses: default: description: Default response delete: operationId: deleteAgent parameters: - name: runmode in: path required: true schema: type: string - name: name in: path required: true schema: type: string tags: - sling responses: default: description: Default response post: operationId: postAgent parameters: - name: runmode in: path required: true schema: type: string - name: name in: path required: true schema: type: string - name: jcr:content/cq:distribute in: query required: false schema: type: boolean - name: jcr:content/cq:distribute@TypeHint in: query required: false schema: type: string - name: jcr:content/cq:name in: query required: false schema: type: string - name: jcr:content/cq:template in: query required: false schema: type: string - name: jcr:content/enabled in: query required: false schema: type: boolean - name: jcr:content/jcr:description in: query required: false schema: type: string - name: jcr:content/jcr:lastModified in: query required: false schema: type: string - name: jcr:content/jcr:lastModifiedBy in: query required: false schema: type: string - name: jcr:content/jcr:mixinTypes in: query required: false schema: type: string - name: jcr:content/jcr:title in: query required: false schema: type: string - name: jcr:content/logLevel in: query required: false schema: type: string - name: jcr:content/noStatusUpdate in: query required: false schema: type: boolean - name: jcr:content/noVersioning in: query required: false schema: type: boolean - name: jcr:content/protocolConnectTimeout in: query required: false schema: type: number - name: jcr:content/protocolHTTPConnectionClosed in: query required: false schema: type: boolean - name: jcr:content/protocolHTTPExpired in: query required: false schema: type: string - name: jcr:content/protocolHTTPHeaders in: query required: false explode: true schema: type: array items: type: string - name: jcr:content/protocolHTTPHeaders@TypeHint in: query required: false schema: type: string - name: jcr:content/protocolHTTPMethod in: query required: false schema: type: string - name: jcr:content/protocolHTTPSRelaxed in: query required: false schema: type: boolean - name: jcr:content/protocolInterface in: query required: false schema: type: string - name: jcr:content/protocolSocketTimeout in: query required: false schema: type: number - name: jcr:content/protocolVersion in: query required: false schema: type: string - name: jcr:content/proxyNTLMDomain in: query required: false schema: type: string - name: jcr:content/proxyNTLMHost in: query required: false schema: type: string - name: jcr:content/proxyHost in: query required: false schema: type: string - name: jcr:content/proxyPassword in: query required: false schema: type: string - name: jcr:content/proxyPort in: query required: false schema: type: number - name: jcr:content/proxyUser in: query required: false schema: type: string - name: jcr:content/queueBatchMaxSize in: query required: false schema: type: number - name: jcr:content/queueBatchMode in: query required: false schema: type: string - name: jcr:content/queueBatchWaitTime in: query required: false schema: type: number - name: jcr:content/retryDelay in: query required: false schema: type: string - name: jcr:content/reverseReplication in: query required: false schema: type: boolean - name: jcr:content/serializationType in: query required: false schema: type: string - name: jcr:content/sling:resourceType in: query required: false schema: type: string - name: jcr:content/ssl in: query required: false schema: type: string - name: jcr:content/transportNTLMDomain in: query required: false schema: type: string - name: jcr:content/transportNTLMHost in: query required: false schema: type: string - name: jcr:content/transportPassword in: query required: false schema: type: string - name: jcr:content/transportUri in: query required: false schema: type: string - name: jcr:content/transportUser in: query required: false schema: type: string - name: jcr:content/triggerDistribute in: query required: false schema: type: boolean - name: jcr:content/triggerModified in: query required: false schema: type: boolean - name: jcr:content/triggerOnOffTime in: query required: false schema: type: boolean - name: jcr:content/triggerReceive in: query required: false schema: type: boolean - name: jcr:content/triggerSpecific in: query required: false schema: type: boolean - name: jcr:content/userId in: query required: false schema: type: string - name: jcr:primaryType in: query required: false schema: type: string - name: ':operation' in: query required: false schema: type: string tags: - sling responses: default: description: Default response /libs/replication/treeactivation.html: post: operationId: postTreeActivation parameters: - name: ignoredeactivated in: query required: true schema: type: boolean - name: onlymodified in: query required: true schema: type: boolean - name: path in: query required: true schema: type: string - name: cmd in: query required: true schema: type: string default: activate tags: - sling responses: default: description: Default response /libs/granite/security/post/authorizables: post: operationId: postAuthorizables parameters: - name: authorizableId in: query required: true schema: type: string - name: intermediatePath in: query required: true schema: type: string - name: createUser in: query required: false schema: type: string - name: createGroup in: query required: false schema: type: string - name: rep:password in: query required: false schema: type: string - name: profile/givenName in: query required: false schema: type: string responses: default: description: Default response content: text/html: schema: type: string tags: - sling /crx/explorer/ui/setpassword.jsp: post: operationId: postSetPassword parameters: - name: old in: query required: true schema: type: string - name: plain in: query required: true schema: type: string - name: verify in: query required: true schema: type: string responses: default: description: Default response content: text/plain: schema: type: string tags: - crx /crx/packmgr/installstatus.jsp: get: operationId: getInstallStatus responses: '200': description: Retrieved CRX package manager install status content: application/json: schema: $ref: '#/components/schemas/InstallStatus' default: description: Default response content: application/json: schema: type: string tags: - crx /crx/packmgr/service.jsp: post: operationId: postPackageService parameters: - name: cmd in: query required: true schema: type: string responses: default: description: Default response content: text/xml: schema: type: string tags: - crx /crx/packmgr/update.jsp: post: operationId: postPackageUpdate parameters: - name: groupName in: query required: true schema: type: string - name: packageName in: query required: true schema: type: string - name: version in: query required: true schema: type: string - name: path in: query required: true schema: type: string - name: filter in: query required: false schema: type: string - name: _charset_ in: query required: false schema: type: string responses: default: description: Default response content: application/json: schema: type: string tags: - crx /crx/packmgr/service/.json/{path}: post: operationId: postPackageServiceJson parameters: - name: path in: path required: true schema: type: string - name: cmd in: query required: true schema: type: string - name: groupName in: query required: false schema: type: string - name: packageName in: query required: false schema: type: string - name: packageVersion in: query required: false schema: type: string - name: _charset_ in: query required: false schema: type: string - name: force in: query required: false schema: type: boolean - name: recursive in: query required: false schema: type: boolean requestBody: content: multipart/form-data: schema: type: object properties: package: type: string format: binary responses: default: description: Default response content: application/json: schema: type: string tags: - crx /crx/packmgr/service/script.html: get: operationId: getPackageManagerServlet responses: '404': description: Package Manager Servlet is disabled content: text/html: schema: type: string '405': description: Package Manager Servlet is active content: text/html: schema: type: string tags: - crx /crx/server/crx.default/jcr:root/.1.json: get: operationId: getCrxdeStatus responses: '200': description: CRXDE is enabled content: plain/text: schema: type: string '404': description: CRXDE is disabled content: plain/text: schema: type: string tags: - crx /system/console/bundles/{name}.json: get: operationId: getBundleInfo parameters: - name: name in: path required: true schema: type: string tags: - console responses: '200': description: Retrieved bundle info content: application/json: schema: $ref: '#/components/schemas/BundleInfo' default: description: Default response content: application/json: schema: type: string /system/console/bundles/{name}: post: operationId: postBundle parameters: - name: name in: path required: true schema: type: string - name: action in: query required: true schema: type: string tags: - console responses: default: description: Default response /system/console/jmx/com.adobe.granite:type=Repository/op/{action}: post: operationId: postJmxRepository parameters: - name: action in: path required: true schema: type: string tags: - console responses: default: description: Default response /system/health: get: operationId: getAemHealthCheck parameters: - name: tags in: query required: false schema: type: string - name: combineTagsOr in: query required: false schema: type: boolean responses: default: description: Default response content: application/json: schema: type: string tags: - custom /apps/system/config/com.adobe.granite.auth.saml.SamlAuthenticationHandler.config: post: operationId: postConfigAdobeGraniteSamlAuthenticationHandler parameters: - name: keyStorePassword in: query required: false schema: type: string - name: keyStorePassword@TypeHint in: query required: false schema: type: string - name: service.ranking in: query required: false schema: type: integer - name: service.ranking@TypeHint in: query required: false schema: type: string - name: idpHttpRedirect in: query required: false schema: type: boolean - name: idpHttpRedirect@TypeHint in: query required: false schema: type: string - name: createUser in: query required: false schema: type: boolean - name: createUser@TypeHint in: query required: false schema: type: string - name: defaultRedirectUrl in: query required: false schema: type: string - name: defaultRedirectUrl@TypeHint in: query required: false schema: type: string - name: userIDAttribute in: query required: false schema: type: string - name: userIDAttribute@TypeHint in: query required: false schema: type: string - name: defaultGroups in: query required: false explode: true schema: type: array items: type: string - name: defaultGroups@TypeHint in: query required: false schema: type: string - name: idpCertAlias in: query required: false schema: type: string - name: idpCertAlias@TypeHint in: query required: false schema: type: string - name: addGroupMemberships in: query required: false schema: type: boolean - name: addGroupMemberships@TypeHint in: query required: false schema: type: string - name: path in: query required: false explode: true schema: type: array items: type: string - name: path@TypeHint in: query required: false schema: type: string - name: synchronizeAttributes in: query required: false explode: true schema: type: array items: type: string - name: synchronizeAttributes@TypeHint in: query required: false schema: type: string - name: clockTolerance in: query required: false schema: type: integer - name: clockTolerance@TypeHint in: query required: false schema: type: string - name: groupMembershipAttribute in: query required: false schema: type: string - name: groupMembershipAttribute@TypeHint in: query required: false schema: type: string - name: idpUrl in: query required: false schema: type: string - name: idpUrl@TypeHint in: query required: false schema: type: string - name: logoutUrl in: query required: false schema: type: string - name: logoutUrl@TypeHint in: query required: false schema: type: string - name: serviceProviderEntityId in: query required: false schema: type: string - name: serviceProviderEntityId@TypeHint in: query required: false schema: type: string - name: assertionConsumerServiceURL in: query required: false schema: type: string - name: assertionConsumerServiceURL@TypeHint in: query required: false schema: type: string - name: handleLogout in: query required: false schema: type: boolean - name: handleLogout@TypeHint in: query required: false schema: type: string - name: spPrivateKeyAlias in: query required: false schema: type: string - name: spPrivateKeyAlias@TypeHint in: query required: false schema: type: string - name: useEncryption in: query required: false schema: type: boolean - name: useEncryption@TypeHint in: query required: false schema: type: string - name: nameIdFormat in: query required: false schema: type: string - name: nameIdFormat@TypeHint in: query required: false schema: type: string - name: digestMethod in: query required: false schema: type: string - name: digestMethod@TypeHint in: query required: false schema: type: string - name: signatureMethod in: query required: false schema: type: string - name: signatureMethod@TypeHint in: query required: false schema: type: string - name: userIntermediatePath in: query required: false schema: type: string - name: userIntermediatePath@TypeHint in: query required: false schema: type: string tags: - sling responses: default: description: Default response /apps/system/config/org.apache.http.proxyconfigurator.config: post: operationId: postConfigApacheHttpComponentsProxyConfiguration parameters: - name: proxy.host in: query required: false schema: type: string - name: proxy.host@TypeHint in: query required: false schema: type: string - name: proxy.port in: query required: false schema: type: integer - name: proxy.port@TypeHint in: query required: false schema: type: string - name: proxy.exceptions in: query required: false explode: true schema: type: array items: type: string - name: proxy.exceptions@TypeHint in: query required: false schema: type: string - name: proxy.enabled in: query required: false schema: type: boolean - name: proxy.enabled@TypeHint in: query required: false schema: type: string - name: proxy.user in: query required: false schema: type: string - name: proxy.user@TypeHint in: query required: false schema: type: string - name: proxy.password in: query required: false schema: type: string - name: proxy.password@TypeHint in: query required: false schema: type: string tags: - sling responses: default: description: Default response /libs/granite/security/post/truststore: post: operationId: postTruststore parameters: - name: ':operation' in: query required: false schema: type: string - name: newPassword in: query required: false schema: type: string - name: rePassword in: query required: false schema: type: string - name: keyStoreType in: query required: false schema: type: string - name: removeAlias in: query required: false schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: certificate: type: string format: binary responses: default: description: Default response content: text/plain: schema: type: string tags: - sling /libs/granite/security/truststore.json: get: operationId: getTruststoreInfo responses: '200': description: Retrieved AEM Truststore info content: application/json: schema: $ref: '#/components/schemas/TruststoreInfo' default: description: Default response content: application/json: schema: type: string tags: - sling /etc/truststore/truststore.p12: get: operationId: getTruststore responses: default: description: Default response content: application/octet-stream: schema: type: string format: binary tags: - sling /etc/truststore: post: operationId: postTruststorePKCS12 requestBody: content: multipart/form-data: schema: type: object properties: truststore.p12: type: string format: binary responses: default: description: Default response content: text/plain: schema: type: string tags: - sling /system/console/configMgr/com.adobe.granite.auth.saml.SamlAuthenticationHandler: post: operationId: postSamlConfiguration parameters: - name: post in: query required: false schema: type: boolean - name: apply in: query required: false schema: type: boolean - name: delete in: query required: false schema: type: boolean - name: action in: query required: false schema: type: string - name: $location in: query required: false schema: type: string - name: path in: query required: false explode: true schema: type: array items: type: string - name: service.ranking in: query required: false schema: type: integer - name: idpUrl in: query required: false schema: type: string - name: idpCertAlias in: query required: false schema: type: string - name: idpHttpRedirect in: query required: false schema: type: boolean - name: serviceProviderEntityId in: query required: false schema: type: string - name: assertionConsumerServiceURL in: query required: false schema: type: string - name: spPrivateKeyAlias in: query required: false schema: type: string - name: keyStorePassword in: query required: false schema: type: string - name: defaultRedirectUrl in: query required: false schema: type: string - name: userIDAttribute in: query required: false schema: type: string - name: useEncryption in: query required: false schema: type: boolean - name: createUser in: query required: false schema: type: boolean - name: addGroupMemberships in: query required: false schema: type: boolean - name: groupMembershipAttribute in: query required: false schema: type: string - name: defaultGroups in: query required: false explode: true schema: type: array items: type: string - name: nameIdFormat in: query required: false schema: type: string - name: synchronizeAttributes in: query required: false explode: true schema: type: array items: type: string - name: handleLogout in: query required: false schema: type: boolean - name: logoutUrl in: query required: false schema: type: string - name: clockTolerance in: query required: false schema: type: integer - name: digestMethod in: query required: false schema: type: string - name: signatureMethod in: query required: false schema: type: string - name: userIntermediatePath in: query required: false schema: type: string - name: propertylist in: query required: false style: form explode: false schema: type: array items: type: string responses: '200': description: Retrieved AEM SAML Configuration content: text/plain: schema: $ref: '#/components/schemas/SamlConfigurationInfo' '302': description: Default response content: text/plain: schema: type: string default: description: Default response content: text/plain: schema: type: string tags: - console /system/console/status-productinfo.json: get: operationId: getAemProductInfo responses: default: description: Default response content: application/json: schema: type: array items: type: string tags: - console /{intermediatePath}/{authorizableId}.ks.html: post: operationId: postAuthorizableKeystore parameters: - name: intermediatePath in: path required: true schema: type: string - name: authorizableId in: path required: true schema: type: string - name: ':operation' in: query required: false schema: type: string - name: currentPassword in: query required: false schema: type: string - name: newPassword in: query required: false schema: type: string - name: rePassword in: query required: false schema: type: string - name: keyPassword in: query required: false schema: type: string - name: keyStorePass in: query required: false schema: type: string - name: alias in: query required: false schema: type: string - name: newAlias in: query required: false schema: type: string - name: removeAlias in: query required: false schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: cert-chain: type: string format: binary pk: type: string format: binary keyStore: type: string format: binary tags: - sling responses: '200': description: Retrieved Authorizable Keystore info content: text/plain: schema: $ref: '#/components/schemas/KeystoreInfo' default: description: Default response content: text/plain: schema: type: string /{intermediatePath}/{authorizableId}.ks.json: get: operationId: getAuthorizableKeystore parameters: - name: intermediatePath in: path required: true schema: type: string - name: authorizableId in: path required: true schema: type: string tags: - sling responses: '200': description: Retrieved Authorizable Keystore info content: text/plain: schema: $ref: '#/components/schemas/KeystoreInfo' default: description: Default response content: text/plain: schema: type: string /{intermediatePath}/{authorizableId}/keystore/store.p12: get: operationId: getKeystore parameters: - name: intermediatePath in: path required: true schema: type: string - name: authorizableId in: path required: true schema: type: string responses: default: description: Default response content: application/octet-stream: schema: type: string format: binary tags: - sling /libs/granite/security/post/sslSetup.html: post: operationId: sslSetup parameters: - name: keystorePassword in: query required: true schema: type: string - name: keystorePasswordConfirm in: query required: true schema: type: string - name: truststorePassword in: query required: true schema: type: string - name: truststorePasswordConfirm in: query required: true schema: type: string - name: httpsHostname in: query required: true schema: type: string - name: httpsPort in: query required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: privatekeyFile: type: string format: binary certificateFile: type: string format: binary responses: default: description: Default response content: text/plain: schema: type: string tags: - granite servers: - url: / components: securitySchemes: aemAuth: type: http scheme: basic schemas: InstallStatus: type: object properties: status: type: object properties: finished: type: boolean itemCount: type: integer KeystoreInfo: type: object properties: aliases: type: array items: $ref: '#/components/schemas/KeystoreItems' exists: type: boolean description: False if truststore don't exist TruststoreInfo: type: object properties: aliases: type: array items: $ref: '#/components/schemas/TruststoreItems' exists: type: boolean description: False if truststore don't exist KeystoreItems: type: object properties: alias: type: string description: Keystore alias name entryType: type: string description: e.g. "privateKey" algorithm: type: string description: e.g. "RSA" format: type: string description: e.g. "PKCS#8" chain: type: array items: $ref: '#/components/schemas/KeystoreChainItems' KeystoreChainItems: type: object properties: subject: type: string description: e.g. "CN=localhost" issuer: type: string description: e.g. "CN=Admin" notBefore: type: string description: e.g. "Sun Jul 01 12:00:00 AEST 2018" notAfter: type: string description: e.g. "Sun Jun 30 23:59:50 AEST 2019" serialNumber: type: integer description: '18165099476682912368' TruststoreItems: type: object properties: alias: type: string description: Truststore alias name entryType: type: string subject: type: string description: e.g. "CN=localhost" issuer: type: string description: e.g. "CN=Admin" notBefore: type: string description: e.g. "Sun Jul 01 12:00:00 AEST 2018" notAfter: type: string description: e.g. "Sun Jun 30 23:59:50 AEST 2019" serialNumber: type: integer description: '18165099476682912368' SamlConfigurationInfo: type: object properties: pid: description: Persistent Identity (PID) type: string title: description: Title type: string description: description: Title type: string bundle_location: description: needed for configuration binding type: string service_location: description: needed for configuraiton binding type: string properties: $ref: '#/components/schemas/SamlConfigurationProperties' SamlConfigurationProperties: type: object properties: path: description: >- Repository path for which this authentication handler should be used by Sling. If this is empty, the authentication handler will be disabled. $ref: '#/components/schemas/SamlConfigurationPropertyItemsArray' service.ranking: description: >- OSGi Framework Service Ranking value to indicate the order in which to call this service. This is an int value where higher values designate higher precedence. Default value is 0. $ref: '#/components/schemas/SamlConfigurationPropertyItemsLong' idpUrl: description: >- URL of the IDP where the SAML Authentication Request should be sent to. If this property is empty the authentication handler is disabled. (idpUrl) $ref: '#/components/schemas/SamlConfigurationPropertyItemsString' idpCertAlias: description: >- The alias of the IdP's certificate in the global truststore. If this property is empty the authentication handler is disabled. $ref: '#/components/schemas/SamlConfigurationPropertyItemsString' idpHttpRedirect: description: >- Use an HTTP Redirect to the IDP URL instead of sending an AuthnRequest-message to request credentials. Use this for IDP initiated authentication. $ref: '#/components/schemas/SamlConfigurationPropertyItemsBoolean' serviceProviderEntityId: description: >- ID which uniquely identifies this service provider with the identity provider. If this property is empty the authentication handler is disabled. $ref: '#/components/schemas/SamlConfigurationPropertyItemsString' assertionConsumerServiceURL: description: >- The (optional) AssertionConsumerServiceURL attribute of an Authn request specifies the location to which a message MUST be sent to the requester. $ref: '#/components/schemas/SamlConfigurationPropertyItemsString' spPrivateKeyAlias: description: >- The alias of the SP's private key in the key-store of the 'authentication-service' system user. If this property is empty the handler will not be able to sign or decrypt messages. $ref: '#/components/schemas/SamlConfigurationPropertyItemsString' keyStorePassword: description: >- The password of the key-store of the 'authentication-service' system user. $ref: '#/components/schemas/SamlConfigurationPropertyItemsString' defaultRedirectUrl: description: The default location to redirect to after successful authentication. $ref: '#/components/schemas/SamlConfigurationPropertyItemsString' userIDAttribute: description: >- The name of the attribute containing the user ID used to authenticate and create the user in the CRX repository. Leave empty to use the Subject:NameId. $ref: '#/components/schemas/SamlConfigurationPropertyItemsString' useEncryption: description: >- Whether or not this authentication handler expects encrypted SAML assertions. If this is enabled the SP's private key must be provided in the key-store of the 'authentication-service' system user (see SP Private Key Alias above). $ref: '#/components/schemas/SamlConfigurationPropertyItemsBoolean' createUser: description: Whether or not to autocreate nonexisting users in the repository. $ref: '#/components/schemas/SamlConfigurationPropertyItemsBoolean' addGroupMemberships: description: >- Whether or not a user should be automatically added to CRX groups after successful authentication. $ref: '#/components/schemas/SamlConfigurationPropertyItemsBoolean' groupMembershipAttribute: description: >- The name of the attribute containing a list of CRX groups this user should be added to. $ref: '#/components/schemas/SamlConfigurationPropertyItemsString' defaultGroups: description: >- A list of default CRX groups users are added to after successful authentication. $ref: '#/components/schemas/SamlConfigurationPropertyItemsArray' nameIdFormat: description: >- The value of the NameIDPolicy format parameter to send in the AuthnRequest message. $ref: '#/components/schemas/SamlConfigurationPropertyItemsString' synchronizeAttributes: description: >- A list of attribute mappings (in the format \attributename=path/relative/to/user/node\) which should be stored in the repository on user-synchronization. $ref: '#/components/schemas/SamlConfigurationPropertyItemsArray' handleLogout: description: >- Whether or not logout (dropCredentials) requests will be processed by this handler. $ref: '#/components/schemas/SamlConfigurationPropertyItemsBoolean' logoutUrl: description: >- URL of the IDP where the SAML Logout Request should be sent to. If this property is empty the authentication handler won't handle logouts. $ref: '#/components/schemas/SamlConfigurationPropertyItemsString' clockTolerance: description: >- Time tolerance in seconds to compensate clock skew between IDP and SP when validating Assertions. $ref: '#/components/schemas/SamlConfigurationPropertyItemsLong' digestMethod: description: The digest algorithm to use when signing a SAML message. $ref: '#/components/schemas/SamlConfigurationPropertyItemsString' signatureMethod: description: The signature algorithm to use when signing a SAML message. $ref: '#/components/schemas/SamlConfigurationPropertyItemsString' userIntermediatePath: description: User intermediate path to store created users. $ref: '#/components/schemas/SamlConfigurationPropertyItemsString' SamlConfigurationPropertyItemsArray: type: object properties: name: description: property name type: string optional: description: True if optional type: boolean is_set: description: True if property is set type: boolean type: description: Property type, 1=String, 3=long, 11=boolean, 12=Password type: integer values: description: Property value type: array items: type: string description: description: Property description type: string SamlConfigurationPropertyItemsBoolean: type: object properties: name: description: property name type: string optional: description: True if optional type: boolean is_set: description: True if property is set type: boolean type: description: Property type, 1=String, 3=long, 11=boolean, 12=Password type: integer value: description: Property value type: boolean description: description: Property description type: string SamlConfigurationPropertyItemsLong: type: object properties: name: description: property name type: string optional: description: True if optional type: boolean is_set: description: True if property is set type: boolean type: description: Property type, 1=String, 3=long, 11=boolean, 12=Password type: integer value: description: Property value type: integer description: description: Property description type: string SamlConfigurationPropertyItemsString: type: object properties: name: description: property name type: string optional: description: True if optional type: boolean is_set: description: True if property is set type: boolean type: description: Property type, 1=String, 3=long, 11=boolean, 12=Password type: integer value: description: Property value type: string description: description: Property description type: string BundleInfo: type: object properties: status: type: string description: Status description of all bundles s: type: array items: type: integer data: type: array items: $ref: '#/components/schemas/BundleData' BundleData: type: object properties: id: type: integer description: Bundle ID name: type: string description: Bundle name fragment: type: boolean description: Is bundle a fragment stateRaw: type: integer description: Numeric raw bundle state value state: type: string description: Bundle state value version: type: string description: Bundle version symbolicName: type: string description: Bundle symbolic name category: type: string description: Bundle category props: type: array items: $ref: '#/components/schemas/BundleDataProp' BundleDataProp: type: object properties: key: type: string description: Bundle data key value: type: string description: Bundle data value