Skip to content

Commit b54b40c

Browse files
committed
3.0.1
1 parent 53656ab commit b54b40c

2 files changed

Lines changed: 197 additions & 2 deletions

File tree

README.md

Lines changed: 196 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ $ aio auth --help
7272
* [`aio auth ctx`](#aio-auth-ctx)
7373
* [`aio auth login`](#aio-auth-login)
7474
* [`aio auth logout`](#aio-auth-logout)
75+
* [`aio context`](#aio-context)
76+
* [`aio ctx`](#aio-ctx)
77+
* [`aio login`](#aio-login)
78+
* [`aio logout`](#aio-logout)
7579

7680
## `aio auth`
7781

@@ -140,7 +144,7 @@ EXAMPLES
140144
}
141145
```
142146

143-
_See code: [src/commands/auth/index.js](https://github.com/adobe/aio-cli-plugin-auth/blob/3.0.0/src/commands/auth/index.js)_
147+
_See code: [src/commands/auth/index.js](https://github.com/adobe/aio-cli-plugin-auth/blob/3.0.1/src/commands/auth/index.js)_
144148

145149
## `aio auth ctx`
146150

@@ -281,6 +285,197 @@ DESCRIPTION
281285
282286
command will just do nothing.
283287
288+
ALIASES
289+
$ aio logout
290+
```
291+
292+
## `aio context`
293+
294+
Manage Adobe IMS contexts.
295+
296+
```
297+
USAGE
298+
$ aio context [--debug <value>] [-v] [-l | -g] [-c <value>] [--list | --value | -s <value> | ]
299+
300+
FLAGS
301+
-c, --ctx=<value> Name of the Adobe IMS context to use. Default is the current Adobe IMS context
302+
-g, --global global config
303+
-l, --local local config
304+
-s, --set=<value> Sets the name of the current local Adobe IMS context
305+
-v, --verbose Verbose output
306+
--debug=<value> Debug level output
307+
--list Names of the Adobe IMS contexts as an array
308+
--value Prints named or current Adobe IMS context data
309+
310+
DESCRIPTION
311+
Manage Adobe IMS contexts.
312+
313+
The following options exist for this command:
314+
315+
* List the names of the configured Adobe IMS contexts
316+
317+
* Print the name of the current Adobe IMS context
318+
319+
* Set the name of the current Adobe IMS context
320+
321+
* Print the configuration of the current or a named Adobe IMS context
322+
323+
Currently it is not possible to update the Adobe Adobe IMS context configuration
324+
325+
using this command. Use the "aio config" commands for this.
326+
327+
e.g. aio config:set ims.contexts.your_context.your_context_key "your_context_value"
328+
329+
Please note, that the following IMS context label names is reserved: `cli`
330+
331+
and should not be used as an IMS context name.
332+
333+
Also note that the current context can only be set locally.
334+
335+
ALIASES
336+
$ aio ctx
337+
$ aio context
338+
```
339+
340+
## `aio ctx`
341+
342+
Manage Adobe IMS contexts.
343+
344+
```
345+
USAGE
346+
$ aio ctx [--debug <value>] [-v] [-l | -g] [-c <value>] [--list | --value | -s <value> | ]
347+
348+
FLAGS
349+
-c, --ctx=<value> Name of the Adobe IMS context to use. Default is the current Adobe IMS context
350+
-g, --global global config
351+
-l, --local local config
352+
-s, --set=<value> Sets the name of the current local Adobe IMS context
353+
-v, --verbose Verbose output
354+
--debug=<value> Debug level output
355+
--list Names of the Adobe IMS contexts as an array
356+
--value Prints named or current Adobe IMS context data
357+
358+
DESCRIPTION
359+
Manage Adobe IMS contexts.
360+
361+
The following options exist for this command:
362+
363+
* List the names of the configured Adobe IMS contexts
364+
365+
* Print the name of the current Adobe IMS context
366+
367+
* Set the name of the current Adobe IMS context
368+
369+
* Print the configuration of the current or a named Adobe IMS context
370+
371+
Currently it is not possible to update the Adobe Adobe IMS context configuration
372+
373+
using this command. Use the "aio config" commands for this.
374+
375+
e.g. aio config:set ims.contexts.your_context.your_context_key "your_context_value"
376+
377+
Please note, that the following IMS context label names is reserved: `cli`
378+
379+
and should not be used as an IMS context name.
380+
381+
Also note that the current context can only be set locally.
382+
383+
ALIASES
384+
$ aio ctx
385+
$ aio context
386+
```
387+
388+
## `aio login`
389+
390+
Log in with a certain Adobe IMS context and returns the access token.
391+
392+
```
393+
USAGE
394+
$ aio login [--debug <value>] [-v] [-l | -g] [-c <value>] [-f] [-d] [-b] [-o]
395+
396+
FLAGS
397+
-b, --bare print access token only
398+
-c, --ctx=<value> Name of the Adobe IMS context to use. Default is the current Adobe IMS context
399+
-d, --decode Decode and display access token data
400+
-f, --force Force logging in. This causes a forced logout on the context first and makes sure to not use any
401+
cached data when calling the plugin.
402+
-g, --global global config
403+
-l, --local local config
404+
-o, --[no-]open Open the default browser to complete the login
405+
-v, --verbose Verbose output
406+
--debug=<value> Debug level output
407+
408+
DESCRIPTION
409+
Log in with a certain Adobe IMS context and returns the access token.
410+
411+
If the Adobe IMS context already has a valid access token set (valid meaning
412+
413+
at least 10 minutes before expiry), that token is returned.
414+
415+
Otherwise, if the Adobe IMS context has a valid refresh token set (valid
416+
417+
meaning at least 10 minutes before expiry) that refresh token is
418+
419+
exchanged for an access token before returning the access token.
420+
421+
Lastly, if the Adobe IMS context properties are supported by one of the
422+
423+
Adobe IMS login plugins, that login plugin is called to guide through
424+
425+
the IMS login process.
426+
427+
The currently supported Adobe IMS login plugins are:
428+
429+
* aio-lib-ims-jwt for JWT token based login supporting
430+
431+
Adobe I/O Console service integrations.
432+
433+
* aio-lib-ims-oauth for browser based OAuth2 login. This
434+
435+
plugin will launch the default browser to guide the user through the
436+
437+
login process. The plugin itself will *never* see the user's
438+
439+
password but only receive the authorization token after the
440+
441+
user has authenticated with Adobe IMS.
442+
443+
ALIASES
444+
$ aio login
445+
```
446+
447+
## `aio logout`
448+
449+
Log out the current or a named Adobe IMS context.
450+
451+
```
452+
USAGE
453+
$ aio logout [--debug <value>] [-v] [-l | -g] [-c <value>] [-f]
454+
455+
FLAGS
456+
-c, --ctx=<value> Name of the Adobe IMS context to use. Default is the current Adobe IMS context
457+
-f, --force Invalidate the refresh token as well as all access tokens.
458+
Otherwise only the access token is invalidated. For Adobe IMS
459+
contexts not supporting refresh tokens, this flag has no
460+
effect.
461+
-g, --global global config
462+
-l, --local local config
463+
-v, --verbose Verbose output
464+
--debug=<value> Debug level output
465+
466+
DESCRIPTION
467+
Log out the current or a named Adobe IMS context.
468+
469+
This command can be called multiple times on the same Adobe IMS context with
470+
471+
out causing any errors. The assumption is that after calling this command
472+
473+
without an error, the Adobe IMS context's access and refresh tokens have been
474+
475+
invalidated and removed from persistent storage. Repeatedly calling this
476+
477+
command will just do nothing.
478+
284479
ALIASES
285480
$ aio logout
286481
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@adobe/aio-cli-plugin-auth",
33
"description": "The IMS plugin to aio supports managing tokens for IMS such as login, logout, and retrieving and using tokens.",
4-
"version": "3.0.0",
4+
"version": "3.0.1",
55
"author": "Adobe",
66
"bugs": "https://github.com/adobe/aio-cli-plugin-auth/issues",
77
"dependencies": {

0 commit comments

Comments
 (0)