diff options
| author | Kat Marchán <kzm@sykosomatic.org> | 2017-01-06 05:07:01 +0300 |
|---|---|---|
| committer | C J Silverio <ceejceej@gmail.com> | 2017-02-10 02:37:51 +0300 |
| commit | 77a0719d82c2b9cf18fe1b1a04ae332d5c006567 (patch) | |
| tree | 6a95da4368a2a4373586265aedcc9fa7a82df9d0 /doc | |
| parent | 483770d22ede2d121b24dcaaf8ce7bc9fbe1b885 (diff) | |
doc: document new auth options
PR-URL: https://github.com/npm/npm/pull/13389
Credit: @zkat
Reviewed-By: @iarna
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cli/npm-adduser.md | 11 | ||||
| -rw-r--r-- | doc/misc/npm-config.md | 22 |
2 files changed, 32 insertions, 1 deletions
diff --git a/doc/cli/npm-adduser.md b/doc/cli/npm-adduser.md index 5a53bdd8e..72433e00f 100644 --- a/doc/cli/npm-adduser.md +++ b/doc/cli/npm-adduser.md @@ -3,7 +3,7 @@ npm-adduser(1) -- Add a registry user account ## SYNOPSIS - npm adduser [--registry=url] [--scope=@orgname] [--always-auth] + npm adduser [--registry=url] [--scope=@orgname] [--always-auth] [--auth-type=legacy] aliases: login, add-user @@ -66,6 +66,15 @@ different hostnames. See `always-auth` in `npm-config(7)` for more details on always-auth. Registry-specific configuration of `always-auth` takes precedence over any global configuration. +### auth-type + +* Default: `'legacy'` +* Type: `'legacy'`, `'sso'`, `'saml'`, `'oauth'` + +What authentication strategy to use with `adduser`/`login`. Some npm registries +(for example, npmE) might support alternative auth strategies besides classic +username/password entry in legacy npm. + ## SEE ALSO * npm-registry(7) diff --git a/doc/misc/npm-config.md b/doc/misc/npm-config.md index cafbedf53..093039411 100644 --- a/doc/misc/npm-config.md +++ b/doc/misc/npm-config.md @@ -137,6 +137,13 @@ even for `GET` requests. When "dev" or "development" and running local `npm shrinkwrap`, `npm outdated`, or `npm update`, is an alias for `--dev`. +### auth-type + +* Default: `'legacy'` +* Type: `'legacy'`, `'sso'`, `'saml'`, `'oauth'` + +What authentication strategy to use with `adduser`/`login`. + ### bin-links * Default: `true` @@ -904,6 +911,21 @@ using `-s` to add a signature. Note that git requires you to have set up GPG keys in your git configs for this to work properly. +### sso-poll-frequency + +* Default: 500 +* Type: Number + +When used with SSO-enabled `auth-type`s, configures how regularly the registry +should be polled while the user is completing authentication. + +### sso-type + +* Default: 'oauth' +* Type: 'oauth', 'saml', or null + +If `--auth-type=sso`, the type of SSO type to use. + ### strict-ssl * Default: true |