ibm-cloud-sdk-core 4.1.5 → 4.2.1
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/.secrets.baseline +57 -9
- package/Authentication.md +73 -0
- package/CHANGELOG.md +14 -0
- package/auth/authenticators/authenticator.d.ts +2 -1
- package/auth/authenticators/authenticator.js +1 -0
- package/auth/authenticators/index.d.ts +2 -0
- package/auth/authenticators/index.js +3 -1
- package/auth/authenticators/mcsp-authenticator.d.ts +57 -0
- package/auth/authenticators/mcsp-authenticator.js +82 -0
- package/auth/token-managers/index.d.ts +5 -2
- package/auth/token-managers/index.js +7 -3
- package/auth/token-managers/mcsp-token-manager.d.ts +59 -0
- package/auth/token-managers/mcsp-token-manager.js +94 -0
- package/auth/utils/get-authenticator-from-environment.js +3 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_mcsp.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.md +1 -0
- package/build/docs/ibm-cloud-sdk-core.mcspauthenticator._constructor_.md +24 -0
- package/build/docs/ibm-cloud-sdk-core.mcspauthenticator.authenticationtype.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.mcspauthenticator.md +34 -0
- package/build/docs/ibm-cloud-sdk-core.mcspauthenticator.requiredoptions.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.mcspauthenticator.tokenmanager.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.mcsptokenmanager._constructor_.md +24 -0
- package/build/docs/ibm-cloud-sdk-core.mcsptokenmanager.md +35 -0
- package/build/docs/ibm-cloud-sdk-core.mcsptokenmanager.requesttoken.md +15 -0
- package/build/docs/ibm-cloud-sdk-core.mcsptokenmanager.requiredoptions.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.md +2 -0
- package/docs/ibm-cloud-sdk-core.api.json +319 -1
- package/es/auth/authenticators/authenticator.d.ts +2 -1
- package/es/auth/authenticators/authenticator.js +1 -0
- package/es/auth/authenticators/index.d.ts +2 -0
- package/es/auth/authenticators/index.js +1 -0
- package/es/auth/authenticators/mcsp-authenticator.d.ts +57 -0
- package/es/auth/authenticators/mcsp-authenticator.js +60 -0
- package/es/auth/token-managers/index.d.ts +5 -2
- package/es/auth/token-managers/index.js +5 -2
- package/es/auth/token-managers/mcsp-token-manager.d.ts +59 -0
- package/es/auth/token-managers/mcsp-token-manager.js +69 -0
- package/es/auth/utils/get-authenticator-from-environment.js +4 -1
- package/es/tsdoc-metadata.json +1 -1
- package/etc/ibm-cloud-sdk-core.api.md +23 -0
- package/ibm-cloud-sdk-core.d.ts +79 -0
- package/package.json +2 -2
- package/temp/ibm-cloud-sdk-core.api.json +319 -1
- package/temp/ibm-cloud-sdk-core.api.md +23 -0
|
@@ -87,6 +87,9 @@ function getAuthenticatorFromEnvironment(serviceName) {
|
|
|
87
87
|
else if (authType === authenticators_1.Authenticator.AUTHTYPE_VPC.toLowerCase()) {
|
|
88
88
|
authenticator = new authenticators_1.VpcInstanceAuthenticator(credentials);
|
|
89
89
|
}
|
|
90
|
+
else if (authType === authenticators_1.Authenticator.AUTHTYPE_MCSP.toLowerCase()) {
|
|
91
|
+
authenticator = new authenticators_1.McspAuthenticator(credentials);
|
|
92
|
+
}
|
|
90
93
|
else {
|
|
91
94
|
throw new Error("Invalid value for AUTH_TYPE: ".concat(authType));
|
|
92
95
|
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [Authenticator](./ibm-cloud-sdk-core.authenticator.md) > [AUTHTYPE\_MCSP](./ibm-cloud-sdk-core.authenticator.authtype_mcsp.md)
|
|
4
|
+
|
|
5
|
+
## Authenticator.AUTHTYPE\_MCSP property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
static AUTHTYPE_MCSP: string;
|
|
11
|
+
```
|
|
@@ -28,6 +28,7 @@ export declare class Authenticator implements AuthenticatorInterface
|
|
|
28
28
|
| [AUTHTYPE\_CONTAINER](./ibm-cloud-sdk-core.authenticator.authtype_container.md) | <code>static</code> | string | |
|
|
29
29
|
| [AUTHTYPE\_CP4D](./ibm-cloud-sdk-core.authenticator.authtype_cp4d.md) | <code>static</code> | string | |
|
|
30
30
|
| [AUTHTYPE\_IAM](./ibm-cloud-sdk-core.authenticator.authtype_iam.md) | <code>static</code> | string | |
|
|
31
|
+
| [AUTHTYPE\_MCSP](./ibm-cloud-sdk-core.authenticator.authtype_mcsp.md) | <code>static</code> | string | |
|
|
31
32
|
| [AUTHTYPE\_NOAUTH](./ibm-cloud-sdk-core.authenticator.authtype_noauth.md) | <code>static</code> | string | |
|
|
32
33
|
| [AUTHTYPE\_UNKNOWN](./ibm-cloud-sdk-core.authenticator.authtype_unknown.md) | <code>static</code> | string | |
|
|
33
34
|
| [AUTHTYPE\_VPC](./ibm-cloud-sdk-core.authenticator.authtype_vpc.md) | <code>static</code> | string | |
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [McspAuthenticator](./ibm-cloud-sdk-core.mcspauthenticator.md) > [(constructor)](./ibm-cloud-sdk-core.mcspauthenticator._constructor_.md)
|
|
4
|
+
|
|
5
|
+
## McspAuthenticator.(constructor)
|
|
6
|
+
|
|
7
|
+
Create a new McspAuthenticator instance.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
constructor(options: Options);
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| options | Options | Configuration options for CloudPakForData authentication. This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service |
|
|
20
|
+
|
|
21
|
+
## Exceptions
|
|
22
|
+
|
|
23
|
+
Error: the username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.
|
|
24
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [McspAuthenticator](./ibm-cloud-sdk-core.mcspauthenticator.md) > [authenticationType](./ibm-cloud-sdk-core.mcspauthenticator.authenticationtype.md)
|
|
4
|
+
|
|
5
|
+
## McspAuthenticator.authenticationType() method
|
|
6
|
+
|
|
7
|
+
Returns the authenticator's type ('cp4d').
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
authenticationType(): string;
|
|
13
|
+
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
string
|
|
17
|
+
|
|
18
|
+
a string that indicates the authenticator's type
|
|
19
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [McspAuthenticator](./ibm-cloud-sdk-core.mcspauthenticator.md)
|
|
4
|
+
|
|
5
|
+
## McspAuthenticator class
|
|
6
|
+
|
|
7
|
+
The McspAuthenticator uses an apikey to obtain an access token from the MCSP token server. When the access token expires, a new access token is obtained from the token server. The access token will be added to outbound requests via the Authorization header of the form: "Authorization: Bearer <access-token>"
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare class McspAuthenticator extends TokenRequestBasedAuthenticator
|
|
13
|
+
```
|
|
14
|
+
**Extends:** [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
|
|
15
|
+
|
|
16
|
+
## Constructors
|
|
17
|
+
|
|
18
|
+
| Constructor | Modifiers | Description |
|
|
19
|
+
| --- | --- | --- |
|
|
20
|
+
| [(constructor)(options)](./ibm-cloud-sdk-core.mcspauthenticator._constructor_.md) | | Create a new McspAuthenticator instance. |
|
|
21
|
+
|
|
22
|
+
## Properties
|
|
23
|
+
|
|
24
|
+
| Property | Modifiers | Type | Description |
|
|
25
|
+
| --- | --- | --- | --- |
|
|
26
|
+
| [requiredOptions](./ibm-cloud-sdk-core.mcspauthenticator.requiredoptions.md) | <code>protected</code> | string\[\] | |
|
|
27
|
+
| [tokenManager](./ibm-cloud-sdk-core.mcspauthenticator.tokenmanager.md) | <code>protected</code> | [McspTokenManager](./ibm-cloud-sdk-core.mcsptokenmanager.md) | |
|
|
28
|
+
|
|
29
|
+
## Methods
|
|
30
|
+
|
|
31
|
+
| Method | Modifiers | Description |
|
|
32
|
+
| --- | --- | --- |
|
|
33
|
+
| [authenticationType()](./ibm-cloud-sdk-core.mcspauthenticator.authenticationtype.md) | | Returns the authenticator's type ('cp4d'). |
|
|
34
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [McspAuthenticator](./ibm-cloud-sdk-core.mcspauthenticator.md) > [requiredOptions](./ibm-cloud-sdk-core.mcspauthenticator.requiredoptions.md)
|
|
4
|
+
|
|
5
|
+
## McspAuthenticator.requiredOptions property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
protected requiredOptions: string[];
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [McspAuthenticator](./ibm-cloud-sdk-core.mcspauthenticator.md) > [tokenManager](./ibm-cloud-sdk-core.mcspauthenticator.tokenmanager.md)
|
|
4
|
+
|
|
5
|
+
## McspAuthenticator.tokenManager property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
protected tokenManager: McspTokenManager;
|
|
11
|
+
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [McspTokenManager](./ibm-cloud-sdk-core.mcsptokenmanager.md) > [(constructor)](./ibm-cloud-sdk-core.mcsptokenmanager._constructor_.md)
|
|
4
|
+
|
|
5
|
+
## McspTokenManager.(constructor)
|
|
6
|
+
|
|
7
|
+
Create a new McspTokenManager instance.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
constructor(options: Options);
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| options | Options | Configuration options This should be an object containing these fields: - url: (required) the base endpoint URL for the MCSP token service - apikey: (required) the API key used to obtain the MCSP access token. - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service |
|
|
20
|
+
|
|
21
|
+
## Exceptions
|
|
22
|
+
|
|
23
|
+
Error: the configuration options were invalid.
|
|
24
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [McspTokenManager](./ibm-cloud-sdk-core.mcsptokenmanager.md)
|
|
4
|
+
|
|
5
|
+
## McspTokenManager class
|
|
6
|
+
|
|
7
|
+
Token Manager for Multi-Cloud Saas Platform (MCSP) authenticator.
|
|
8
|
+
|
|
9
|
+
The Token Manager will invoke the MCSP token service's 'POST /siusermgr/api/1.0/apikeys/token' operation to obtain an MCSP access token for a user-supplied apikey.
|
|
10
|
+
|
|
11
|
+
**Signature:**
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
export declare class McspTokenManager extends JwtTokenManager
|
|
15
|
+
```
|
|
16
|
+
**Extends:** [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
|
|
17
|
+
|
|
18
|
+
## Constructors
|
|
19
|
+
|
|
20
|
+
| Constructor | Modifiers | Description |
|
|
21
|
+
| --- | --- | --- |
|
|
22
|
+
| [(constructor)(options)](./ibm-cloud-sdk-core.mcsptokenmanager._constructor_.md) | | Create a new McspTokenManager instance. |
|
|
23
|
+
|
|
24
|
+
## Properties
|
|
25
|
+
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [requiredOptions](./ibm-cloud-sdk-core.mcsptokenmanager.requiredoptions.md) | <code>protected</code> | string\[\] | |
|
|
29
|
+
|
|
30
|
+
## Methods
|
|
31
|
+
|
|
32
|
+
| Method | Modifiers | Description |
|
|
33
|
+
| --- | --- | --- |
|
|
34
|
+
| [requestToken()](./ibm-cloud-sdk-core.mcsptokenmanager.requesttoken.md) | <code>protected</code> | |
|
|
35
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [McspTokenManager](./ibm-cloud-sdk-core.mcsptokenmanager.md) > [requestToken](./ibm-cloud-sdk-core.mcsptokenmanager.requesttoken.md)
|
|
4
|
+
|
|
5
|
+
## McspTokenManager.requestToken() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
protected requestToken(): Promise<any>;
|
|
11
|
+
```
|
|
12
|
+
**Returns:**
|
|
13
|
+
|
|
14
|
+
Promise<any>
|
|
15
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [McspTokenManager](./ibm-cloud-sdk-core.mcsptokenmanager.md) > [requiredOptions](./ibm-cloud-sdk-core.mcsptokenmanager.requiredoptions.md)
|
|
4
|
+
|
|
5
|
+
## McspTokenManager.requiredOptions property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
protected requiredOptions: string[];
|
|
11
|
+
```
|
|
@@ -21,6 +21,8 @@
|
|
|
21
21
|
| [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) | The IamRequestBasedTokenManager class contains code relevant to any token manager that interacts with the IAM service to manage a token. It stores information relevant to all IAM requests, such as the client ID and secret, and performs the token request with a set of request options common to any IAM token management scheme. It is intended that this class be extended with specific implementations. |
|
|
22
22
|
| [IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.md) | The IAMTokenManager takes an api key and performs the necessary interactions with the IAM token service to obtain and store a suitable bearer token. Additionally, the IAMTokenManager will retrieve bearer tokens via basic auth using a supplied "clientId" and "clientSecret" pair. |
|
|
23
23
|
| [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) | A class for shared functionality for parsing, storing, and requesting JWT tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement <code>requestToken()</code> to retrieve the bearer token from intended sources. |
|
|
24
|
+
| [McspAuthenticator](./ibm-cloud-sdk-core.mcspauthenticator.md) | The McspAuthenticator uses an apikey to obtain an access token from the MCSP token server. When the access token expires, a new access token is obtained from the token server. The access token will be added to outbound requests via the Authorization header of the form: "Authorization: Bearer <access-token>" |
|
|
25
|
+
| [McspTokenManager](./ibm-cloud-sdk-core.mcsptokenmanager.md) | <p>Token Manager for Multi-Cloud Saas Platform (MCSP) authenticator.</p><p>The Token Manager will invoke the MCSP token service's 'POST /siusermgr/api/1.0/apikeys/token' operation to obtain an MCSP access token for a user-supplied apikey.</p> |
|
|
24
26
|
| [NoAuthAuthenticator](./ibm-cloud-sdk-core.noauthauthenticator.md) | NoAuthAuthenticator is a placeholder authenticator implementation which performs no authentication of outgoing REST API requests. It might be useful during development and testing. |
|
|
25
27
|
| [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) | A class for shared functionality for storing, and requesting tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement "requestToken()" to retrieve the token from intended sources and "saveTokenInfo(tokenResponse)" to parse and save token information from the response. |
|
|
26
28
|
| [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) | <p>Class for common functionality shared by token-request authenticators. TokenRequestBasedAuthenticators use token managers to retrieve, store, and refresh tokens. Not intended to be used as stand-alone authenticator, but as base class to authenticators that have their own token manager implementations.</p><p>The token will be added as an Authorization header in the form:</p><p>Authorization: Bearer <<!-- -->bearer-token<!-- -->></p> |
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"metadata": {
|
|
3
3
|
"toolPackage": "@microsoft/api-extractor",
|
|
4
|
-
"toolVersion": "7.
|
|
4
|
+
"toolVersion": "7.39.0",
|
|
5
5
|
"schemaVersion": 1011,
|
|
6
6
|
"oldestForwardsCompatibleVersion": 1001,
|
|
7
7
|
"tsdocConfig": {
|
|
@@ -569,6 +569,36 @@
|
|
|
569
569
|
"isProtected": false,
|
|
570
570
|
"isAbstract": false
|
|
571
571
|
},
|
|
572
|
+
{
|
|
573
|
+
"kind": "Property",
|
|
574
|
+
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_MCSP:member",
|
|
575
|
+
"docComment": "",
|
|
576
|
+
"excerptTokens": [
|
|
577
|
+
{
|
|
578
|
+
"kind": "Content",
|
|
579
|
+
"text": "static AUTHTYPE_MCSP: "
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
"kind": "Content",
|
|
583
|
+
"text": "string"
|
|
584
|
+
},
|
|
585
|
+
{
|
|
586
|
+
"kind": "Content",
|
|
587
|
+
"text": ";"
|
|
588
|
+
}
|
|
589
|
+
],
|
|
590
|
+
"isReadonly": false,
|
|
591
|
+
"isOptional": false,
|
|
592
|
+
"releaseTag": "Public",
|
|
593
|
+
"name": "AUTHTYPE_MCSP",
|
|
594
|
+
"propertyTypeTokenRange": {
|
|
595
|
+
"startIndex": 1,
|
|
596
|
+
"endIndex": 2
|
|
597
|
+
},
|
|
598
|
+
"isStatic": true,
|
|
599
|
+
"isProtected": false,
|
|
600
|
+
"isAbstract": false
|
|
601
|
+
},
|
|
572
602
|
{
|
|
573
603
|
"kind": "Property",
|
|
574
604
|
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_NOAUTH:member",
|
|
@@ -5415,6 +5445,294 @@
|
|
|
5415
5445
|
"endIndex": 2
|
|
5416
5446
|
}
|
|
5417
5447
|
},
|
|
5448
|
+
{
|
|
5449
|
+
"kind": "Class",
|
|
5450
|
+
"canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator:class",
|
|
5451
|
+
"docComment": "/**\n * The McspAuthenticator uses an apikey to obtain an access token from the MCSP token server. When the access token expires, a new access token is obtained from the token server. The access token will be added to outbound requests via the Authorization header of the form: \"Authorization: Bearer <access-token>\"\n */\n",
|
|
5452
|
+
"excerptTokens": [
|
|
5453
|
+
{
|
|
5454
|
+
"kind": "Content",
|
|
5455
|
+
"text": "export declare class McspAuthenticator extends "
|
|
5456
|
+
},
|
|
5457
|
+
{
|
|
5458
|
+
"kind": "Reference",
|
|
5459
|
+
"text": "TokenRequestBasedAuthenticator",
|
|
5460
|
+
"canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator:class"
|
|
5461
|
+
},
|
|
5462
|
+
{
|
|
5463
|
+
"kind": "Content",
|
|
5464
|
+
"text": " "
|
|
5465
|
+
}
|
|
5466
|
+
],
|
|
5467
|
+
"fileUrlPath": "dist/es/auth/authenticators/mcsp-authenticator.d.ts",
|
|
5468
|
+
"releaseTag": "Public",
|
|
5469
|
+
"isAbstract": false,
|
|
5470
|
+
"name": "McspAuthenticator",
|
|
5471
|
+
"preserveMemberOrder": false,
|
|
5472
|
+
"members": [
|
|
5473
|
+
{
|
|
5474
|
+
"kind": "Constructor",
|
|
5475
|
+
"canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator:constructor(1)",
|
|
5476
|
+
"docComment": "/**\n * Create a new McspAuthenticator instance.\n *\n * @param options - Configuration options for CloudPakForData authentication. This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service\n *\n * @throws\n *\n * Error: the username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.\n */\n",
|
|
5477
|
+
"excerptTokens": [
|
|
5478
|
+
{
|
|
5479
|
+
"kind": "Content",
|
|
5480
|
+
"text": "constructor(options: "
|
|
5481
|
+
},
|
|
5482
|
+
{
|
|
5483
|
+
"kind": "Reference",
|
|
5484
|
+
"text": "Options",
|
|
5485
|
+
"canonicalReference": "ibm-cloud-sdk-core!~Options_12:interface"
|
|
5486
|
+
},
|
|
5487
|
+
{
|
|
5488
|
+
"kind": "Content",
|
|
5489
|
+
"text": ");"
|
|
5490
|
+
}
|
|
5491
|
+
],
|
|
5492
|
+
"releaseTag": "Public",
|
|
5493
|
+
"isProtected": false,
|
|
5494
|
+
"overloadIndex": 1,
|
|
5495
|
+
"parameters": [
|
|
5496
|
+
{
|
|
5497
|
+
"parameterName": "options",
|
|
5498
|
+
"parameterTypeTokenRange": {
|
|
5499
|
+
"startIndex": 1,
|
|
5500
|
+
"endIndex": 2
|
|
5501
|
+
},
|
|
5502
|
+
"isOptional": false
|
|
5503
|
+
}
|
|
5504
|
+
]
|
|
5505
|
+
},
|
|
5506
|
+
{
|
|
5507
|
+
"kind": "Method",
|
|
5508
|
+
"canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator#authenticationType:member(1)",
|
|
5509
|
+
"docComment": "/**\n * Returns the authenticator's type ('cp4d').\n *\n * @returns a string that indicates the authenticator's type\n */\n",
|
|
5510
|
+
"excerptTokens": [
|
|
5511
|
+
{
|
|
5512
|
+
"kind": "Content",
|
|
5513
|
+
"text": "authenticationType(): "
|
|
5514
|
+
},
|
|
5515
|
+
{
|
|
5516
|
+
"kind": "Content",
|
|
5517
|
+
"text": "string"
|
|
5518
|
+
},
|
|
5519
|
+
{
|
|
5520
|
+
"kind": "Content",
|
|
5521
|
+
"text": ";"
|
|
5522
|
+
}
|
|
5523
|
+
],
|
|
5524
|
+
"isStatic": false,
|
|
5525
|
+
"returnTypeTokenRange": {
|
|
5526
|
+
"startIndex": 1,
|
|
5527
|
+
"endIndex": 2
|
|
5528
|
+
},
|
|
5529
|
+
"releaseTag": "Public",
|
|
5530
|
+
"isProtected": false,
|
|
5531
|
+
"overloadIndex": 1,
|
|
5532
|
+
"parameters": [],
|
|
5533
|
+
"isOptional": false,
|
|
5534
|
+
"isAbstract": false,
|
|
5535
|
+
"name": "authenticationType"
|
|
5536
|
+
},
|
|
5537
|
+
{
|
|
5538
|
+
"kind": "Property",
|
|
5539
|
+
"canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator#requiredOptions:member",
|
|
5540
|
+
"docComment": "",
|
|
5541
|
+
"excerptTokens": [
|
|
5542
|
+
{
|
|
5543
|
+
"kind": "Content",
|
|
5544
|
+
"text": "protected requiredOptions: "
|
|
5545
|
+
},
|
|
5546
|
+
{
|
|
5547
|
+
"kind": "Content",
|
|
5548
|
+
"text": "string[]"
|
|
5549
|
+
},
|
|
5550
|
+
{
|
|
5551
|
+
"kind": "Content",
|
|
5552
|
+
"text": ";"
|
|
5553
|
+
}
|
|
5554
|
+
],
|
|
5555
|
+
"isReadonly": false,
|
|
5556
|
+
"isOptional": false,
|
|
5557
|
+
"releaseTag": "Public",
|
|
5558
|
+
"name": "requiredOptions",
|
|
5559
|
+
"propertyTypeTokenRange": {
|
|
5560
|
+
"startIndex": 1,
|
|
5561
|
+
"endIndex": 2
|
|
5562
|
+
},
|
|
5563
|
+
"isStatic": false,
|
|
5564
|
+
"isProtected": true,
|
|
5565
|
+
"isAbstract": false
|
|
5566
|
+
},
|
|
5567
|
+
{
|
|
5568
|
+
"kind": "Property",
|
|
5569
|
+
"canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator#tokenManager:member",
|
|
5570
|
+
"docComment": "",
|
|
5571
|
+
"excerptTokens": [
|
|
5572
|
+
{
|
|
5573
|
+
"kind": "Content",
|
|
5574
|
+
"text": "protected tokenManager: "
|
|
5575
|
+
},
|
|
5576
|
+
{
|
|
5577
|
+
"kind": "Reference",
|
|
5578
|
+
"text": "McspTokenManager",
|
|
5579
|
+
"canonicalReference": "ibm-cloud-sdk-core!McspTokenManager:class"
|
|
5580
|
+
},
|
|
5581
|
+
{
|
|
5582
|
+
"kind": "Content",
|
|
5583
|
+
"text": ";"
|
|
5584
|
+
}
|
|
5585
|
+
],
|
|
5586
|
+
"isReadonly": false,
|
|
5587
|
+
"isOptional": false,
|
|
5588
|
+
"releaseTag": "Public",
|
|
5589
|
+
"name": "tokenManager",
|
|
5590
|
+
"propertyTypeTokenRange": {
|
|
5591
|
+
"startIndex": 1,
|
|
5592
|
+
"endIndex": 2
|
|
5593
|
+
},
|
|
5594
|
+
"isStatic": false,
|
|
5595
|
+
"isProtected": true,
|
|
5596
|
+
"isAbstract": false
|
|
5597
|
+
}
|
|
5598
|
+
],
|
|
5599
|
+
"extendsTokenRange": {
|
|
5600
|
+
"startIndex": 1,
|
|
5601
|
+
"endIndex": 2
|
|
5602
|
+
},
|
|
5603
|
+
"implementsTokenRanges": []
|
|
5604
|
+
},
|
|
5605
|
+
{
|
|
5606
|
+
"kind": "Class",
|
|
5607
|
+
"canonicalReference": "ibm-cloud-sdk-core!McspTokenManager:class",
|
|
5608
|
+
"docComment": "/**\n * Token Manager for Multi-Cloud Saas Platform (MCSP) authenticator.\n *\n * The Token Manager will invoke the MCSP token service's 'POST /siusermgr/api/1.0/apikeys/token' operation to obtain an MCSP access token for a user-supplied apikey.\n */\n",
|
|
5609
|
+
"excerptTokens": [
|
|
5610
|
+
{
|
|
5611
|
+
"kind": "Content",
|
|
5612
|
+
"text": "export declare class McspTokenManager extends "
|
|
5613
|
+
},
|
|
5614
|
+
{
|
|
5615
|
+
"kind": "Reference",
|
|
5616
|
+
"text": "JwtTokenManager",
|
|
5617
|
+
"canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager:class"
|
|
5618
|
+
},
|
|
5619
|
+
{
|
|
5620
|
+
"kind": "Content",
|
|
5621
|
+
"text": " "
|
|
5622
|
+
}
|
|
5623
|
+
],
|
|
5624
|
+
"fileUrlPath": "dist/es/auth/token-managers/mcsp-token-manager.d.ts",
|
|
5625
|
+
"releaseTag": "Public",
|
|
5626
|
+
"isAbstract": false,
|
|
5627
|
+
"name": "McspTokenManager",
|
|
5628
|
+
"preserveMemberOrder": false,
|
|
5629
|
+
"members": [
|
|
5630
|
+
{
|
|
5631
|
+
"kind": "Constructor",
|
|
5632
|
+
"canonicalReference": "ibm-cloud-sdk-core!McspTokenManager:constructor(1)",
|
|
5633
|
+
"docComment": "/**\n * Create a new McspTokenManager instance.\n *\n * @param options - Configuration options This should be an object containing these fields: - url: (required) the base endpoint URL for the MCSP token service - apikey: (required) the API key used to obtain the MCSP access token. - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service\n *\n * @throws\n *\n * Error: the configuration options were invalid.\n */\n",
|
|
5634
|
+
"excerptTokens": [
|
|
5635
|
+
{
|
|
5636
|
+
"kind": "Content",
|
|
5637
|
+
"text": "constructor(options: "
|
|
5638
|
+
},
|
|
5639
|
+
{
|
|
5640
|
+
"kind": "Reference",
|
|
5641
|
+
"text": "Options",
|
|
5642
|
+
"canonicalReference": "ibm-cloud-sdk-core!~Options_11:interface"
|
|
5643
|
+
},
|
|
5644
|
+
{
|
|
5645
|
+
"kind": "Content",
|
|
5646
|
+
"text": ");"
|
|
5647
|
+
}
|
|
5648
|
+
],
|
|
5649
|
+
"releaseTag": "Public",
|
|
5650
|
+
"isProtected": false,
|
|
5651
|
+
"overloadIndex": 1,
|
|
5652
|
+
"parameters": [
|
|
5653
|
+
{
|
|
5654
|
+
"parameterName": "options",
|
|
5655
|
+
"parameterTypeTokenRange": {
|
|
5656
|
+
"startIndex": 1,
|
|
5657
|
+
"endIndex": 2
|
|
5658
|
+
},
|
|
5659
|
+
"isOptional": false
|
|
5660
|
+
}
|
|
5661
|
+
]
|
|
5662
|
+
},
|
|
5663
|
+
{
|
|
5664
|
+
"kind": "Method",
|
|
5665
|
+
"canonicalReference": "ibm-cloud-sdk-core!McspTokenManager#requestToken:member(1)",
|
|
5666
|
+
"docComment": "",
|
|
5667
|
+
"excerptTokens": [
|
|
5668
|
+
{
|
|
5669
|
+
"kind": "Content",
|
|
5670
|
+
"text": "protected requestToken(): "
|
|
5671
|
+
},
|
|
5672
|
+
{
|
|
5673
|
+
"kind": "Reference",
|
|
5674
|
+
"text": "Promise",
|
|
5675
|
+
"canonicalReference": "!Promise:interface"
|
|
5676
|
+
},
|
|
5677
|
+
{
|
|
5678
|
+
"kind": "Content",
|
|
5679
|
+
"text": "<any>"
|
|
5680
|
+
},
|
|
5681
|
+
{
|
|
5682
|
+
"kind": "Content",
|
|
5683
|
+
"text": ";"
|
|
5684
|
+
}
|
|
5685
|
+
],
|
|
5686
|
+
"isStatic": false,
|
|
5687
|
+
"returnTypeTokenRange": {
|
|
5688
|
+
"startIndex": 1,
|
|
5689
|
+
"endIndex": 3
|
|
5690
|
+
},
|
|
5691
|
+
"releaseTag": "Public",
|
|
5692
|
+
"isProtected": true,
|
|
5693
|
+
"overloadIndex": 1,
|
|
5694
|
+
"parameters": [],
|
|
5695
|
+
"isOptional": false,
|
|
5696
|
+
"isAbstract": false,
|
|
5697
|
+
"name": "requestToken"
|
|
5698
|
+
},
|
|
5699
|
+
{
|
|
5700
|
+
"kind": "Property",
|
|
5701
|
+
"canonicalReference": "ibm-cloud-sdk-core!McspTokenManager#requiredOptions:member",
|
|
5702
|
+
"docComment": "",
|
|
5703
|
+
"excerptTokens": [
|
|
5704
|
+
{
|
|
5705
|
+
"kind": "Content",
|
|
5706
|
+
"text": "protected requiredOptions: "
|
|
5707
|
+
},
|
|
5708
|
+
{
|
|
5709
|
+
"kind": "Content",
|
|
5710
|
+
"text": "string[]"
|
|
5711
|
+
},
|
|
5712
|
+
{
|
|
5713
|
+
"kind": "Content",
|
|
5714
|
+
"text": ";"
|
|
5715
|
+
}
|
|
5716
|
+
],
|
|
5717
|
+
"isReadonly": false,
|
|
5718
|
+
"isOptional": false,
|
|
5719
|
+
"releaseTag": "Public",
|
|
5720
|
+
"name": "requiredOptions",
|
|
5721
|
+
"propertyTypeTokenRange": {
|
|
5722
|
+
"startIndex": 1,
|
|
5723
|
+
"endIndex": 2
|
|
5724
|
+
},
|
|
5725
|
+
"isStatic": false,
|
|
5726
|
+
"isProtected": true,
|
|
5727
|
+
"isAbstract": false
|
|
5728
|
+
}
|
|
5729
|
+
],
|
|
5730
|
+
"extendsTokenRange": {
|
|
5731
|
+
"startIndex": 1,
|
|
5732
|
+
"endIndex": 2
|
|
5733
|
+
},
|
|
5734
|
+
"implementsTokenRanges": []
|
|
5735
|
+
},
|
|
5418
5736
|
{
|
|
5419
5737
|
"kind": "Class",
|
|
5420
5738
|
"canonicalReference": "ibm-cloud-sdk-core!NoAuthAuthenticator:class",
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* (C) Copyright IBM Corp. 2019,
|
|
2
|
+
* (C) Copyright IBM Corp. 2019, 2023.
|
|
3
3
|
*
|
|
4
4
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
5
|
* you may not use this file except in compliance with the License.
|
|
@@ -29,6 +29,7 @@ export declare class Authenticator implements AuthenticatorInterface {
|
|
|
29
29
|
static AUTHTYPE_CP4D: string;
|
|
30
30
|
static AUTHTYPE_NOAUTH: string;
|
|
31
31
|
static AUTHTYPE_VPC: string;
|
|
32
|
+
static AUTHTYPE_MCSP: string;
|
|
32
33
|
static AUTHTYPE_UNKNOWN: string;
|
|
33
34
|
/**
|
|
34
35
|
* Create a new Authenticator instance.
|
|
@@ -37,6 +37,7 @@
|
|
|
37
37
|
* IAMAuthenticator: Authenticator for passing IAM authentication information to service endpoint.
|
|
38
38
|
* ContainerAuthenticator: Authenticator for passing IAM authentication to a service, based on a token living on the container.
|
|
39
39
|
* VpcInstanceAuthenticator: Authenticator that uses the VPC Instance Metadata Service API to retrieve an IAM token.
|
|
40
|
+
* McspAuthenticator: Authenticator for passing MCSP authentication to a service endpoint.
|
|
40
41
|
* NoAuthAuthenticator: Performs no authentication. Useful for testing purposes.
|
|
41
42
|
*/
|
|
42
43
|
export { AuthenticatorInterface } from './authenticator-interface';
|
|
@@ -50,3 +51,4 @@ export { NoAuthAuthenticator } from './no-auth-authenticator';
|
|
|
50
51
|
export { IamRequestBasedAuthenticator } from './iam-request-based-authenticator';
|
|
51
52
|
export { TokenRequestBasedAuthenticator } from './token-request-based-authenticator';
|
|
52
53
|
export { VpcInstanceAuthenticator } from './vpc-instance-authenticator';
|
|
54
|
+
export { McspAuthenticator } from './mcsp-authenticator';
|
|
@@ -23,3 +23,4 @@ export { NoAuthAuthenticator } from './no-auth-authenticator';
|
|
|
23
23
|
export { IamRequestBasedAuthenticator } from './iam-request-based-authenticator';
|
|
24
24
|
export { TokenRequestBasedAuthenticator } from './token-request-based-authenticator';
|
|
25
25
|
export { VpcInstanceAuthenticator } from './vpc-instance-authenticator';
|
|
26
|
+
export { McspAuthenticator } from './mcsp-authenticator';
|