@cumulus/launchpad-auth 21.1.0 → 21.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.nycrc.json +1 -1
- package/README.md +10 -10
- package/package.json +5 -5
- package/tsconfig.tsbuildinfo +1 -1
package/.nycrc.json
CHANGED
package/README.md
CHANGED
|
@@ -41,8 +41,8 @@ Utility functions for generating and validating Launchpad tokens
|
|
|
41
41
|
#### getLaunchpadToken(params) ⇒ <code>Promise.<string></code> ⏏
|
|
42
42
|
Get a Launchpad token
|
|
43
43
|
|
|
44
|
-
**Kind**: Exported function
|
|
45
|
-
**Returns**: <code>Promise.<string></code> - - the Launchpad token
|
|
44
|
+
**Kind**: Exported function
|
|
45
|
+
**Returns**: <code>Promise.<string></code> - - the Launchpad token
|
|
46
46
|
|
|
47
47
|
| Param | Type | Description |
|
|
48
48
|
| --- | --- | --- |
|
|
@@ -56,11 +56,11 @@ Get a Launchpad token
|
|
|
56
56
|
#### validateLaunchpadToken(params, token, [userGroup]) ⇒ <code>Promise.<ValidateTokenResult></code> ⏏
|
|
57
57
|
Validate a Launchpad token
|
|
58
58
|
|
|
59
|
-
**Kind**: Exported function
|
|
59
|
+
**Kind**: Exported function
|
|
60
60
|
**Returns**: <code>Promise.<ValidateTokenResult></code> - - the validate result object with
|
|
61
61
|
{ status: 'success or failed', message: 'reason for failure',
|
|
62
62
|
session_maxtimeout: number second, session_starttime: number millisecond,
|
|
63
|
-
owner_auid: string}
|
|
63
|
+
owner_auid: string}
|
|
64
64
|
|
|
65
65
|
| Param | Type | Description |
|
|
66
66
|
| --- | --- | --- |
|
|
@@ -76,7 +76,7 @@ owner_auid: string}
|
|
|
76
76
|
### LaunchpadToken
|
|
77
77
|
A class for sending requests to Launchpad token service endpoints
|
|
78
78
|
|
|
79
|
-
**Kind**: global class
|
|
79
|
+
**Kind**: global class
|
|
80
80
|
|
|
81
81
|
* [LaunchpadToken](#LaunchpadToken)
|
|
82
82
|
* [new LaunchpadToken(params)](#new_LaunchpadToken_new)
|
|
@@ -94,7 +94,7 @@ A class for sending requests to Launchpad token service endpoints
|
|
|
94
94
|
| params.passphrase | <code>string</code> | the passphrase of the Launchpad PKI certificate |
|
|
95
95
|
| params.certificate | <code>string</code> | the name of the Launchpad PKI pfx certificate |
|
|
96
96
|
|
|
97
|
-
**Example**
|
|
97
|
+
**Example**
|
|
98
98
|
```js
|
|
99
99
|
const LaunchpadToken = require('@cumulus/launchpad-auth/LaunchpadToken');
|
|
100
100
|
|
|
@@ -109,15 +109,15 @@ const launchpadToken = new LaunchpadToken({
|
|
|
109
109
|
#### launchpadToken.requestToken() ⇒ <code>Promise.<Object></code>
|
|
110
110
|
Get a token from Launchpad
|
|
111
111
|
|
|
112
|
-
**Kind**: instance method of [<code>LaunchpadToken</code>](#LaunchpadToken)
|
|
113
|
-
**Returns**: <code>Promise.<Object></code> - - the Launchpad gettoken response object
|
|
112
|
+
**Kind**: instance method of [<code>LaunchpadToken</code>](#LaunchpadToken)
|
|
113
|
+
**Returns**: <code>Promise.<Object></code> - - the Launchpad gettoken response object
|
|
114
114
|
<a name="LaunchpadToken+validateToken"></a>
|
|
115
115
|
|
|
116
116
|
#### launchpadToken.validateToken(token) ⇒ <code>Promise.<Object></code>
|
|
117
117
|
Validate a Launchpad token
|
|
118
118
|
|
|
119
|
-
**Kind**: instance method of [<code>LaunchpadToken</code>](#LaunchpadToken)
|
|
120
|
-
**Returns**: <code>Promise.<Object></code> - - the Launchpad validate token response object
|
|
119
|
+
**Kind**: instance method of [<code>LaunchpadToken</code>](#LaunchpadToken)
|
|
120
|
+
**Returns**: <code>Promise.<Object></code> - - the Launchpad validate token response object
|
|
121
121
|
|
|
122
122
|
| Param | Type | Description |
|
|
123
123
|
| --- | --- | --- |
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cumulus/launchpad-auth",
|
|
3
|
-
"version": "21.
|
|
3
|
+
"version": "21.3.0",
|
|
4
4
|
"description": "Utilities for authentication with Launchpad",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"CUMULUS",
|
|
7
7
|
"NASA"
|
|
8
8
|
],
|
|
9
9
|
"engines": {
|
|
10
|
-
"node": ">=
|
|
10
|
+
"node": ">=22.21.1"
|
|
11
11
|
},
|
|
12
12
|
"publishConfig": {
|
|
13
13
|
"access": "public"
|
|
@@ -40,11 +40,11 @@
|
|
|
40
40
|
"author": "Cumulus Authors",
|
|
41
41
|
"license": "Apache-2.0",
|
|
42
42
|
"dependencies": {
|
|
43
|
-
"@cumulus/aws-client": "21.
|
|
44
|
-
"@cumulus/logger": "21.
|
|
43
|
+
"@cumulus/aws-client": "21.3.0",
|
|
44
|
+
"@cumulus/logger": "21.3.0",
|
|
45
45
|
"got": "^11.8.5",
|
|
46
46
|
"lodash": "^4.17.21",
|
|
47
47
|
"uuid": "^3.2.1"
|
|
48
48
|
},
|
|
49
|
-
"gitHead": "
|
|
49
|
+
"gitHead": "9dd4a7d4b888ea713efa87d6086a762262d46dd2"
|
|
50
50
|
}
|