ibm-cloud-sdk-core
Version:
Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.
131 lines (60 loc) • 2.07 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) > [IamAssumeAuthenticator](./ibm-cloud-sdk-core.iamassumeauthenticator.md)
## IamAssumeAuthenticator class
The IamAssumeAuthenticator obtains an IAM access token using the IAM "get-token" operation's "assume" grant type. The authenticator obtains an initial IAM access token from a user-supplied apikey, then exchanges this initial IAM access token for another IAM access token that has "assumed the identity" of the specified trusted profile.
The bearer token will be sent as an Authorization header in the form:
Authorization: Bearer <<!-- -->bearer-token<!-- -->>
**Signature:**
```typescript
export declare class IamAssumeAuthenticator extends IamRequestBasedAuthenticatorImmutable
```
**Extends:** IamRequestBasedAuthenticatorImmutable
## Constructors
<table><thead><tr><th>
Constructor
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[(constructor)(options)](./ibm-cloud-sdk-core.iamassumeauthenticator._constructor_.md)
</td><td>
</td><td>
Create a new IamAssumeAuthenticator 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>
[tokenManager](./ibm-cloud-sdk-core.iamassumeauthenticator.tokenmanager.md)
</td><td>
`protected`
</td><td>
[IamAssumeTokenManager](./ibm-cloud-sdk-core.iamassumetokenmanager.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.iamassumeauthenticator.authenticationtype.md)
</td><td>
</td><td>
Returns the authenticator's type ('iamAssume').
</td></tr>
</tbody></table>