@adobe/aio-lib-console
v5.3.2
Published
Adobe I/O Lib for the Developer Console
Downloads
32,445
Maintainers
Keywords
Readme
Adobe I/O Console SDK Library
Installing
$ npm install @adobe/aio-lib-console
Usage
- 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')
}
- 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>
- .createOAuthServerToServerCredential(organizationId, projectId, workspaceId, name, description) ⇒ Promise.<Response>
- .getProjectInstallConfig(projectId) ⇒ 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>~~
- .deleteCredentialById(organizationId, projectId, workspaceId, credentialId) ⇒ Promise.<Response>
- .getOrganizations() ⇒ Promise.<Response>
- .getServicesForOrg(organizationId, sdkCodes) ⇒ Promise.<Response>
- .getServicesForOrgV2(imsOrgId, sdkCodes) ⇒ 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>
- .subscribeOAuthServerToServerIntegrationToServices(organizationId, credentialId, 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>
- .getApplicationExtensions(organizationId, applicationId) ⇒ 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
| Param | Type | Description |
| --- | --- | --- |
| accessToken | string | the access token corresponding to an integration or user token |
| apiKey | string | api key to access the Developer Console |
| env | string | The name of the environment. prod
and stage
are the only values supported. prod
is default and any value other than prod
or stage
it is assumed to be the default value of prod
. If not set, it will get the global cli env value. See https://github.com/adobe/aio-lib-env (which defaults to prod
as well if not set) |
coreConsoleAPI.getProjectsForOrg(organizationId) ⇒ Promise.<Response>
Get all Projects in an Organization
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID |
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
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectDetails | ProjectDetails | Project details including name, title, who_created, description and type |
coreConsoleAPI.createProject(organizationId, projectDetails) ⇒ Promise.<Response>
Create a new Project in an Organization
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectDetails | ProjectDetails | Project details including name, title, who_created, description and type |
coreConsoleAPI.getWorkspacesForProject(organizationId, projectId) ⇒ Promise.<Response>
Get all Workspaces for a Project
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID |
coreConsoleAPI.deleteProject(organizationId, projectId) ⇒ Promise.<Response>
Delete a Project
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID |
coreConsoleAPI.editProject(organizationId, projectId, projectDetails) ⇒ Promise.<Response>
Edit a Project
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | projectDetails | ProjectDetails | Project details including name, title, who_created, description and type |
coreConsoleAPI.getProject(organizationId, projectId) ⇒ Promise.<Response>
Get a Project by ID
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID |
coreConsoleAPI.downloadWorkspaceJson(organizationId, projectId, workspaceId) ⇒ Promise.<Response>
Download the Workspace Configuration File (json)
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID |
coreConsoleAPI.createWorkspace(organizationId, projectId, workspaceDetails) ⇒ Promise.<Response>
Create a new Workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceDetails | WorkspaceDetails | Workspace details including name, title, who_created, description, type and quotaRule |
coreConsoleAPI.editWorkspace(organizationId, projectId, workspaceId, workspaceDetails) ⇒ Promise.<Response>
Edit a Workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID | | workspaceDetails | WorkspaceDetails | Workspace details including name, title, who_created, description, type and quotaRule |
coreConsoleAPI.getWorkspace(organizationId, projectId, workspaceId) ⇒ Promise.<Response>
Get a Workspace by ID
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID |
coreConsoleAPI.deleteWorkspace(organizationId, projectId, workspaceId) ⇒ Promise.<Response>
Delete a Workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID |
coreConsoleAPI.getCredentials(organizationId, projectId, workspaceId) ⇒ Promise.<Response>
Get all credentials for a Workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID |
coreConsoleAPI.createOAuthServerToServerCredential(organizationId, projectId, workspaceId, name, description) ⇒ Promise.<Response>
Create a new OAuth Server-to-Server Credential for a Workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID | | name | string | Credential name | | description | string | Credential description |
coreConsoleAPI.getProjectInstallConfig(projectId) ⇒ Promise.<Response>
Get the install config for an Adobe Developer Console project
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | projectId | string | Project ID |
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
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID | | certificate | object | A Readable stream with certificate content. eg: fs.createReadStream() | | name | string | Credential name | | description | string | Credential description |
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
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID | | credentialDetails | AdobeIdIntegrationDetails | Credential details |
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
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID | | credentialDetails | AdobeIdIntegrationDetails | Credential details |
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
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID | | credentialType | string | Credential type (adobeid, analytics or entp) | | credentialId | string | Credential ID | | serviceInfo | Array.<ServiceInfo> | Information about the services like SDK Codes, licenseConfig and roles |
coreConsoleAPI.getWorkspaceForCredential(organizationId, credentialId) ⇒ Promise.<Response>
Get the Workspace from a Credential ID
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | credentialId | string | Credential ID |
coreConsoleAPI.getProjectForWorkspace(organizationId, workspaceId) ⇒ Promise.<Response>
Get the Project of a Workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | workspaceId | string | Workspace ID |
~~coreConsoleAPI.deleteCredential(organizationId, projectId, workspaceId, credentialType, credentialId) ⇒ Promise.<Response>~~
Deprecated
Delete a Workspace Credential
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID | | credentialType | string | Credential type (adobeid, analytics or entp). Unused. | | credentialId | string | Credential ID |
coreConsoleAPI.deleteCredentialById(organizationId, projectId, workspaceId, credentialId) ⇒ Promise.<Response>
Delete a Workspace Credential by credential id.
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID | | credentialId | string | Credential ID |
coreConsoleAPI.getOrganizations() ⇒ Promise.<Response>
Get all Organizations
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
coreConsoleAPI.getServicesForOrg(organizationId, sdkCodes) ⇒ Promise.<Response>
Get all Services available to an Organization
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | sdkCodes | string | comma separated list of sdk codes |
coreConsoleAPI.getServicesForOrgV2(imsOrgId, sdkCodes) ⇒ Promise.<Response>
Get org services v2. Can be used for getting services for a user in an org irrespective of the user's role in the org. They should just be a member. Also includes the information needed for requesting access to services that support it.
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | imsOrgId | string | IMS org id in format abc@AdobeOrg | | sdkCodes | string | comma separated list of sdk codes |
coreConsoleAPI.checkOrgDevTerms(organizationId) ⇒ Promise.<Response>
Check developer terms acceptance
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID |
coreConsoleAPI.acceptOrgDevTerms(organizationId) ⇒ Promise.<Response>
Accept developer terms
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID |
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
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID |
coreConsoleAPI.getPluginsForWorkspace(organizationId, projectId, workspaceId) ⇒ Promise.<Response>
Get plugins for workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID |
coreConsoleAPI.getIntegrationsForOrg(organizationId) ⇒ Promise.<Response>
Get Integrations for an Organization
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID |
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
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | certificate | object | A Readable stream with certificate content. eg: fs.createReadStream() | | name | string | Integration name | | description | string | Integration description |
coreConsoleAPI.createAdobeIdIntegration(organizationId, integrationDetails) ⇒ Promise.<Response>
Create a new AdobeID Integration for an Organization
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | integrationDetails | AdobeIdIntegrationDetails | Integration details |
coreConsoleAPI.updateAdobeIdIntegration(organizationId, integrationId, integrationDetails) ⇒ Promise.<Response>
Update an AdobeID Integration for an Organization
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | integrationId | string | Integration ID to update | | integrationDetails | AdobeIdIntegrationDetails | Integration details |
coreConsoleAPI.subscribeAdobeIdIntegrationToServices(organizationId, integrationId, serviceInfo) ⇒ Promise.<Response>
Subscribe Organization AdobeId Integration to Services
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | integrationId | string | Integration ID | | serviceInfo | object | Information about the services like SDK Codes, licenseConfig and roles |
coreConsoleAPI.subscribeEnterpriseIntegrationToServices(organizationId, integrationId, serviceInfo) ⇒ Promise.<Response>
Subscribe Organization Enterprise Integration to Services
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | integrationId | string | Integration ID | | serviceInfo | object | Information about the services like SDK Codes, licenseConfig and roles |
coreConsoleAPI.subscribeOAuthServerToServerIntegrationToServices(organizationId, credentialId, serviceInfo) ⇒ Promise.<Response>
Subscribe Organization OAuth Server-to-Server Integration to Services
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | credentialId | string | Credential ID | | serviceInfo | object | Information about the services like SDK Codes, licenseConfig and roles |
coreConsoleAPI.getBindingsForIntegration(organizationId, integrationId) ⇒ Promise.<Response>
List certification bindings for an Integration
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | integrationId | string | Integration ID |
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
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | integrationId | string | Integration ID | | certificate | object | A Readable stream with certificate content. eg: fs.createReadStream() |
coreConsoleAPI.deleteBinding(organizationId, integrationId, bindingId) ⇒ Promise.<Response>
Delete a certificate binding for an Integration
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | integrationId | string | Integration ID | | bindingId | string | Binding ID |
coreConsoleAPI.getIntegration(organizationId, integrationId) ⇒ Promise.<Response>
Get Integration details
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | integrationId | string | Integration ID |
coreConsoleAPI.getIntegrationSecrets(organizationId, integrationId) ⇒ Promise.<Response>
Get Integration secrets
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | integrationId | string | Integration ID |
coreConsoleAPI.deleteIntegration(organizationId, integrationId) ⇒ Promise.<Response>
Delete an Integration
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | integrationId | string | Integration ID |
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
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | integrationId | string | Integration ID |
coreConsoleAPI.getAtlasQuotaUsage(organizationId, integrationId) ⇒ Promise.<Response>
Get Atlas quota usage for an Integration
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | integrationId | string | Integration ID |
coreConsoleAPI.getAllExtensionPoints(organizationId, [xpId], [options]) ⇒ Promise.<Response>
Get all available extension points
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Default | Description | | --- | --- | --- | --- | | organizationId | string | | Organization AMS ID | | [xpId] | string | "firefly" | xp ID, default 'firefly' | | [options] | object | | Get options | | [options.offset] | number | | Offset | | [options.pageSize] | number | | page size |
coreConsoleAPI.getApplicationExtensions(organizationId, applicationId) ⇒ Promise.<Response>
Get Extensions for an App Builder application
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | applicationId | string | App Builder Application ID |
coreConsoleAPI.getEndPointsInWorkspace(organizationId, projectId, workspaceId) ⇒ Promise.<Response>
Get endpoints in a workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID |
coreConsoleAPI.updateEndPointsInWorkspace(organizationId, projectId, workspaceId, endpointDetails) ⇒ Promise.<Response>
Update endpoints in a workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | projectId | string | Project ID | | workspaceId | string | Workspace ID | | endpointDetails | object | endpoint details |
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
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | integrationId | string | Integration ID | | sdkCode | string | the service sdkCode to query (e.g. AdobeAnalyticsSDK) |
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
| Param | Type | Description | | --- | --- | --- | | organizationId | string | Organization AMS ID | | integrationDetails | OauthS2SIntegrationDetails | Integration details |
createRequestOptions(apiKey, options) ⇒ Array
Create request options compatible with the console swagger definition
Kind: global function
Returns: Array - [{ swaggerParameters }, { requestBody }]
| Param | Type | Description | | --- | --- | --- | | apiKey | string | apiKey to access console api | | options | object | optional data used for building the request options | | [options.parameters] | object | parameters to set to the request, specific to each endpoint | | [options.body] | object | request body for the request |
requestInterceptorBuilder(coreConsoleAPIInstance, apihost) ⇒ function
Build a swagger request interceptor for the console sdk
Kind: global function
Returns: function - a request interceptor
| Param | Type | Description | | --- | --- | --- | | coreConsoleAPIInstance | object | console core api instance | | apihost | string | console api url host |
responseInterceptor(res) ⇒ object
A swagger response interceptor for the console sdk
Kind: global function
Returns: object - the response object
| Param | Type | Description | | --- | --- | --- | | res | 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
| Param | Type | Description |
| --- | --- | --- |
| accessToken | string | the access token corresponding to an integration or user token |
| apiKey | string | api key to access the Developer Console |
| env | string | The name of the environment. prod
and stage
are the only values supported. prod
is default and any value other than prod
or stage
it is assumed to be the default value of prod
. If not set, it will get the global cli env value. See https://github.com/adobe/aio-lib-env (which defaults to prod
as well if not set) |
Response : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | url | string | requested url | | ok | boolean | response ok indicator | | status | number | response status code | | statusText | number | response status text | | headers | object | response headers | | body | object | response body object | | obj | object | response body object | | data | object | response body string | | text | object | response body string |
ProjectDetails : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | name | string | Name | | title | string | Title | | [who_created] | string | Creator name | | [description] | string | Description | | type | string | Type (default or jaeger) |
WorkspaceDetails : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | name | string | Name | | [title] | string | Title | | [who_created] | string | Creator name | | [description] | string | Description | | [type] | string | Type | | [quotaRule] | string | quotaRule |
AdobeIdIntegrationDetails : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | name | string | Name | | description | string | Description | | platform | string | Platform | | [urlScheme] | string | url scheme | | [redirectUriList] | object | List of redirect URIs | | [defaultRedirectUri] | string | Default redirect URI | | [domain] | string | domain | | [approvalInfo] | object | approvalInfo | | [templateId] | string | templateId | | [services] | Array.<SubscribeToServices> | services |
ExtensionIcon : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | id | string | Id |
ExtensionMedia : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | id | string | Id | | type | string | Type | | order | string | order |
ExtensionDetails : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | name | string | Name | | title | string | Title | | description | string | Description | | version | string | Version | | icon | ExtensionIcon | Icon | | media | Array.<ExtensionMedia> | array of Media Objects |
ExtensionSubmissionDetails : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | appType | string | app type | | id | string | Id | | notes | string | Notes |
ExtensionWorkspaceEndpoints : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | additionalProp1 | object | additional property 1 | | additionalProp2 | object | additional property 2 |
ExtensionWorkspaceServices : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | code | string | Code | | name | string | Name | | licenseGroupIds | Array.<string> | License group Ids |
ExtensionWorkspaceDetails : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | id | string | Id | | name | string | Name | | endpoints | ExtensionWorkspaceEndpoints | Description | | services | ExtensionWorkspaceServices | Services | | icon | ExtensionIcon | Icon | | releaseNotes | string | Release Notes | | technicalUserId | string | Technical user Id | | appId | string | App Id | | publisherId | string | Publisher Id |
ServiceInfo : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | sdkCode | string | the sdk code | | roles | Array.<Role> | the roles | | licenseConfigs | Array.<LicenseConfig> | the license configs |
SubscribeToServices : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | sdkCode | string | the sdk code | | atlasPlanCode | string | the atlas plan code | | roles | Array.<Role> | the roles | | licenseConfigs | Array.<LicenseConfig> | the license configs |
LicenseConfig : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | op | string | the operation (e.g. 'add') | | id | string | the license id | | productId | string | the product id |
Role : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | id | number | the role id | | code | string | the role code | | name | string | the role name |
OauthS2SIntegrationDetails : object
Kind: global typedef
Properties
| Name | Type | Description | | --- | --- | --- | | name | string | Name | | description | string | Description | | [templateId] | string | templateId | | [services] | Array.<SubscribeToServices> | services |
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.