@adobe/aio-lib-console v5.2.0

Adobe I/O Console SDK Library

Installing

$ npm install @adobe/aio-lib-console

Usage

1) Initialize the SDK

const sdk = require('@adobe/aio-lib-console')

async function sdkTest() {
  //initialize sdk
  const client = await sdk.init('<valid auth token>', 'x-api-key')
}

2) Call methods using the initialized SDK

const sdk = require('@adobe/aio-lib-console')

async function sdkTest() {
  // initialize sdk
  const client = await sdk.init('<valid auth token>', 'x-api-key')

  // call methods
  try {
    // get... something
    const result = await client.getOrganizations()
    console.log(result)

  } catch (e) {
    console.error(e)
  }
}

Classes

Functions

Typedefs

CoreConsoleAPI

This class provides methods to call your CoreConsoleAPI APIs. Before calling any method, initialize the instance by calling the init method on it with valid values for apiKey and accessToken

Kind: global class

• CoreConsoleAPI
  • .init(accessToken, apiKey, env) ⇒ Promise.<CoreConsoleAPI>
  • .getProjectsForOrg(organizationId) ⇒ Promise.<Response>
  • .createFireflyProject(organizationId, projectDetails) ⇒ Promise.<Response>
  • .createProject(organizationId, projectDetails) ⇒ Promise.<Response>
  • .getWorkspacesForProject(organizationId, projectId) ⇒ Promise.<Response>
  • .deleteProject(organizationId, projectId) ⇒ Promise.<Response>
  • .editProject(organizationId, projectId, projectDetails) ⇒ Promise.<Response>
  • .getProject(organizationId, projectId) ⇒ Promise.<Response>
  • .downloadWorkspaceJson(organizationId, projectId, workspaceId) ⇒ Promise.<Response>
  • .createWorkspace(organizationId, projectId, workspaceDetails) ⇒ Promise.<Response>
  • .editWorkspace(organizationId, projectId, workspaceId, workspaceDetails) ⇒ Promise.<Response>
  • .getWorkspace(organizationId, projectId, workspaceId) ⇒ Promise.<Response>
  • .deleteWorkspace(organizationId, projectId, workspaceId) ⇒ Promise.<Response>
  • .getCredentials(organizationId, projectId, workspaceId) ⇒ Promise.<Response>
  • .createEnterpriseCredential(organizationId, projectId, workspaceId, certificate, name, description) ⇒ Promise.<Response>
  • .createAdobeIdCredential(organizationId, projectId, workspaceId, credentialDetails) ⇒ Promise.<Response>
  • .createAnalyticsCredential(organizationId, projectId, workspaceId, credentialDetails) ⇒ Promise.<Response>
  • .subscribeCredentialToServices(organizationId, projectId, workspaceId, credentialType, credentialId, serviceInfo) ⇒ Promise.<Response>
  • .getWorkspaceForCredential(organizationId, credentialId) ⇒ Promise.<Response>
  • .getProjectForWorkspace(organizationId, workspaceId) ⇒ Promise.<Response>
  • .deleteCredential(organizationId, projectId, workspaceId, credentialType, credentialId) ⇒ Promise.<Response>
  • .getOrganizations() ⇒ Promise.<Response>
  • .getServicesForOrg(organizationId) ⇒ Promise.<Response>
  • .checkOrgDevTerms(organizationId) ⇒ Promise.<Response>
  • .acceptOrgDevTerms(organizationId) ⇒ Promise.<Response>
  • .getDevTerms() ⇒ Promise.<Response>
  • .createRuntimeNamespace(organizationId, projectId, workspaceId) ⇒ Promise.<Response>
  • .getPluginsForWorkspace(organizationId, projectId, workspaceId) ⇒ Promise.<Response>
  • .getIntegrationsForOrg(organizationId) ⇒ Promise.<Response>
  • .createEnterpriseIntegration(organizationId, certificate, name, description) ⇒ Promise.<Response>
  • .createAdobeIdIntegration(organizationId, integrationDetails) ⇒ Promise.<Response>
  • .updateAdobeIdIntegration(organizationId, integrationId, integrationDetails) ⇒ Promise.<Response>
  • .subscribeAdobeIdIntegrationToServices(organizationId, integrationId, serviceInfo) ⇒ Promise.<Response>
  • .subscribeEnterpriseIntegrationToServices(organizationId, integrationId, serviceInfo) ⇒ Promise.<Response>
  • .getBindingsForIntegration(organizationId, integrationId) ⇒ Promise.<Response>
  • .uploadAndBindCertificate(organizationId, integrationId, certificate) ⇒ Promise.<Response>
  • .deleteBinding(organizationId, integrationId, bindingId) ⇒ Promise.<Response>
  • .getIntegration(organizationId, integrationId) ⇒ Promise.<Response>
  • .getIntegrationSecrets(organizationId, integrationId) ⇒ Promise.<Response>
  • .deleteIntegration(organizationId, integrationId) ⇒ Promise.<Response>
  • .createIMSOrg() ⇒ Promise.<Response>
  • .getAtlasApplicationPolicy(organizationId, integrationId) ⇒ Promise.<Response>
  • .getAtlasQuotaUsage(organizationId, integrationId) ⇒ Promise.<Response>
  • .getAllExtensionPoints(organizationId, [xpId], [options]) ⇒ Promise.<Response>
  • .getEndPointsInWorkspace(organizationId, projectId, workspaceId) ⇒ Promise.<Response>
  • .updateEndPointsInWorkspace(organizationId, projectId, workspaceId, endpointDetails) ⇒ Promise.<Response>
  • .getSDKProperties(organizationId, integrationId, sdkCode) ⇒ Promise.<Response>
  • .createOauthS2SCredentialIntegration(organizationId, integrationDetails) ⇒ Promise.<Response>

coreConsoleAPI.init(accessToken, apiKey, env) ⇒ Promise.<CoreConsoleAPI>

Initializes a CoreConsoleAPI object and returns it

Kind: instance method of CoreConsoleAPI
Returns: Promise.<CoreConsoleAPI> - a CoreConsoleAPI object

coreConsoleAPI.getProjectsForOrg(organizationId) ⇒ Promise.<Response>

Get all Projects in an Organization

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.createFireflyProject(organizationId, projectDetails) ⇒ Promise.<Response>

Create a new App Builder Project (from template) in an Organization

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.createProject(organizationId, projectDetails) ⇒ Promise.<Response>

Create a new Project in an Organization

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getWorkspacesForProject(organizationId, projectId) ⇒ Promise.<Response>

Get all Workspaces for a Project

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.deleteProject(organizationId, projectId) ⇒ Promise.<Response>

Delete a Project

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.editProject(organizationId, projectId, projectDetails) ⇒ Promise.<Response>

Edit a Project

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getProject(organizationId, projectId) ⇒ Promise.<Response>

Get a Project by ID

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.downloadWorkspaceJson(organizationId, projectId, workspaceId) ⇒ Promise.<Response>

Download the Workspace Configuration File (json)

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.createWorkspace(organizationId, projectId, workspaceDetails) ⇒ Promise.<Response>

Create a new Workspace

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.editWorkspace(organizationId, projectId, workspaceId, workspaceDetails) ⇒ Promise.<Response>

Edit a Workspace

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getWorkspace(organizationId, projectId, workspaceId) ⇒ Promise.<Response>

Get a Workspace by ID

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.deleteWorkspace(organizationId, projectId, workspaceId) ⇒ Promise.<Response>

Delete a Workspace

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getCredentials(organizationId, projectId, workspaceId) ⇒ Promise.<Response>

Get all credentials for a Workspace

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.createEnterpriseCredential(organizationId, projectId, workspaceId, certificate, name, description) ⇒ Promise.<Response>

Create a new Enterprise Credential for a Workspace

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.createAdobeIdCredential(organizationId, projectId, workspaceId, credentialDetails) ⇒ Promise.<Response>

Create a new AdobeID Credential for a Workspace

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.createAnalyticsCredential(organizationId, projectId, workspaceId, credentialDetails) ⇒ Promise.<Response>

Create a new Analytics Credential for a Workspace

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.subscribeCredentialToServices(organizationId, projectId, workspaceId, credentialType, credentialId, serviceInfo) ⇒ Promise.<Response>

Subscribe a Workspace Credential to Services

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getWorkspaceForCredential(organizationId, credentialId) ⇒ Promise.<Response>

Get the Workspace from a Credential ID

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getProjectForWorkspace(organizationId, workspaceId) ⇒ Promise.<Response>

Get the Project of a Workspace

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.deleteCredential(organizationId, projectId, workspaceId, credentialType, credentialId) ⇒ Promise.<Response>

Delete a Workspace Credential

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getOrganizations() ⇒ Promise.<Response>

Get all Organizations

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getServicesForOrg(organizationId) ⇒ Promise.<Response>

Get all Services available to an Organization

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.checkOrgDevTerms(organizationId) ⇒ Promise.<Response>

Check developer terms acceptance

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.acceptOrgDevTerms(organizationId) ⇒ Promise.<Response>

Accept developer terms

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getDevTerms() ⇒ Promise.<Response>

Get developer terms

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.createRuntimeNamespace(organizationId, projectId, workspaceId) ⇒ Promise.<Response>

Create an Adobe I/O Runtime namespace in the given workspace

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getPluginsForWorkspace(organizationId, projectId, workspaceId) ⇒ Promise.<Response>

Get plugins for workspace

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getIntegrationsForOrg(organizationId) ⇒ Promise.<Response>

Get Integrations for an Organization

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.createEnterpriseIntegration(organizationId, certificate, name, description) ⇒ Promise.<Response>

Create a new Enterprise Integration for an Organization

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.createAdobeIdIntegration(organizationId, integrationDetails) ⇒ Promise.<Response>

Create a new AdobeID Integration for an Organization

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.updateAdobeIdIntegration(organizationId, integrationId, integrationDetails) ⇒ Promise.<Response>

Update an AdobeID Integration for an Organization

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.subscribeAdobeIdIntegrationToServices(organizationId, integrationId, serviceInfo) ⇒ Promise.<Response>

Subscribe Organization AdobeId Integration to Services

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.subscribeEnterpriseIntegrationToServices(organizationId, integrationId, serviceInfo) ⇒ Promise.<Response>

Subscribe Organization Enterprise Integration to Services

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getBindingsForIntegration(organizationId, integrationId) ⇒ Promise.<Response>

List certification bindings for an Integration

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.uploadAndBindCertificate(organizationId, integrationId, certificate) ⇒ Promise.<Response>

Upload and bind a certificate to an Organization Integration

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.deleteBinding(organizationId, integrationId, bindingId) ⇒ Promise.<Response>

Delete a certificate binding for an Integration

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getIntegration(organizationId, integrationId) ⇒ Promise.<Response>

Get Integration details

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getIntegrationSecrets(organizationId, integrationId) ⇒ Promise.<Response>

Get Integration secrets

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.deleteIntegration(organizationId, integrationId) ⇒ Promise.<Response>

Delete an Integration

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.createIMSOrg() ⇒ Promise.<Response>

Create an IMS Org

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getAtlasApplicationPolicy(organizationId, integrationId) ⇒ Promise.<Response>

Get Application Atlas Policy for an Integration

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getAtlasQuotaUsage(organizationId, integrationId) ⇒ Promise.<Response>

Get Atlas quota usage for an Integration

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getAllExtensionPoints(organizationId, xpId, options) ⇒ Promise.<Response>

Get all available extension points

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getEndPointsInWorkspace(organizationId, projectId, workspaceId) ⇒ Promise.<Response>

Get endpoints in a workspace

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.updateEndPointsInWorkspace(organizationId, projectId, workspaceId, endpointDetails) ⇒ Promise.<Response>

Update endpoints in a workspace

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.getSDKProperties(organizationId, integrationId, sdkCode) ⇒ Promise.<Response>

Get details about a service (SDK) subscribed to an integration

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

coreConsoleAPI.createOauthS2SCredentialIntegration(organizationId, integrationDetails) ⇒ Promise.<Response>

Create a new oauth server to server credential for an Organization

Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response

createRequestOptions(apiKey, options) ⇒ Array

Create request options compatible with the console swagger definition

Kind: global function
Returns: Array - { swaggerParameters }, { requestBody }

requestInterceptorBuilder(coreConsoleAPIInstance, apihost) ⇒ function

Build a swagger request interceptor for the console sdk

Kind: global function
Returns: function - a request interceptor

responseInterceptor(res) ⇒ object

A swagger response interceptor for the console sdk

Kind: global function
Returns: object - the response object

init(accessToken, apiKey, env) ⇒ Promise.<CoreConsoleAPI>

Returns a Promise that resolves with a new CoreConsoleAPI object

Kind: global function
Returns: Promise.<CoreConsoleAPI> - a Promise with a CoreConsoleAPI object

Response : object

Kind: global typedef
Properties

ProjectDetails : object

Kind: global typedef
Properties

WorkspaceDetails : object

Kind: global typedef
Properties

AdobeIdIntegrationDetails : object

Kind: global typedef
Properties

ExtensionIcon : object

Kind: global typedef
Properties

ExtensionMedia : object

Kind: global typedef
Properties

ExtensionDetails : object

Kind: global typedef
Properties

ExtensionSubmissionDetails : object

Kind: global typedef
Properties

ExtensionWorkspaceEndpoints : object

Kind: global typedef
Properties

ExtensionWorkspaceServices : object

Kind: global typedef
Properties

ExtensionWorkspaceDetails : object

Kind: global typedef
Properties

ServiceInfo : object

Kind: global typedef
Properties

SubscribeToServices : object

Kind: global typedef
Properties

LicenseConfig : object

Kind: global typedef
Properties

Role : object

Kind: global typedef
Properties

OauthS2SIntegrationDetails : object

Kind: global typedef
Properties

Debug Logs

LOG_LEVEL=debug <your_call_here>

Prepend the LOG_LEVEL environment variable and debug value to the call that invokes your function, on the command line. This should output a lot of debug data for your SDK calls.

Contributing

Contributions are welcome! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.