ibm-cloud-sdk-core

Version:

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

55 lines (26 loc) • 2.02 kB

Markdown

[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [IamAssumeAuthenticator](./ibm-cloud-sdk-core.iamassumeauthenticator.md) > [(constructor)](./ibm-cloud-sdk-core.iamassumeauthenticator._constructor_.md) ## IamAssumeAuthenticator.(constructor) Create a new IamAssumeAuthenticator instance. **Signature:** ```typescript constructor(options: Options); ``` ## Parameters <table><thead><tr><th> Parameter </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> options </td><td> Options </td><td> Configuration options for IAM authentication. This should be an object containing these fields: - apikey: (required) the IAM api key for initial token request - iamProfileId: (optional) the ID of the trusted profile to use - iamProfileCrn: (optional) the CRN of the trusted profile to use - iamProfileName: (optional) the name of the trusted profile to use (must be specified with iamAccountId) - iamAccountId: (optional) the ID of the account the trusted profile is in (must be specified with iamProfileName) - url: (optional) the endpoint URL for the token service - 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 - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service </td></tr> </tbody></table> ## Exceptions Error: the configuration options are not valid.