Adobe I/O Lib for the Developer Console
npm install @adobe/aio-lib-console
``bash`
$ npm install @adobe/aio-lib-console
`javascript
const sdk = require('@adobe/aio-lib-console')
async function sdkTest() {
//initialize sdk
const client = await sdk.init('
}
`
2) Call methods using the initialized SDK
`javascript
const sdk = require('@adobe/aio-lib-console')
async function sdkTest() {
// initialize sdk
const client = await sdk.init('
// call methods
try {
// get... something
const result = await client.getOrganizations()
console.log(result)
} catch (e) {
console.error(e)
}
}
`
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
ArrayCreate request options compatible with the console swagger definition
functionBuild a swagger request interceptor for the console sdk
objectA swagger response interceptor for the console sdk
objectUse axios lib to directly call console API to create credential
Promise.<CoreConsoleAPI>Returns a Promise that resolves with a new CoreConsoleAPI object
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectobjectobjectobjectobjectobjectobject method on it
with valid values for apiKey and accessTokenKind: global class
* CoreConsoleAPI
* .init(accessToken, apiKey, env, swaggerSpec) ⇒ 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])](#CoreConsoleAPI+getAllExtensionPoints) ⇒ 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>
* .getWorkspaceInfoForRuntimeNamespace(organizationId, namespace) ⇒ Promise.<Response>
$3
Initializes a CoreConsoleAPI object and returns itKind: 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) |
| swaggerSpec | object | the swagger spec for the API (optional) |$3
Get all Projects in an OrganizationKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
$3
Create a new App Builder Project (from template) in an OrganizationKind: 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 |
$3
Create a new Project in an OrganizationKind: 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 |
$3
Get all Workspaces for a ProjectKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| projectId | string | Project ID |
$3
Delete a ProjectKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| projectId | string | Project ID |
$3
Edit a ProjectKind: 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 |
$3
Get a Project by IDKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| projectId | string | Project ID |
$3
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 |
$3
Create a new WorkspaceKind: 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 |
$3
Edit a WorkspaceKind: 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 |
$3
Get a Workspace by IDKind: 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 |
$3
Delete a WorkspaceKind: 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 |
$3
Get all credentials for a WorkspaceKind: 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 |
$3
Create a new OAuth Server-to-Server Credential for a WorkspaceKind: 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 |
$3
Get the install config for an Adobe Developer Console projectKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| projectId | string | Project ID |
$3
Create a new Enterprise Credential for a WorkspaceKind: 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 |
$3
Create a new AdobeID Credential for a WorkspaceKind: 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 |
$3
Create a new Analytics Credential for a WorkspaceKind: 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 |
$3
Subscribe a Workspace Credential to ServicesKind: 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 |
$3
Get the Workspace from a Credential IDKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| credentialId | string | Credential ID |
$3
Get the Project of a WorkspaceKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| workspaceId | string | Workspace ID |
$3
DeprecatedDelete 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 |
$3
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 |
$3
Get all OrganizationsKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
$3
Get all Services available to an OrganizationKind: 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 |
$3
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 |
$3
Check developer terms acceptanceKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
$3
Accept developer termsKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
$3
Get developer termsKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
$3
Create an Adobe I/O Runtime namespace in the given workspaceKind: 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 |
$3
Get plugins for workspaceKind: 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 |
$3
Get Integrations for an OrganizationKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
$3
Create a new Enterprise Integration for an OrganizationKind: 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 |
$3
Create a new AdobeID Integration for an OrganizationKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| integrationDetails | AdobeIdIntegrationDetails | Integration details |
$3
Update an AdobeID Integration for an OrganizationKind: 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 |
$3
Subscribe Organization AdobeId Integration to ServicesKind: 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 |
$3
Subscribe Organization Enterprise Integration to ServicesKind: 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 |
$3
Subscribe Organization OAuth Server-to-Server Integration to ServicesKind: 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 |
$3
List certification bindings for an IntegrationKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| integrationId | string | Integration ID |
$3
Upload and bind a certificate to an Organization IntegrationKind: 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() |
$3
Delete a certificate binding for an IntegrationKind: 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 |
$3
Get Integration detailsKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| integrationId | string | Integration ID |
$3
Get Integration secretsKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| integrationId | string | Integration ID |
$3
Delete an IntegrationKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| integrationId | string | Integration ID |
$3
Create an IMS OrgKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
$3
Get Application Atlas Policy for an IntegrationKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| integrationId | string | Integration ID |
$3
Get Atlas quota usage for an IntegrationKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| integrationId | string | Integration ID |
$3
Get all available extension pointsKind: 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 |
$3
Get Extensions for an App Builder applicationKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| applicationId | string | App Builder Application ID |
$3
Get endpoints in a workspaceKind: 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 |
$3
Update endpoints in a workspaceKind: 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 |
$3
Get details about a service (SDK) subscribed to an integrationKind: 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) |
$3
Create a new oauth server to server credential for an OrganizationKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| integrationDetails | OauthS2SIntegrationDetails | Integration details |
$3
Returns workspace info for runtime namespaceKind: instance method of CoreConsoleAPI
Returns: Promise.<Response> - the response
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | Organization AMS ID |
| namespace | string | Runtime namespace |
createRequestOptions(apiKey, options) ⇒ Array
Create request options compatible with the console swagger definitionKind: 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 sdkKind: 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 sdkKind: global function
Returns: object - the response object
| Param | Type | Description |
| --- | --- | --- |
| res | object | the response object |
createCredentialDirect(url, accessToken, apiKey, certificate, name, description) ⇒ object
Use axios lib to directly call console API to create credentialKind: global function
Returns: object - The response object
| Param | Type | Description |
| --- | --- | --- |
| url | string | URL string |
| accessToken | string | Token to call the API |
| apiKey | string | Api key |
| certificate | object | A Readable stream with certificate content. eg: fs.createReadStream() |
| name | string | Credential name |
| description | string | Credential description |
init(accessToken, apiKey, env, swaggerSpec) ⇒ Promise.<CoreConsoleAPI>
Returns a Promise that resolves with a new CoreConsoleAPI objectKind: 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) |
| swaggerSpec | object | the swagger spec for the API (optional) |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 |
$3
`bash
LOG_LEVEL=debug
`Prepend the
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.Contributions are welcome! Read the Contributing Guide for more information.
This project is licensed under the Apache V2 License. See LICENSE for more information.