UNPKG

ibm-cloud-sdk-core

Version:

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

60 lines (59 loc) 2.26 kB
/** * (C) Copyright IBM Corp. 2023, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { JwtTokenManager, JwtTokenManagerOptions } from './jwt-token-manager'; /** * Configuration options for MCSP token retrieval. */ interface Options extends JwtTokenManagerOptions { /** The API key used to obtain an access token. */ apikey: string; /** The base endpoint URL for MCSP token requests. */ url: string; } /** * This interface models the response object received from the MCSP token service. */ export interface McspTokenData { token: string; token_type: string; expires_in: number; } /** * Token Manager for Multi-Cloud Saas Platform (MCSP) authenticator. * * 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. */ export declare class McspTokenManager extends JwtTokenManager { protected requiredOptions: string[]; private apikey; /** * Create a new McspTokenManager instance. * * @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 * * @throws Error: the configuration options were invalid. */ constructor(options: Options); protected requestToken(): Promise<any>; } export {};