ibm-cloud-sdk-core
Version:
Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.
146 lines (66 loc) • 2.08 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [McspAuthenticator](./ibm-cloud-sdk-core.mcspauthenticator.md)
## McspAuthenticator class
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>"
**Signature:**
```typescript
export declare class McspAuthenticator extends TokenRequestBasedAuthenticator
```
**Extends:** [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
## Constructors
<table><thead><tr><th>
Constructor
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[(constructor)(options)](./ibm-cloud-sdk-core.mcspauthenticator._constructor_.md)
</td><td>
</td><td>
Create a new McspAuthenticator instance.
</td></tr>
</tbody></table>
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[requiredOptions](./ibm-cloud-sdk-core.mcspauthenticator.requiredoptions.md)
</td><td>
`protected`
</td><td>
string\[\]
</td><td>
</td></tr>
<tr><td>
[tokenManager](./ibm-cloud-sdk-core.mcspauthenticator.tokenmanager.md)
</td><td>
`protected`
</td><td>
[McspTokenManager](./ibm-cloud-sdk-core.mcsptokenmanager.md)
</td><td>
</td></tr>
</tbody></table>
## Methods
<table><thead><tr><th>
Method
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[authenticationType()](./ibm-cloud-sdk-core.mcspauthenticator.authenticationtype.md)
</td><td>
</td><td>
Returns the authenticator's type ('cp4d').
</td></tr>
</tbody></table>