ibm-cloud-sdk-core/build/docs/ibm-cloud-sdk-core.authenticator.md

Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md)

## Authenticator class

Base Authenticator class for other Authenticators to extend. Not intended to be used as a stand-alone authenticator.

**Signature:**

```typescript
export declare class Authenticator implements AuthenticatorInterface 
```
**Implements:** [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md)

## Constructors

<table><thead><tr><th>

Constructor


</th><th>

Modifiers


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[(constructor)()](./ibm-cloud-sdk-core.authenticator._constructor_.md)


</td><td>


</td><td>

Create a new Authenticator 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>

[AUTHTYPE\_BASIC](./ibm-cloud-sdk-core.authenticator.authtype_basic.md)


</td><td>

`static`


</td><td>

string


</td><td>

Constants that define the various authenticator types.


</td></tr>
<tr><td>

[AUTHTYPE\_BEARERTOKEN](./ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md)


</td><td>

`static`


</td><td>

string


</td><td>


</td></tr>
<tr><td>

[AUTHTYPE\_CONTAINER](./ibm-cloud-sdk-core.authenticator.authtype_container.md)


</td><td>

`static`


</td><td>

string


</td><td>


</td></tr>
<tr><td>

[AUTHTYPE\_CP4D](./ibm-cloud-sdk-core.authenticator.authtype_cp4d.md)


</td><td>

`static`


</td><td>

string


</td><td>


</td></tr>
<tr><td>

[AUTHTYPE\_IAM\_ASSUME](./ibm-cloud-sdk-core.authenticator.authtype_iam_assume.md)


</td><td>

`static`


</td><td>

string


</td><td>


</td></tr>
<tr><td>

[AUTHTYPE\_IAM](./ibm-cloud-sdk-core.authenticator.authtype_iam.md)


</td><td>

`static`


</td><td>

string


</td><td>


</td></tr>
<tr><td>

[AUTHTYPE\_MCSP](./ibm-cloud-sdk-core.authenticator.authtype_mcsp.md)


</td><td>

`static`


</td><td>

string


</td><td>


</td></tr>
<tr><td>

[AUTHTYPE\_NOAUTH](./ibm-cloud-sdk-core.authenticator.authtype_noauth.md)


</td><td>

`static`


</td><td>

string


</td><td>


</td></tr>
<tr><td>

[AUTHTYPE\_UNKNOWN](./ibm-cloud-sdk-core.authenticator.authtype_unknown.md)


</td><td>

`static`


</td><td>

string


</td><td>


</td></tr>
<tr><td>

[AUTHTYPE\_VPC](./ibm-cloud-sdk-core.authenticator.authtype_vpc.md)


</td><td>

`static`


</td><td>

string


</td><td>


</td></tr>
</tbody></table>

## Methods

<table><thead><tr><th>

Method


</th><th>

Modifiers


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[authenticate(requestOptions)](./ibm-cloud-sdk-core.authenticator.authenticate.md)


</td><td>


</td><td>

Augment the request with authentication information.


</td></tr>
<tr><td>

[authenticationType()](./ibm-cloud-sdk-core.authenticator.authenticationtype.md)


</td><td>


</td><td>

Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the &lt;<!-- -->service\_name<!-- -->&gt;<!-- -->\_AUTH\_TYPE configuration property (e.g. "basic", "iam", etc.). This function should be overridden in each authenticator implementation class that extends this class.


</td></tr>
</tbody></table>