Big News: Socket raises $60M Series C at a $1B valuation to secure software supply chains for AI-driven development.Announcement →
Sign In

@adobe/aio-cli-plugin-auth

Package Overview
Dependencies
Maintainers
31
Versions
33
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@adobe/aio-cli-plugin-auth - npm Package Compare versions

Comparing version
4.0.1
 to
4.1.0
+10
-10
package.json
{
"name": "@adobe/aio-cli-plugin-auth",
"description": "The IMS plugin to aio supports managing tokens for IMS such as login, logout, and retrieving and using tokens.",
"version": "4.0.1",
"version": "4.1.0",
"author": "Adobe",

@@ -10,3 +10,3 @@ "bugs": "https://github.com/adobe/aio-cli-plugin-auth/issues",

"@adobe/aio-lib-core-logging": "^3",
"@adobe/aio-lib-ims": "^7",
"@adobe/aio-lib-ims": "^8",
"@oclif/core": "2.8.12",

@@ -19,13 +19,13 @@ "debug": "^4.1.1",

"devDependencies": {
"@adobe/eslint-config-aio-lib-config": "^3.0.0",
"@adobe/eslint-config-aio-lib-config": "^4.0.0",
"chalk": "^4.0.0",
"eslint": "^8.46.0",
"eslint": "^8.57.1",
"eslint-config-oclif": "^4.0.0",
"eslint-config-standard": "^17.1.0",
"eslint-plugin-import": "^2.28.0",
"eslint-plugin-jest": "^27.2.3",
"eslint-plugin-jsdoc": "^42.0.0",
"eslint-plugin-n": "^15.7",
"eslint-plugin-import": "^2.31.0",
"eslint-plugin-jest": "^27.9.0",
"eslint-plugin-jsdoc": "^48.11.0",
"eslint-plugin-n": "^15.7.0",
"eslint-plugin-node": "^11.1.0",
"eslint-plugin-promise": "^6.1.1",
"eslint-plugin-promise": "^6.6.0",
"eslint-plugin-standard": "^5.0.0",

@@ -39,3 +39,3 @@ "execa": "^4.0.0",

"engines": {
"node": ">=18"
"node": ">=20"
},

@@ -42,0 +42,0 @@ "files": [

+176
-4
README.md

@@ -75,2 +75,6 @@ aio-cli-plugin-auth

* [`aio auth logout`](#aio-auth-logout)
* [`aio context`](#aio-context)
* [`aio ctx`](#aio-ctx)
* [`aio login`](#aio-login)
* [`aio logout`](#aio-logout)

@@ -133,3 +137,3 @@ ## `aio auth`

_See code: [src/commands/auth/index.js](https://github.com/adobe/aio-cli-plugin-auth/blob/4.0.1/src/commands/auth/index.js)_
_See code: [src/commands/auth/index.js](https://github.com/adobe/aio-cli-plugin-auth/blob/4.1.0/src/commands/auth/index.js)_

@@ -179,3 +183,3 @@ ## `aio auth ctx`

_See code: [src/commands/auth/ctx.js](https://github.com/adobe/aio-cli-plugin-auth/blob/4.0.1/src/commands/auth/ctx.js)_
_See code: [src/commands/auth/ctx.js](https://github.com/adobe/aio-cli-plugin-auth/blob/4.1.0/src/commands/auth/ctx.js)_

@@ -231,3 +235,3 @@ ## `aio auth login`

_See code: [src/commands/auth/login.js](https://github.com/adobe/aio-cli-plugin-auth/blob/4.0.1/src/commands/auth/login.js)_
_See code: [src/commands/auth/login.js](https://github.com/adobe/aio-cli-plugin-auth/blob/4.1.0/src/commands/auth/login.js)_

@@ -267,3 +271,171 @@ ## `aio auth logout`

_See code: [src/commands/auth/logout.js](https://github.com/adobe/aio-cli-plugin-auth/blob/4.0.1/src/commands/auth/logout.js)_
_See code: [src/commands/auth/logout.js](https://github.com/adobe/aio-cli-plugin-auth/blob/4.1.0/src/commands/auth/logout.js)_
## `aio context`
Manage Adobe IMS contexts.
```
USAGE
$ aio context [--debug <value>] [-v] [-l | -g] [-c <value>] [--list | --value | -s <value> | ]
FLAGS
-c, --ctx=<value> Name of the Adobe IMS context to use. Default is the current Adobe IMS context
-g, --global global config
-l, --local local config
-s, --set=<value> Sets the name of the current local Adobe IMS context
-v, --verbose Verbose output
--debug=<value> Debug level output
--list Names of the Adobe IMS contexts as an array
--value Prints named or current Adobe IMS context data
DESCRIPTION
Manage Adobe IMS contexts.
The following options exist for this command:
* List the names of the configured Adobe IMS contexts
* Print the name of the current Adobe IMS context
* Set the name of the current Adobe IMS context
* Print the configuration of the current or a named Adobe IMS context
Currently it is not possible to update the Adobe Adobe IMS context configuration
using this command. Use the "aio config" commands for this.
e.g. aio config:set ims.contexts.your_context.your_context_key "your_context_value"
Please note, that the following IMS context label names is reserved: `cli`
and should not be used as an IMS context name.
Also note that the current context can only be set locally.
ALIASES
$ aio ctx
$ aio context
```
## `aio ctx`
Manage Adobe IMS contexts.
```
USAGE
$ aio ctx [--debug <value>] [-v] [-l | -g] [-c <value>] [--list | --value | -s <value> | ]
FLAGS
-c, --ctx=<value> Name of the Adobe IMS context to use. Default is the current Adobe IMS context
-g, --global global config
-l, --local local config
-s, --set=<value> Sets the name of the current local Adobe IMS context
-v, --verbose Verbose output
--debug=<value> Debug level output
--list Names of the Adobe IMS contexts as an array
--value Prints named or current Adobe IMS context data
DESCRIPTION
Manage Adobe IMS contexts.
The following options exist for this command:
* List the names of the configured Adobe IMS contexts
* Print the name of the current Adobe IMS context
* Set the name of the current Adobe IMS context
* Print the configuration of the current or a named Adobe IMS context
Currently it is not possible to update the Adobe Adobe IMS context configuration
using this command. Use the "aio config" commands for this.
e.g. aio config:set ims.contexts.your_context.your_context_key "your_context_value"
Please note, that the following IMS context label names is reserved: `cli`
and should not be used as an IMS context name.
Also note that the current context can only be set locally.
ALIASES
$ aio ctx
$ aio context
```
## `aio login`
Log in with a certain Adobe IMS context and returns the access token.
```
USAGE
$ aio login [--debug <value>] [-v] [-l | -g] [-c <value>] [-f] [-d] [-b] [-o]
FLAGS
-b, --bare print access token only
-c, --ctx=<value> Name of the Adobe IMS context to use. Default is the current Adobe IMS context
-d, --decode Decode and display access token data
-f, --force Force logging in. This causes a forced logout on the context first and makes sure to not use any
cached data when calling the plugin.
-g, --global global config
-l, --local local config
-o, --[no-]open Open the default browser to complete the login
-v, --verbose Verbose output
--debug=<value> Debug level output
DESCRIPTION
Log in with a certain Adobe IMS context and returns the access token.
If the Adobe IMS context already has a valid access token set (valid meaning
at least 10 minutes before expiry), that token is returned.
Otherwise, if the Adobe IMS context has a valid refresh token set (valid
meaning at least 10 minutes before expiry) that refresh token is
exchanged for an access token before returning the access token.
Lastly, if the Adobe IMS context properties are supported by one of the
Adobe IMS login plugins, that login plugin is called to guide through
the IMS login process.
The currently supported Adobe IMS login plugins are:
* aio-lib-ims-jwt for JWT token based login supporting
Adobe I/O Console service integrations.
* aio-lib-ims-oauth for browser based OAuth2 login. This
plugin will launch the default browser to guide the user through the
login process. The plugin itself will *never* see the user's
password but only receive the authorization token after the
user has authenticated with Adobe IMS.
ALIASES
$ aio login
```
## `aio logout`
Log out the current or a named Adobe IMS context.
```
USAGE
$ aio logout [--debug <value>] [-v] [-l | -g] [-c <value>] [-f]
FLAGS
-c, --ctx=<value> Name of the Adobe IMS context to use. Default is the current Adobe IMS context
-f, --[no-]force Invalidate the refresh token as well as all access tokens.
Otherwise only the access token is invalidated. For Adobe IMS
contexts not supporting refresh tokens, this flag has no
effect.
-g, --global global config
-l, --local local config
-v, --verbose Verbose output
--debug=<value> Debug level output
DESCRIPTION
Log out the current or a named Adobe IMS context.
This command can be called multiple times on the same Adobe IMS context with
out causing any errors. The assumption is that after calling this command
without an error, the Adobe IMS context's access and refresh tokens have been
invalidated and removed from persistent storage. Repeatedly calling this
command will just do nothing.
ALIASES
$ aio logout
```
<!-- commandsstop -->

@@ -270,0 +442,0 @@ 

-312
oclif.manifest.json
{
"version": "4.0.1",
"commands": {
"auth:ctx": {
"id": "auth:ctx",
"description": "Manage Adobe IMS contexts.\n\nThe following options exist for this command:\n\n* List the names of the configured Adobe IMS contexts\n* Print the name of the current Adobe IMS context\n* Set the name of the current Adobe IMS context\n* Print the configuration of the current or a named Adobe IMS context\n\nCurrently it is not possible to update the Adobe Adobe IMS context configuration\nusing this command. Use the \"aio config\" commands for this.\n e.g. aio config:set ims.contexts.your_context.your_context_key \"your_context_value\"\n\nPlease note, that the following IMS context label names is reserved: `cli`\nand should not be used as an IMS context name.\n\nAlso note that the current context can only be set locally.\n",
"strict": true,
"pluginName": "@adobe/aio-cli-plugin-auth",
"pluginAlias": "@adobe/aio-cli-plugin-auth",
"pluginType": "core",
"aliases": [
"ctx",
"context"
],
"flags": {
"debug": {
"name": "debug",
"type": "option",
"description": "Debug level output",
"multiple": false
},
"verbose": {
"name": "verbose",
"type": "boolean",
"char": "v",
"description": "Verbose output",
"allowNo": false
},
"local": {
"name": "local",
"type": "boolean",
"char": "l",
"description": "local config",
"allowNo": false,
"exclusive": [
"global"
]
},
"global": {
"name": "global",
"type": "boolean",
"char": "g",
"description": "global config",
"allowNo": false,
"exclusive": [
"local"
]
},
"json": {
"name": "json",
"type": "boolean",
"char": "j",
"hidden": true,
"allowNo": false,
"exclusive": [
"yaml"
]
},
"yaml": {
"name": "yaml",
"type": "boolean",
"char": "y",
"hidden": true,
"allowNo": false,
"exclusive": [
"json"
]
},
"ctx": {
"name": "ctx",
"type": "option",
"char": "c",
"description": " Name of the Adobe IMS context to use. Default is the current Adobe IMS context",
"multiple": false
},
"list": {
"name": "list",
"type": "boolean",
"description": "Names of the Adobe IMS contexts as an array",
"allowNo": false,
"exclusive": [
"value",
"set",
"plugin"
]
},
"value": {
"name": "value",
"type": "boolean",
"description": "Prints named or current Adobe IMS context data",
"allowNo": false,
"exclusive": [
"list",
"set",
"plugin"
]
},
"set": {
"name": "set",
"type": "option",
"char": "s",
"description": "Sets the name of the current local Adobe IMS context",
"multiple": false,
"exclusive": [
"list",
"val",
"ctx",
"plugin"
]
}
},
"args": {}
},
"auth": {
"id": "auth",
"description": "Adobe IMS commands to login and logout.\n\nThe main commands are `auth login` to get or create an access token and\n`auth logout` to invalidate an access token and thus log out from Adobe IMS.\n\nLogging in and out is based on configuration of which there may be\nmultiple. Each set of configuration properties, called an Adobe IMS context,\ncan be individually addressed by a label.\n\nConfiguration for the Adobe IMS commands is stored in the \"ims\"\nconfiguration property. The special property \"ims.config.current\" contains the\nlabel of the current configuration which can be set using the\n\"aio auth ctx -s <label>\" command.\n\nEach set of properties in a labeled Adobe IMS context configurations has\nconfiguration properties depending on the kind of access that is\nsupported. The below example shows the configuration for OAuth2\nbased (graphical SUSI) login.\n\nThe \"env\" property is optional and designates the Adobe IMS environment\nused for authentication. Possible values are \"stage\" and \"prod\".\nIf the property is missing or any other value, it defaults to \"prod\".\n\nAll commands allow their normal output to be formatted in either\nHJSON (default), JSON, or YAML.\n",
"strict": true,
"pluginName": "@adobe/aio-cli-plugin-auth",
"pluginAlias": "@adobe/aio-cli-plugin-auth",
"pluginType": "core",
"aliases": [],
"examples": [
"{\n ims: {\n contexts: {\n postman: {\n env: \"stage\",\n callback_url: \"https://callback.example.com\",\n client_id: \"example.com-client-id\",\n client_secret: \"XXXXXXXX\",\n scope: \"openid AdobeID additional_info.projectedProductContext read_organizations\",\n state: \"\"\n }\n },\n config: {\n current: \"postman\"\n }\n }\n }\n "
],
"flags": {},
"args": {}
},
"auth:login": {
"id": "auth:login",
"description": "Log in with a certain Adobe IMS context and returns the access token.\n\nIf the Adobe IMS context already has a valid access token set (valid meaning\nat least 10 minutes before expiry), that token is returned.\n\nOtherwise, if the Adobe IMS context has a valid refresh token set (valid\nmeaning at least 10 minutes before expiry) that refresh token is\nexchanged for an access token before returning the access token.\n\nLastly, if the Adobe IMS context properties are supported by one of the\nAdobe IMS login plugins, that login plugin is called to guide through\nthe IMS login process.\n\nThe currently supported Adobe IMS login plugins are:\n\n* aio-lib-ims-jwt for JWT token based login supporting\n Adobe I/O Console service integrations.\n* aio-lib-ims-oauth for browser based OAuth2 login. This\n plugin will launch the default browser to guide the user through the\n login process. The plugin itself will *never* see the user's\n password but only receive the authorization token after the\n user has authenticated with Adobe IMS.\n",
"strict": true,
"pluginName": "@adobe/aio-cli-plugin-auth",
"pluginAlias": "@adobe/aio-cli-plugin-auth",
"pluginType": "core",
"aliases": [
"login"
],
"flags": {
"debug": {
"name": "debug",
"type": "option",
"description": "Debug level output",
"multiple": false
},
"verbose": {
"name": "verbose",
"type": "boolean",
"char": "v",
"description": "Verbose output",
"allowNo": false
},
"local": {
"name": "local",
"type": "boolean",
"char": "l",
"description": "local config",
"allowNo": false,
"exclusive": [
"global"
]
},
"global": {
"name": "global",
"type": "boolean",
"char": "g",
"description": "global config",
"allowNo": false,
"exclusive": [
"local"
]
},
"json": {
"name": "json",
"type": "boolean",
"char": "j",
"hidden": true,
"allowNo": false,
"exclusive": [
"yaml"
]
},
"yaml": {
"name": "yaml",
"type": "boolean",
"char": "y",
"hidden": true,
"allowNo": false,
"exclusive": [
"json"
]
},
"ctx": {
"name": "ctx",
"type": "option",
"char": "c",
"description": " Name of the Adobe IMS context to use. Default is the current Adobe IMS context",
"multiple": false
},
"force": {
"name": "force",
"type": "boolean",
"char": "f",
"description": "Force logging in. This causes a forced logout on the context first and makes sure to not use any cached data when calling the plugin.",
"allowNo": false
},
"decode": {
"name": "decode",
"type": "boolean",
"char": "d",
"description": "Decode and display access token data",
"allowNo": false
},
"bare": {
"name": "bare",
"type": "boolean",
"char": "b",
"description": "print access token only",
"allowNo": false
},
"open": {
"name": "open",
"type": "boolean",
"char": "o",
"description": "Open the default browser to complete the login",
"allowNo": true
}
},
"args": {}
},
"auth:logout": {
"id": "auth:logout",
"description": "Log out the current or a named Adobe IMS context.\n\nThis command can be called multiple times on the same Adobe IMS context with\nout causing any errors. The assumption is that after calling this command\nwithout an error, the Adobe IMS context's access and refresh tokens have been\ninvalidated and removed from persistent storage. Repeatedly calling this\ncommand will just do nothing.\n",
"strict": true,
"pluginName": "@adobe/aio-cli-plugin-auth",
"pluginAlias": "@adobe/aio-cli-plugin-auth",
"pluginType": "core",
"aliases": [
"logout"
],
"flags": {
"debug": {
"name": "debug",
"type": "option",
"description": "Debug level output",
"multiple": false
},
"verbose": {
"name": "verbose",
"type": "boolean",
"char": "v",
"description": "Verbose output",
"allowNo": false
},
"local": {
"name": "local",
"type": "boolean",
"char": "l",
"description": "local config",
"allowNo": false,
"exclusive": [
"global"
]
},
"global": {
"name": "global",
"type": "boolean",
"char": "g",
"description": "global config",
"allowNo": false,
"exclusive": [
"local"
]
},
"json": {
"name": "json",
"type": "boolean",
"char": "j",
"hidden": true,
"allowNo": false,
"exclusive": [
"yaml"
]
},
"yaml": {
"name": "yaml",
"type": "boolean",
"char": "y",
"hidden": true,
"allowNo": false,
"exclusive": [
"json"
]
},
"ctx": {
"name": "ctx",
"type": "option",
"char": "c",
"description": " Name of the Adobe IMS context to use. Default is the current Adobe IMS context",
"multiple": false
},
"force": {
"name": "force",
"type": "boolean",
"char": "f",
"description": "Invalidate the refresh token as well as all access tokens.\nOtherwise only the access token is invalidated. For Adobe IMS\ncontexts not supporting refresh tokens, this flag has no\neffect.",
"allowNo": true
}
},
"args": {}
}
}
}