{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.52.8", "schemaVersion": 1011, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ { "tagName": "@alpha", "syntaxKind": "modifier" }, { "tagName": "@beta", "syntaxKind": "modifier" }, { "tagName": "@defaultValue", "syntaxKind": "block" }, { "tagName": "@decorator", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@deprecated", "syntaxKind": "block" }, { "tagName": "@eventProperty", "syntaxKind": "modifier" }, { "tagName": "@example", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@experimental", "syntaxKind": "modifier" }, { "tagName": "@inheritDoc", "syntaxKind": "inline" }, { "tagName": "@internal", "syntaxKind": "modifier" }, { "tagName": "@label", "syntaxKind": "inline" }, { "tagName": "@link", "syntaxKind": "inline", "allowMultiple": true }, { "tagName": "@override", "syntaxKind": "modifier" }, { "tagName": "@packageDocumentation", "syntaxKind": "modifier" }, { "tagName": "@param", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@privateRemarks", "syntaxKind": "block" }, { "tagName": "@public", "syntaxKind": "modifier" }, { "tagName": "@readonly", "syntaxKind": "modifier" }, { "tagName": "@remarks", "syntaxKind": "block" }, { "tagName": "@returns", "syntaxKind": "block" }, { "tagName": "@sealed", "syntaxKind": "modifier" }, { "tagName": "@see", "syntaxKind": "block" }, { "tagName": "@throws", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@typeParam", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@virtual", "syntaxKind": "modifier" }, { "tagName": "@betaDocumentation", "syntaxKind": "modifier" }, { "tagName": "@internalRemarks", "syntaxKind": "block" }, { "tagName": "@preapproved", "syntaxKind": "modifier" } ], "supportForTags": { "@alpha": true, "@beta": true, "@defaultValue": true, "@decorator": true, "@deprecated": true, "@eventProperty": true, "@example": true, "@experimental": true, "@inheritDoc": true, "@internal": true, "@label": true, "@link": true, "@override": true, "@packageDocumentation": true, "@param": true, "@privateRemarks": true, "@public": true, "@readonly": true, "@remarks": true, "@returns": true, "@sealed": true, "@see": true, "@throws": true, "@typeParam": true, "@virtual": true, "@betaDocumentation": true, "@internalRemarks": true, "@preapproved": true }, "reportUnsupportedHtmlElements": false } }, "kind": "Package", "canonicalReference": "ibm-cloud-sdk-core!", "docComment": "", "name": "ibm-cloud-sdk-core", "preserveMemberOrder": false, "members": [ { "kind": "EntryPoint", "canonicalReference": "ibm-cloud-sdk-core!", "name": "", "preserveMemberOrder": false, "members": [ { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!atLeastOne:function(1)", "docComment": "/**\n * Checks for at least one of the given elements being defined.\n *\n * @param args - The spread of arguments to check\n *\n * @returns true if one or more are defined; false if all are undefined\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function atLeastOne(...args: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/utils/helpers.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "atLeastOne" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!atMostOne:function(1)", "docComment": "/**\n * Verifies that no more than one of the given elements are defined. Returns true if one or none are defined, and false otherwise.\n *\n * @param args - The spread of arguments to check\n *\n * @returns false if more than one elements are defined, true otherwise\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function atMostOne(...args: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/utils/helpers.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "atMostOne" }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!Authenticator:class", "docComment": "/**\n * Base Authenticator class for other Authenticators to extend. Not intended to be used as a stand-alone authenticator.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Authenticator implements " }, { "kind": "Reference", "text": "AuthenticatorInterface", "canonicalReference": "ibm-cloud-sdk-core!AuthenticatorInterface:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/authenticators/authenticator.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "Authenticator", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!Authenticator:constructor(1)", "docComment": "/**\n * Create a new Authenticator instance.\n *\n * @throws\n *\n * Error: the \"new\" keyword was not used to construct the authenticator.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor();" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!Authenticator#authenticate:member(1)", "docComment": "/**\n * Augment the request with authentication information.\n *\n * @param requestOptions - The request to augment with authentication information.\n *\n * @throws\n *\n * Error: The authenticate method was not implemented by a subclass.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticate(requestOptions: " }, { "kind": "Reference", "text": "AuthenticateOptions", "canonicalReference": "ibm-cloud-sdk-core!~AuthenticateOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "requestOptions", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "authenticate" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!Authenticator#authenticationType:member(1)", "docComment": "/**\n * 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 \\_AUTH_TYPE configuration property (e.g. \"basic\", \"iam\", etc.). This function should be overridden in each authenticator implementation class that extends this class.\n *\n * @returns a string that indicates the authenticator's type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticationType(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "authenticationType" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_BASIC:member", "docComment": "/**\n * Constants that define the various authenticator types.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static AUTHTYPE_BASIC: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "AUTHTYPE_BASIC", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_BEARERTOKEN:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static AUTHTYPE_BEARERTOKEN: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "AUTHTYPE_BEARERTOKEN", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_CONTAINER:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static AUTHTYPE_CONTAINER: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "AUTHTYPE_CONTAINER", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_CP4D:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static AUTHTYPE_CP4D: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "AUTHTYPE_CP4D", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_IAM_ASSUME:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static AUTHTYPE_IAM_ASSUME: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "AUTHTYPE_IAM_ASSUME", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_IAM:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static AUTHTYPE_IAM: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "AUTHTYPE_IAM", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_MCSP:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static AUTHTYPE_MCSP: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "AUTHTYPE_MCSP", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_MCSPV2:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static AUTHTYPE_MCSPV2: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "AUTHTYPE_MCSPV2", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_NOAUTH:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static AUTHTYPE_NOAUTH: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "AUTHTYPE_NOAUTH", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_UNKNOWN:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static AUTHTYPE_UNKNOWN: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "AUTHTYPE_UNKNOWN", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_VPC:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static AUTHTYPE_VPC: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "AUTHTYPE_VPC", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false } ], "implementsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "ibm-cloud-sdk-core!AuthenticatorInterface:interface", "docComment": "/**\n * This interface defines the common methods associated with an Authenticator implementation.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AuthenticatorInterface " } ], "fileUrlPath": "dist/es/auth/authenticators/authenticator-interface.d.ts", "releaseTag": "Public", "name": "AuthenticatorInterface", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "ibm-cloud-sdk-core!AuthenticatorInterface#authenticate:member(1)", "docComment": "/**\n * Add authentication information to the specified request.\n *\n * @param requestOptions - The request to which authentication information is added (in the headers field).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticate(requestOptions: " }, { "kind": "Reference", "text": "AuthenticateOptions", "canonicalReference": "ibm-cloud-sdk-core!~AuthenticateOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "requestOptions", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "authenticate" }, { "kind": "MethodSignature", "canonicalReference": "ibm-cloud-sdk-core!AuthenticatorInterface#authenticationType:member(1)", "docComment": "/**\n * Returns a string that indicates the authentication type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticationType(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "authenticationType" } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!BaseService:class", "docComment": "/**\n * Common functionality shared by generated service classes.\n *\n * The base service authenticates requests via its authenticator, and sends them to the service endpoint.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class BaseService " } ], "fileUrlPath": "dist/es/lib/base-service.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "BaseService", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!BaseService:constructor(1)", "docComment": "/**\n * Configuration values for a service.\n *\n * @param userOptions - the configuration options to set on the service instance. This should be an object with the following fields: - authenticator: (required) an Object used to authenticate requests to the service. - serviceUrl: (optional) the base url to use when contacting the service. The base url may differ between IBM Cloud regions. - headers: (optional) a set of HTTP headers that should be included with every request sent to the service - disableSslVerification: (optional) a flag that indicates whether verification of the server's SSL certificate should be disabled or not.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(userOptions: " }, { "kind": "Reference", "text": "UserOptions", "canonicalReference": "ibm-cloud-sdk-core!UserOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "userOptions", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!BaseService#baseOptions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected baseOptions: " }, { "kind": "Reference", "text": "BaseServiceOptions", "canonicalReference": "ibm-cloud-sdk-core!~BaseServiceOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "baseOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BaseService#configureService:member(1)", "docComment": "/**\n * Configure the service using external configuration\n *\n * @param serviceName - the name of the service. This will be used to read from external configuration.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected configureService(serviceName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [ { "parameterName": "serviceName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "configureService" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BaseService.convertModel:member(1)", "docComment": "/**\n * Applies a given modifier function on a model object. Since the model object can be a map, or an array, or a model, these types needs different handling. Considering whether the input object is a map happens with an explicit parameter.\n *\n * @param input - the input model object\n *\n * @param converterFn - the function that is applied on the input object\n *\n * @param isMap - is `true` when the input object should be handled as a map\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static convertModel(input: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ", converterFn: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ", isMap?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "input", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "converterFn", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "isMap", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "convertModel" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BaseService#createRequest:member(1)", "docComment": "/**\n * Wrapper around `sendRequest` that enforces the request will be authenticated.\n *\n * @param parameters - Service request options passed in by user. This should be an object with the following fields: - options.method: the http method - options.url: the path portion of the URL to be appended to the serviceUrl - options.path: the path parameters to be inserted into the URL - options.qs: the querystring to be included in the URL - options.body: the data to be sent as the request body - options.form: an object containing the key/value pairs for a www-form-urlencoded request. - options.formData: an object containing the contents for a multipart/form-data request The following processing is performed on formData values: - string: no special processing -- the value is sent as is - object: the value is converted to a JSON string before insertion into the form body - NodeJS.ReadableStream|Buffer|FileWithMetadata: sent as a file, with any associated metadata - array: each element of the array is sent as a separate form part using any special processing as described above - defaultOptions.serviceUrl: the base URL of the service - defaultOptions.headers: additional HTTP headers to be sent with the request\n *\n * @returns a Promise\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected createRequest(parameters: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [ { "parameterName": "parameters", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "createRequest" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BaseService#createRequestAndDeserializeResponse:member(1)", "docComment": "/**\n * Wrapper around `createRequest` that enforces arrived response to be deserialized.\n *\n * @param parameters - see `parameters` in `createRequest`\n *\n * @param deserializerFn - the deserializer function that is applied on the response object\n *\n * @param isMap - is `true` when the response object should be handled as a map\n *\n * @returns a Promise\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected createRequestAndDeserializeResponse(parameters: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ", deserializerFn: " }, { "kind": "Content", "text": "(any: any) => any" }, { "kind": "Content", "text": ", isMap?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [ { "parameterName": "parameters", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "deserializerFn", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "isMap", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "createRequestAndDeserializeResponse" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!BaseService.DEFAULT_SERVICE_NAME:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static DEFAULT_SERVICE_NAME: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "DEFAULT_SERVICE_NAME", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!BaseService.DEFAULT_SERVICE_URL:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static DEFAULT_SERVICE_URL: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "DEFAULT_SERVICE_URL", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BaseService#disableRetries:member(1)", "docComment": "/**\n * Disables retries.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableRetries(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "disableRetries" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BaseService#enableRetries:member(1)", "docComment": "/**\n * Enable retries for unfulfilled requests.\n *\n * @param retryOptions - the configuration for retries\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableRetries(retryOptions?: " }, { "kind": "Reference", "text": "RetryOptions", "canonicalReference": "ibm-cloud-sdk-core!~RetryOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "retryOptions", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "enableRetries" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BaseService#getAuthenticator:member(1)", "docComment": "/**\n * Get the instance of the authenticator set on the service.\n *\n * @returns the Authenticator instance\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getAuthenticator(): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getAuthenticator" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BaseService#getHttpClient:member(1)", "docComment": "/**\n * Get the Axios instance set on the service. All requests will be made using this instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getHttpClient(): " }, { "kind": "Content", "text": "import(\"axios\")." }, { "kind": "Reference", "text": "AxiosInstance", "canonicalReference": "axios!AxiosInstance:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getHttpClient" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BaseService#setDefaultHeaders:member(1)", "docComment": "/**\n * Set the HTTP headers to be sent in every request.\n *\n * @param headers - the map of headers to include in requests.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDefaultHeaders(headers: " }, { "kind": "Reference", "text": "OutgoingHttpHeaders", "canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "headers", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setDefaultHeaders" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BaseService#setEnableGzipCompression:member(1)", "docComment": "/**\n * Turn request body compression on or off.\n *\n * @param setting - Will turn it on if 'true', off if 'false'.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setEnableGzipCompression(setting: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "setting", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setEnableGzipCompression" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BaseService#setServiceUrl:member(1)", "docComment": "/**\n * Set the service URL to send requests to.\n *\n * @param url - the base URL for the service.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setServiceUrl(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setServiceUrl" } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!BasicAuthenticator:class", "docComment": "/**\n * The BasicAuthenticator is used to add basic authentication information to requests.\n *\n * Basic Authorization will be sent as an Authorization header in the form:\n *\n * Authorization: Basic \\\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class BasicAuthenticator extends " }, { "kind": "Reference", "text": "Authenticator", "canonicalReference": "ibm-cloud-sdk-core!Authenticator:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/authenticators/basic-authenticator.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "BasicAuthenticator", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!BasicAuthenticator:constructor(1)", "docComment": "/**\n * Create a new BasicAuthenticator instance.\n *\n * @param options - Configuration options for basic authentication. This should be an object containing these fields: - username: the username portion of basic authentication - password: the password portion of basic authentication\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options:type" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BasicAuthenticator#authenticate:member(1)", "docComment": "/**\n * Add basic authentication information to `requestOptions`. The basic authentication information will be set in the Authorization property of `requestOptions.headers` in the form:\n *\n * Authorization: Basic \\\n *\n * @param requestOptions - The request to augment with authentication information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticate(requestOptions: " }, { "kind": "Reference", "text": "AuthenticateOptions", "canonicalReference": "ibm-cloud-sdk-core!~AuthenticateOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "requestOptions", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "authenticate" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BasicAuthenticator#authenticationType:member(1)", "docComment": "/**\n * Returns the authenticator's type ('basic').\n *\n * @returns a string that indicates the authenticator's type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticationType(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "authenticationType" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!BasicAuthenticator#authHeader:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected authHeader: " }, { "kind": "Content", "text": "{\n Authorization: string;\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "authHeader", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!BasicAuthenticator#requiredOptions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requiredOptions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requiredOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!BearerTokenAuthenticator:class", "docComment": "/**\n * The BearerTokenAuthenticator will set a user-provided bearer token in requests.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer \\\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class BearerTokenAuthenticator extends " }, { "kind": "Reference", "text": "Authenticator", "canonicalReference": "ibm-cloud-sdk-core!Authenticator:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/authenticators/bearer-token-authenticator.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "BearerTokenAuthenticator", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!BearerTokenAuthenticator:constructor(1)", "docComment": "/**\n * Create a new BearerTokenAuthenticator instance.\n *\n * @param options - Configuration options for bearer authentication. This should be an object containing the \"bearerToken\" field.\n *\n * @throws\n *\n * Error: the options.bearerToken field is not valid, or unspecified\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_2:type" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BearerTokenAuthenticator#authenticate:member(1)", "docComment": "/**\n * Add a bearer token to `requestOptions`. The bearer token information will be set in the Authorization property of \"requestOptions.headers\" in the form:\n *\n * Authorization: Bearer \\\n *\n * @param requestOptions - The request to augment with authentication information.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticate(requestOptions: " }, { "kind": "Reference", "text": "AuthenticateOptions", "canonicalReference": "ibm-cloud-sdk-core!~AuthenticateOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "requestOptions", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "authenticate" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BearerTokenAuthenticator#authenticationType:member(1)", "docComment": "/**\n * Returns the authenticator's type ('bearertoken').\n *\n * @returns a string that indicates the authenticator's type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticationType(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "authenticationType" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!BearerTokenAuthenticator#requiredOptions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requiredOptions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requiredOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!BearerTokenAuthenticator#setBearerToken:member(1)", "docComment": "/**\n * Set a new bearer token to be sent in subsequent requests.\n *\n * @param bearerToken - The bearer token that will be sent in service requests.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setBearerToken(bearerToken: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "bearerToken", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setBearerToken" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!buildRequestFileObject:function(1)", "docComment": "/**\n * This function builds a `form-data` object for each file parameter.\n *\n * @param fileParam - The FileWithMetadata instance that contains the file information\n *\n * @returns the FileObject instance\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function buildRequestFileObject(fileParam: " }, { "kind": "Reference", "text": "FileWithMetadata", "canonicalReference": "ibm-cloud-sdk-core!FileWithMetadata:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileObject", "canonicalReference": "ibm-cloud-sdk-core!FileObject:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "fileParam", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "buildRequestFileObject" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!checkCredentials:function(1)", "docComment": "/**\n * Checks credentials for common user mistakes of copying \\{, \\}, or \\\" characters from the documentation\n *\n * @param obj - the options object holding credentials\n *\n * @param credsToCheck - an array containing the keys of the credentials to check for problems\n *\n * @returns a string with the error message if there were problems, null if not\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function checkCredentials(obj: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ", credsToCheck: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/utils/helpers.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "obj", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "credsToCheck", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "checkCredentials" }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!CloudPakForDataAuthenticator:class", "docComment": "/**\n * The CloudPakForDataAuthenticator will either use a username/password pair or a username/apikey pair to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer \\\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class CloudPakForDataAuthenticator extends " }, { "kind": "Reference", "text": "TokenRequestBasedAuthenticator", "canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/authenticators/cloud-pak-for-data-authenticator.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "CloudPakForDataAuthenticator", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!CloudPakForDataAuthenticator:constructor(1)", "docComment": "/**\n * Create a new CloudPakForDataAuthenticator instance.\n *\n * @param options - Configuration options for CloudPakForData authentication. This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - 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\n *\n * @throws\n *\n * Error: the username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_4:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!CloudPakForDataAuthenticator#authenticationType:member(1)", "docComment": "/**\n * Returns the authenticator's type ('cp4d').\n *\n * @returns a string that indicates the authenticator's type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticationType(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "authenticationType" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!CloudPakForDataAuthenticator#requiredOptions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requiredOptions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requiredOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!CloudPakForDataAuthenticator#tokenManager:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected tokenManager: " }, { "kind": "Reference", "text": "Cp4dTokenManager", "canonicalReference": "ibm-cloud-sdk-core!Cp4dTokenManager:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tokenManager", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!computeBasicAuthHeader:function(1)", "docComment": "/**\n * Compute and return a Basic Authorization header from a username and password.\n *\n * @param username - The username or client id\n *\n * @param password - The password or client secret\n *\n * @returns a Basic Auth header with format \"Basic \"\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function computeBasicAuthHeader(username: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", password: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/utils/helpers.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "username", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "password", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "computeBasicAuthHeader" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!constructFilepath:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function constructFilepath(filepath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/utils/file-reading-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filepath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "constructFilepath" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!constructServiceUrl:function(1)", "docComment": "/**\n * Constructs a service URL by formatting a parameterized URL.\n *\n * @param parameterizedUrl - a URL that contains variable placeholders, e.g. '\\{scheme\\}://ibm.com'.\n *\n * @param defaultUrlVariables - a Map of variable names to default values. Each variable in the parameterized URL must have a default value specified in this map.\n *\n * @param providedUrlVariables - a Map of variable names to desired values. If a variable is not provided in this map, the default variable value will be used instead.\n *\n * @returns the formatted URL with all variable placeholders replaced by values.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function constructServiceUrl(parameterizedUrl: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", defaultUrlVariables: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ", providedUrlVariables: " }, { "kind": "Reference", "text": "Map", "canonicalReference": "!Map:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "parameterizedUrl", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "defaultUrlVariables", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isOptional": false }, { "parameterName": "providedUrlVariables", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "isOptional": false } ], "name": "constructServiceUrl" }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator:class", "docComment": "/**\n * The ContainerAuthenticator will read a compute resource token from the file system and use this value to obtain a bearer token from the IAM token server. When the bearer token expires, a new token is obtained from the token server.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer \\\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ContainerAuthenticator extends " }, { "kind": "Reference", "text": "IamRequestBasedAuthenticator", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/authenticators/container-authenticator.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ContainerAuthenticator", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator:constructor(1)", "docComment": "/**\n * Create a new ContainerAuthenticator instance.\n *\n * @param options - Configuration options for IAM authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - crTokenFilename: (optional) the file containing the compute resource token - iamProfileName: (optional) the name of the IAM trusted profile associated with the compute resource token (required if iamProfileId is not specified) - iamProfileId]: (optional) the ID of the IAM trusted profile associated with the compute resource token (required if iamProfileName is not specified) - 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\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_8:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator#authenticationType:member(1)", "docComment": "/**\n * Returns the authenticator's type ('container').\n *\n * @returns a string that indicates the authenticator's type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticationType(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "authenticationType" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator#getRefreshToken:member(1)", "docComment": "/**\n * Return the most recently stored refresh token.\n *\n * @returns the refresh token string\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRefreshToken(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getRefreshToken" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator#setCrTokenFilename:member(1)", "docComment": "/**\n * Setter for the filename of the compute resource token.\n *\n * @param crTokenFilename - A string containing a path to the CR token file\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCrTokenFilename(crTokenFilename: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "crTokenFilename", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setCrTokenFilename" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator#setIamProfileId:member(1)", "docComment": "/**\n * Setter for the \"profile_id\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param iamProfileId - the ID of the IAM trusted profile\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIamProfileId(iamProfileId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "iamProfileId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setIamProfileId" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator#setIamProfileName:member(1)", "docComment": "/**\n * Setter for the \"profile_name\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param iamProfileName - the name of the IAM trusted profile\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIamProfileName(iamProfileName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "iamProfileName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setIamProfileName" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator#tokenManager:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected tokenManager: " }, { "kind": "Reference", "text": "ContainerTokenManager", "canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tokenManager", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager:class", "docComment": "/**\n * The ContainerTokenManager retrieves a compute resource token from a file on the container. This token is used to perform the necessary interactions with the IAM token service to obtain and store a suitable bearer (access) token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class ContainerTokenManager extends " }, { "kind": "Reference", "text": "IamRequestBasedTokenManager", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/token-managers/container-token-manager.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "ContainerTokenManager", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager:constructor(1)", "docComment": "/**\n * Create a new ContainerTokenManager instance.\n *\n * @param options - Configuration options. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service (default: \"https://iam.cloud.ibm.com\") - crTokenFilename: (optional) the file containing the compute resource token (default: \"/var/run/secrets/tokens/vault-token\") - iamProfileName: (optional) the name of the IAM trusted profile associated with the compute resource token (required if iamProfileId is not specified) - iamProfileId]: (optional) the ID of the IAM trusted profile associated with the compute resource token (required if iamProfileName is not specified) - headers: (optional) a set of HTTP headers to be sent with each request to the token service - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - 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\n *\n * @throws\n *\n * Error: the configuration options were invalid\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_7:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager#getCrToken:member(1)", "docComment": "/**\n * Retrieves the CR token from a file using this search order: 1. User-specified filename (if specified) 2. Default file #1 (/var/run/secrets/tokens/vault-token) 3. Default file #2 (/var/run/secrets/tokens/sa-token) 4. Default file #3 (/var/run/secrets/codeengine.cloud.ibm.com/compute-resource-token/token) First one found wins.\n *\n * @returns the CR token value as a string\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected getCrToken(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getCrToken" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager#getRefreshToken:member(1)", "docComment": "/**\n * Returns the most recently stored refresh token.\n *\n * @returns the refresh token\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRefreshToken(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getRefreshToken" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager#requestToken:member(1)", "docComment": "/**\n * Request an IAM token using a compute resource token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected requestToken(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "requestToken" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager#setCrTokenFilename:member(1)", "docComment": "/**\n * Sets the \"crTokenFilename\" field\n *\n * @param crTokenFilename - the name of the file containing the CR token\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setCrTokenFilename(crTokenFilename: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "crTokenFilename", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setCrTokenFilename" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager#setIamProfileId:member(1)", "docComment": "/**\n * Sets the ID of the IAM trusted profile to use when obtaining an access token from the IAM token server.\n *\n * @param iamProfileId - the ID of the IAM trusted profile\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIamProfileId(iamProfileId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "iamProfileId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setIamProfileId" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager#setIamProfileName:member(1)", "docComment": "/**\n * Sets the name of the IAM trusted profile to use when obtaining an access token from the IAM token server.\n *\n * @param iamProfileName - the name of the IAM trusted profile\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIamProfileName(iamProfileName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "iamProfileName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setIamProfileName" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "ibm-cloud-sdk-core!contentType:var", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "_default: " }, { "kind": "Content", "text": "{\n fromFilename: (file: " }, { "kind": "Reference", "text": "String", "canonicalReference": "!String:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "File", "canonicalReference": "!File:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "FileObject", "canonicalReference": "ibm-cloud-sdk-core!FileObject:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "NodeJS.ReadableStream", "canonicalReference": "@types/node!__global.NodeJS.ReadableStream:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ") => string;\n fromHeader: (buffer: " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ") => string;\n}" } ], "fileUrlPath": "dist/es/lib/content-type.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "contentType", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 14 } }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!Cp4dTokenManager:class", "docComment": "/**\n * Token Manager of CloudPak for data.\n *\n * The Token Manager performs basic auth with a username and password to acquire CP4D tokens.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Cp4dTokenManager extends " }, { "kind": "Reference", "text": "JwtTokenManager", "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/token-managers/cp4d-token-manager.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "Cp4dTokenManager", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!Cp4dTokenManager:constructor(1)", "docComment": "/**\n * Create a new Cp4dTokenManager instance.\n *\n * @param options - Configuration options This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - 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\n *\n * @throws\n *\n * Error: the configuration options were invalid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_3:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!Cp4dTokenManager#requestToken:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requestToken(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "requestToken" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!Cp4dTokenManager#requiredOptions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requiredOptions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requiredOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!fileExistsAtPath:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function fileExistsAtPath(filepath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/utils/file-reading-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filepath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "fileExistsAtPath" }, { "kind": "Interface", "canonicalReference": "ibm-cloud-sdk-core!FileObject:interface", "docComment": "/**\n * (C) Copyright IBM Corp. 2014, 2023.\n *\n * 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\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * 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.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileObject " } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "releaseTag": "Public", "name": "FileObject", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!FileObject#options:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "options?: " }, { "kind": "Reference", "text": "FileOptions", "canonicalReference": "ibm-cloud-sdk-core!FileOptions:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!FileObject#value:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "value: " }, { "kind": "Reference", "text": "NodeJS.ReadableStream", "canonicalReference": "@types/node!__global.NodeJS.ReadableStream:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "value", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "ibm-cloud-sdk-core!FileOptions:interface", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface FileOptions " } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "releaseTag": "Public", "name": "FileOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!FileOptions#contentType:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "contentType?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "contentType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!FileOptions#filename:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "filename?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "filename", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "ibm-cloud-sdk-core!FileStream:interface", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface FileStream extends " }, { "kind": "Reference", "text": "NodeJS.ReadableStream", "canonicalReference": "@types/node!__global.NodeJS.ReadableStream:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "releaseTag": "Public", "name": "FileStream", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!FileStream#path:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "path: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "ibm-cloud-sdk-core!FileWithMetadata:interface", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface FileWithMetadata " } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "releaseTag": "Public", "name": "FileWithMetadata", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!FileWithMetadata#contentType:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "contentType: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "contentType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!FileWithMetadata#data:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "data: " }, { "kind": "Reference", "text": "NodeJS.ReadableStream", "canonicalReference": "@types/node!__global.NodeJS.ReadableStream:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!FileWithMetadata#filename:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "filename: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filename", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!getAuthenticatorFromEnvironment:function(1)", "docComment": "/**\n * Look for external configuration of authenticator.\n *\n * Try to get authenticator from external sources, with the following priority: 1. Credentials file (ibm-credentials.env) 2. Environment variables 3. VCAP Services (Cloud Foundry)\n *\n * @param serviceName - the service name prefix.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getAuthenticatorFromEnvironment(serviceName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Authenticator", "canonicalReference": "ibm-cloud-sdk-core!Authenticator:class" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/utils/get-authenticator-from-environment.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "serviceName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getAuthenticatorFromEnvironment" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!getContentType:function(1)", "docComment": "/**\n * This function retrieves the content type of the input.\n *\n * @param inputData - The data to retrieve content type for.\n *\n * @returns the content type of the input.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getContentType(inputData: " }, { "kind": "Reference", "text": "NodeJS.ReadableStream", "canonicalReference": "@types/node!__global.NodeJS.ReadableStream:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "inputData", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isOptional": false } ], "name": "getContentType" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!getCurrentTime:function(1)", "docComment": "/**\n * Gets the current time.\n *\n * @returns the current time in seconds.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getCurrentTime(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/utils/helpers.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getCurrentTime" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!getFormat:function(1)", "docComment": "/**\n * Returns the first match from formats that is key the params map otherwise null\n *\n * @param params - The parameters.\n *\n * @param requires - The keys we want to check\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getFormat(params: " }, { "kind": "Content", "text": "{\n [key: string]: any;\n}" }, { "kind": "Content", "text": ", formats: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "formats", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "getFormat" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!getMissingParams:function(1)", "docComment": "/**\n * Validates that all required params are provided\n *\n * @param params - the method parameters.\n *\n * @param requires - the required parameter names.\n *\n * @returns null if no errors found, otherwise an Error instance\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getMissingParams(params: " }, { "kind": "Content", "text": "{\n [key: string]: any;\n}" }, { "kind": "Content", "text": ", requires: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "requires", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "getMissingParams" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!getNewLogger:function(1)", "docComment": "/**\n * Return a new logger, formatted with a particular name. The logging functions, in order of increasing verbosity, are: `error`, `warn`, `info`, `verbose`, and `debug`.\n *\n * The logger will be an instance of the `debug` package and utilizes its support for configuration with environment variables.\n *\n * Additionally, the logger will be turned on automatically if the \"NODE_DEBUG\" environment variable is set to \"axios\".\n *\n * @param moduleName - the namespace for the logger. The name will appear in the logs and it will be the name used for configuring the log level.\n *\n * @returns the new logger\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getNewLogger(moduleName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "SDKLogger", "canonicalReference": "ibm-cloud-sdk-core!SDKLogger:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/get-new-logger.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "moduleName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getNewLogger" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!getQueryParam:function(1)", "docComment": "/**\n * Return a query parameter value from a URL\n *\n * @param urlStr - the url string.\n *\n * @param param - the name of the query parameter whose value should be returned\n *\n * @returns the value of the \"param\" query parameter\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getQueryParam(urlStr: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", param: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "urlStr", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "param", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "getQueryParam" }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!IamAssumeAuthenticator:class", "docComment": "/**\n * 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.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer \\\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class IamAssumeAuthenticator extends " }, { "kind": "Reference", "text": "IamRequestBasedAuthenticatorImmutable", "canonicalReference": "ibm-cloud-sdk-core!~IamRequestBasedAuthenticatorImmutable:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/authenticators/iam-assume-authenticator.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "IamAssumeAuthenticator", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!IamAssumeAuthenticator:constructor(1)", "docComment": "/**\n * Create a new IamAssumeAuthenticator instance.\n *\n * @param options - 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\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_16:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamAssumeAuthenticator#authenticationType:member(1)", "docComment": "/**\n * Returns the authenticator's type ('iamAssume').\n *\n * @returns a string that indicates the authenticator's type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticationType(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "authenticationType" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!IamAssumeAuthenticator#tokenManager:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected tokenManager: " }, { "kind": "Reference", "text": "IamAssumeTokenManager", "canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tokenManager", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager:class", "docComment": "/**\n * The IamAssumeTokenManager takes an api key, along with trusted profile information, and performs the necessary interactions with the IAM token service to obtain and store a suitable bearer token that \"assumes\" the identify of the trusted profile.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class IamAssumeTokenManager extends " }, { "kind": "Reference", "text": "IamRequestBasedTokenManager", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/token-managers/iam-assume-token-manager.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "IamAssumeTokenManager", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager:constructor(1)", "docComment": "/**\n * Create a new IamAssumeTokenManager instance.\n *\n * @param options - Configuration options. This should be an object containing these fields: - apikey: (required) the IAM api key - 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 IAM token service (default value: \"https://iam.cloud.ibm.com\") - 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\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_15:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager#requestToken:member(1)", "docComment": "/**\n * Request an IAM token using a standard access token and a trusted profile.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected requestToken(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "requestToken" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager#requiredOptions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requiredOptions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requiredOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager#saveTokenInfo:member(1)", "docComment": "/**\n * Extend this method from the parent class to erase the refresh token from the class - we do not want to expose it for IAM Assume authentication.\n *\n * @param tokenResponse - the response object from JWT service request\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected saveTokenInfo(tokenResponse: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [ { "parameterName": "tokenResponse", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "saveTokenInfo" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager#setClientIdAndSecret:member(1)", "docComment": "/**\n * Sets the IAM \"clientId\" and \"clientSecret\" values for the IAM delegate.\n *\n * @param clientId - the client id.\n *\n * @param clientSecret - the client secret.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setClientIdAndSecret(clientId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", clientSecret: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "clientId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "clientSecret", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setClientIdAndSecret" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager#setDisableSslVerification:member(1)", "docComment": "/**\n * Sets the \"disableSslVerification\" property for the IAM delegate.\n *\n * @param value - the new value for the disableSslVerification property\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDisableSslVerification(value: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setDisableSslVerification" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager#setHeaders:member(1)", "docComment": "/**\n * Sets the headers to be included in the IAM delegate's requests.\n *\n * @param headers - the set of headers to send with each request to the token server\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setHeaders(headers: " }, { "kind": "Reference", "text": "OutgoingHttpHeaders", "canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "headers", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setHeaders" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager#setScope:member(1)", "docComment": "/**\n * Sets the IAM \"scope\" value. This value is sent as the \"scope\" form parameter in the IAM delegate request.\n *\n * @param scope - a space-separated string that contains one or more scope names\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setScope(scope: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "scope", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setScope" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator:class", "docComment": "/**\n * The IamAuthenticator will use the user-supplied `apikey` value to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server. If specified, the optional, mutually inclusive \"clientId\" and \"clientSecret\" pair can be used to influence rate-limiting for requests to the IAM token server.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer \\\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class IamAuthenticator extends " }, { "kind": "Reference", "text": "IamRequestBasedAuthenticator", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/authenticators/iam-authenticator.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "IamAuthenticator", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator:constructor(1)", "docComment": "/**\n * Create a new IamAuthenticator instance.\n *\n * @param options - Configuration options for IAM authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - apikey: (required) the IAM api key - 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\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_6:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator#authenticationType:member(1)", "docComment": "/**\n * Returns the authenticator's type ('iam').\n *\n * @returns a string that indicates the authenticator's type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticationType(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "authenticationType" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator#getRefreshToken:member(1)", "docComment": "/**\n * Return the most recently stored refresh token.\n *\n * @returns the refresh token string\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRefreshToken(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getRefreshToken" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator#requiredOptions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requiredOptions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requiredOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator#tokenManager:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected tokenManager: " }, { "kind": "Reference", "text": "IamTokenManager", "canonicalReference": "ibm-cloud-sdk-core!IamTokenManager:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tokenManager", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator:class", "docComment": "/**\n * The IamRequestBasedAuthenticator provides shared configuration and functionality for authenticators that interact with the IAM token service. This authenticator is not meant for use on its own.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class IamRequestBasedAuthenticator extends " }, { "kind": "Reference", "text": "IamRequestBasedAuthenticatorImmutable", "canonicalReference": "ibm-cloud-sdk-core!~IamRequestBasedAuthenticatorImmutable:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/authenticators/iam-request-based-authenticator.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "IamRequestBasedAuthenticator", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator#setClientIdAndSecret:member(1)", "docComment": "/**\n * Setter for the mutually inclusive \"clientId\" and the \"clientSecret\" fields.\n *\n * @param clientId - the \"clientId\" value used to form a Basic Authorization header for IAM token requests\n *\n * @param clientSecret - the \"clientSecret\" value used to form a Basic Authorization header for IAM token requests\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setClientIdAndSecret(clientId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", clientSecret: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "clientId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "clientSecret", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setClientIdAndSecret" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator#setDisableSslVerification:member(1)", "docComment": "/**\n * Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not.\n *\n * @param value - a flag that indicates whether verification of the token server's SSL certificate should be disabled or not.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDisableSslVerification(value: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setDisableSslVerification" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator#setHeaders:member(1)", "docComment": "/**\n * Set headers.\n *\n * @param headers - a set of HTTP headers to be sent with each outbound token server request. Overwrites previous default headers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setHeaders(headers: " }, { "kind": "Reference", "text": "OutgoingHttpHeaders", "canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "headers", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setHeaders" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator#setScope:member(1)", "docComment": "/**\n * Setter for the \"scope\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param scope - (optional) a space-separated string that specifies one or more scopes to be associated with IAM token requests\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setScope(scope: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "scope", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setScope" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager:class", "docComment": "/**\n * The IamRequestBasedTokenManager class contains code relevant to any token manager that interacts with the IAM service to manage a token. It stores information relevant to all IAM requests, such as the client ID and secret, and performs the token request with a set of request options common to any IAM token management scheme. It is intended that this class be extended with specific implementations.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class IamRequestBasedTokenManager extends " }, { "kind": "Reference", "text": "JwtTokenManager", "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/token-managers/iam-request-based-token-manager.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "IamRequestBasedTokenManager", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager:constructor(1)", "docComment": "/**\n * Create a new IamRequestBasedTokenManager instance.\n *\n * @param options - Configuration options. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service (default value: \"https://iam.cloud.ibm.com\") - 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\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "IamRequestOptions", "canonicalReference": "ibm-cloud-sdk-core!IamRequestOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#clientId:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected clientId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "clientId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#clientSecret:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected clientSecret: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "clientSecret", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#formData:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected formData: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "formData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#isTokenExpired:member(1)", "docComment": "/**\n * Returns true iff the currently-cached IAM access token is expired. We'll consider an access token as expired when we reach its IAM server-reported expiration time minus our expiration window (10 secs). We do this to avoid using an access token that might expire in the middle of a long-running transaction within an IBM Cloud service.\n *\n * @returns true if the token has expired, false otherwise\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected isTokenExpired(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isTokenExpired" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#refreshToken:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected refreshToken: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "refreshToken", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#requestToken:member(1)", "docComment": "/**\n * Request an IAM access token using an API key.\n *\n * @returns Promise\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected requestToken(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "requestToken" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#saveTokenInfo:member(1)", "docComment": "/**\n * Extend this method from the parent class to extract the refresh token from the request and save it.\n *\n * @param tokenResponse - the response object from JWT service request\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected saveTokenInfo(tokenResponse: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [ { "parameterName": "tokenResponse", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "saveTokenInfo" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#scope:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected scope: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "scope", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#setClientIdAndSecret:member(1)", "docComment": "/**\n * Sets the IAM \"clientId\" and \"clientSecret\" values. These values are used to compute the Authorization header used when retrieving the IAM access token. If these values are not set, no Authorization header will be set on the request (it is not required).\n *\n * @param clientId - the client id.\n *\n * @param clientSecret - the client secret.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setClientIdAndSecret(clientId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", clientSecret: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "clientId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "clientSecret", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setClientIdAndSecret" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#setScope:member(1)", "docComment": "/**\n * Sets the IAM \"scope\" value. This value is sent as the \"scope\" form parameter within the request sent to the IAM token service.\n *\n * @param scope - a space-separated string that contains one or more scope names\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setScope(scope: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "scope", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setScope" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "ibm-cloud-sdk-core!IamRequestOptions:interface", "docComment": "/**\n * Configuration options for IAM token retrieval.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IamRequestOptions extends " }, { "kind": "Reference", "text": "JwtTokenManagerOptions", "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManagerOptions:type" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/token-managers/iam-request-based-token-manager.d.ts", "releaseTag": "Public", "name": "IamRequestOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!IamRequestOptions#clientId:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "clientId?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "clientId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!IamRequestOptions#clientSecret:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "clientSecret?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "clientSecret", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!IamRequestOptions#scope:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "scope?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "scope", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!IamTokenManager:class", "docComment": "/**\n * The IamTokenManager takes an api key and performs the necessary interactions with the IAM token service to obtain and store a suitable bearer token. Additionally, the IamTokenManager will retrieve bearer tokens via basic auth using a supplied \"clientId\" and \"clientSecret\" pair.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class IamTokenManager extends " }, { "kind": "Reference", "text": "IamRequestBasedTokenManager", "canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/token-managers/iam-token-manager.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "IamTokenManager", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!IamTokenManager:constructor(1)", "docComment": "/**\n * Create a new IamTokenManager instance.\n *\n * @param options - Configuration options. This should be an object containing these fields: - url: (optional) the endpoint URL for the IAM token service (default value: \"https://iam.cloud.ibm.com\") - apikey: (required) the IAM api key - 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\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_5:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!IamTokenManager#getRefreshToken:member(1)", "docComment": "/**\n * Returns the most recently stored refresh token.\n *\n * @returns the refresh token\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRefreshToken(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getRefreshToken" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!IamTokenManager#requiredOptions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requiredOptions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requiredOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!isEmptyObject:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function isEmptyObject(obj: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "obj", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isEmptyObject" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!isFileData:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function isFileData(obj: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "obj", "canonicalReference": "ibm-cloud-sdk-core!~obj" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "NodeJS.ReadableStream", "canonicalReference": "@types/node!__global.NodeJS.ReadableStream:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Buffer", "canonicalReference": "!\"\\\"buffer\\\"\".__global.Buffer:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "obj", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isFileData" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!isFileWithMetadata:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function isFileWithMetadata(obj: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "obj", "canonicalReference": "ibm-cloud-sdk-core!~obj" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "FileWithMetadata", "canonicalReference": "ibm-cloud-sdk-core!FileWithMetadata:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "obj", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isFileWithMetadata" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!isHTML:function(1)", "docComment": "/**\n * Return true if 'text' is html\n *\n * @param text - The 'text' to analyze\n *\n * @returns true if 'text' has html tags\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isHTML(text: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isHTML" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!isJsonMimeType:function(1)", "docComment": "/**\n * Returns true if and only if \"mimeType\" is a \"JSON-like\" mime type (e.g. \"application/json; charset=utf-8\").\n *\n * @param mimeType - the mimeType string\n *\n * @returns true if \"mimeType\" represents a JSON media type and false otherwise\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isJsonMimeType(mimeType: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "mimeType", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "isJsonMimeType" }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager:class", "docComment": "/**\n * A class for shared functionality for parsing, storing, and requesting JWT tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement `requestToken()` to retrieve the bearer token from intended sources.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class JwtTokenManager extends " }, { "kind": "Reference", "text": "TokenManager", "canonicalReference": "ibm-cloud-sdk-core!TokenManager:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/token-managers/jwt-token-manager.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "JwtTokenManager", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager:constructor(1)", "docComment": "/**\n * Create a new JwtTokenManager instance.\n *\n * @param options - Configuration options. This should be an object containing these fields: - 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\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "JwtTokenManagerOptions", "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManagerOptions:type" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager#requestToken:member(1)", "docComment": "/**\n * Request a JWT using an API key.\n *\n * @returns Promise\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected requestToken(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "requestToken" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager#saveTokenInfo:member(1)", "docComment": "/**\n * Save the JWT service response and the calculated expiration time to the object's state.\n *\n * @param tokenResponse - the response object from JWT service request\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected saveTokenInfo(tokenResponse: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [ { "parameterName": "tokenResponse", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "saveTokenInfo" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager#tokenInfo:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected tokenInfo: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tokenInfo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager#tokenName:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected tokenName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tokenName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManagerOptions:type", "docComment": "/**\n * Configuration options for JWT token retrieval.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type JwtTokenManagerOptions = " }, { "kind": "Reference", "text": "TokenManagerOptions", "canonicalReference": "ibm-cloud-sdk-core!TokenManagerOptions:type" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/token-managers/jwt-token-manager.d.ts", "releaseTag": "Public", "name": "JwtTokenManagerOptions", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator:class", "docComment": "/**\n * 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 \"\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class McspAuthenticator extends " }, { "kind": "Reference", "text": "TokenRequestBasedAuthenticator", "canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/authenticators/mcsp-authenticator.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "McspAuthenticator", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator:constructor(1)", "docComment": "/**\n * Create a new McspAuthenticator instance.\n *\n * @param options - Configuration options for CloudPakForData authentication. This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - 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\n *\n * @throws\n *\n * Error: the username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_12:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator#authenticationType:member(1)", "docComment": "/**\n * Returns the authenticator's type ('mcsp').\n *\n * @returns a string that indicates the authenticator's type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticationType(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "authenticationType" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator#requiredOptions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requiredOptions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requiredOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!McspAuthenticator#tokenManager:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected tokenManager: " }, { "kind": "Reference", "text": "McspTokenManager", "canonicalReference": "ibm-cloud-sdk-core!McspTokenManager:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tokenManager", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!McspTokenManager:class", "docComment": "/**\n * Token Manager for Multi-Cloud Saas Platform (MCSP) authenticator.\n *\n * 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.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class McspTokenManager extends " }, { "kind": "Reference", "text": "JwtTokenManager", "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/token-managers/mcsp-token-manager.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "McspTokenManager", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!McspTokenManager:constructor(1)", "docComment": "/**\n * Create a new McspTokenManager instance.\n *\n * @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\n *\n * @throws\n *\n * Error: the configuration options were invalid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_11:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!McspTokenManager#requestToken:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requestToken(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "requestToken" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!McspTokenManager#requiredOptions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requiredOptions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requiredOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!McspV2Authenticator:class", "docComment": "/**\n * The McspV2Authenticator invokes the MCSP v2 token-exchange operation (POST /api/2.0/\\{scopeCollectionType\\}/\\{scopeId\\}/apikeys/token) to obtain an access token for an apikey, and adds the access token to requests via an Authorization header of the form: \"Authorization: Bearer \"\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class McspV2Authenticator extends " }, { "kind": "Reference", "text": "TokenRequestBasedAuthenticator", "canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/authenticators/mcspv2-authenticator.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "McspV2Authenticator", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!McspV2Authenticator:constructor(1)", "docComment": "/**\n * Create a new McspV2Authenticator instance.\n *\n * @param options - Configuration options for MCSP v2 authentication. This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service. - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified). - scopeCollectionType: (required) The scope collection type of item(s). Valid values are: \"accounts\", \"subscriptions\", \"services\". - scopeId: (required) the scope identifier of item(s). - includeBuiltinActions: (optional) a flag to include builtin actions in the \"actions\" claim in the MCSP access token (default: false). - includeCustomActions: (optional) a flag to include custom actions in the \"actions\" claim in the MCSP access token (default: false). - includeRoles: (optional) a flag to include the \"roles\" claim in the MCSP access token (default: true). - prefixRoles: (optional) a flag to add a prefix with the scope level where the role is defined in the \"roles\" claim (default: false). - callerExtClaim: (optional) a map (object) containing keys and values to be injected into the access token as the \"callerExt\" claim. The keys used in this map must be enabled in the apikey by setting the \"callerExtClaimNames\" property when the apikey is created. This property is typically only used in scenarios involving an apikey with identityType `SERVICEID`. - disableSslVerification: (optional) a flag to disable verification of the token server's SSL certificate; defaults to false. - headers: (optional) a set of HTTP headers to be sent with each request to the token service.\n *\n * @throws\n *\n * Error: the input configuration failed validation\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_14:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!McspV2Authenticator#authenticationType:member(1)", "docComment": "/**\n * Returns the authenticator's type ('mcspv2').\n *\n * @returns a string that indicates the authenticator's type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticationType(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "authenticationType" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!McspV2Authenticator#tokenManager:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected tokenManager: " }, { "kind": "Reference", "text": "McspV2TokenManager", "canonicalReference": "ibm-cloud-sdk-core!McspV2TokenManager:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tokenManager", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!McspV2TokenManager:class", "docComment": "/**\n * Token Manager for Multi-Cloud Saas Platform (MCSP) V2 authentication.\n *\n * The McspV2TokenManager will invoke the MCSP token service's 'POST /api/2.0/\\{scopeCollectionType\\}/\\{scopeId\\}/apikeys/token' operation to obtain an MCSP access token for an apikey.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class McspV2TokenManager extends " }, { "kind": "Reference", "text": "JwtTokenManager", "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/token-managers/mcspv2-token-manager.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "McspV2TokenManager", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!McspV2TokenManager:constructor(1)", "docComment": "/**\n * Create a new McspV2TokenManager instance.\n *\n * @param options - Configuration options. This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service. - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified). - scopeCollectionType: (required) The scope collection type of item(s). Valid values are: \"accounts\", \"subscriptions\", \"services\". - scopeId: (required) the scope identifier of item(s). - includeBuiltinActions: (optional) a flag to include builtin actions in the \"actions\" claim in the MCSP access token (default: false). - includeCustomActions: (optional) a flag to include custom actions in the \"actions\" claim in the MCSP access token (default: false). - includeRoles: (optional) a flag to include the \"roles\" claim in the MCSP access token (default: true). - prefixRoles: (optional) a flag to add a prefix with the scope level where the role is defined in the \"roles\" claim (default: false). - callerExtClaim: (optional) a map (object) containing keys and values to be injected into the access token as the \"callerExt\" claim. The keys used in this map must be enabled in the apikey by setting the \"callerExtClaimNames\" property when the apikey is created. This property is typically only used in scenarios involving an apikey with identityType `SERVICEID`. - disableSslVerification: (optional) a flag to disable verification of the token server's SSL certificate; defaults to false. - headers: (optional) a set of HTTP headers to be sent with each request to the token service.\n *\n * @throws\n *\n * Error: the input configuration failed validation\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_13:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!McspV2TokenManager#requestToken:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requestToken(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "requestToken" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!McspV2TokenManager#requiredOptions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requiredOptions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requiredOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!NoAuthAuthenticator:class", "docComment": "/**\n * NoAuthAuthenticator is a placeholder authenticator implementation which performs no authentication of outgoing REST API requests. It might be useful during development and testing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class NoAuthAuthenticator extends " }, { "kind": "Reference", "text": "Authenticator", "canonicalReference": "ibm-cloud-sdk-core!Authenticator:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/authenticators/no-auth-authenticator.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "NoAuthAuthenticator", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!NoAuthAuthenticator#authenticate:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "authenticate(requestOptions: " }, { "kind": "Reference", "text": "AuthenticateOptions", "canonicalReference": "ibm-cloud-sdk-core!~AuthenticateOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "requestOptions", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "authenticate" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!NoAuthAuthenticator#authenticationType:member(1)", "docComment": "/**\n * Returns the authenticator's type ('noauth').\n *\n * @returns a string that indicates the authenticator's type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticationType(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "authenticationType" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!onlyOne:function(1)", "docComment": "/**\n * Checks that exactly one of the arguments provided is defined. Returns true if one argument is defined. Returns false if no argument are defined or if 2 or more are defined.\n *\n * @param args - The spread of arguments to check\n *\n * @returns true if and only if exactly one argument is defined\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function onlyOne(...args: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/utils/helpers.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "onlyOne" }, { "kind": "Variable", "canonicalReference": "ibm-cloud-sdk-core!qs:var", "docComment": "/**\n * (C) Copyright IBM Corp. 2019, 2022.\n *\n * 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\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * 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.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "_default: " }, { "kind": "Content", "text": "{\n stringify: (queryParams: " }, { "kind": "Reference", "text": "Object", "canonicalReference": "!Object:interface" }, { "kind": "Content", "text": ") => string;\n}" } ], "fileUrlPath": "dist/es/lib/querystring.d.ts", "isReadonly": true, "releaseTag": "Public", "name": "qs", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!readCredentialsFile:function(1)", "docComment": "/**\n * Return a config object based on a credentials file. Credentials files can be specified filepath via the environment variable: `IBM_CREDENTIALS_FILE`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function readCredentialsFile(): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/utils/file-reading-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "readCredentialsFile" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!readCrTokenFile:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function readCrTokenFile(filepath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/utils/file-reading-helpers.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "filepath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "readCrTokenFile" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!readExternalSources:function(1)", "docComment": "/**\n * Read properties stored in external sources like Environment Variables, the credentials file, VCAP services, etc. and return them as an object. The keys of this object will have the service name prefix removed and will be converted to lower camel case.\n *\n * Only one source will be used at a time.\n *\n * @param serviceName - the service name prefix\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function readExternalSources(serviceName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/utils/read-external-sources.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "serviceName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "readExternalSources" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!removeSuffix:function(1)", "docComment": "/**\n * Removes a given suffix if it exists.\n *\n * @param str - the base string to operate on\n *\n * @param suffix - the suffix to remove, if present\n *\n * @returns the substring of \"str\" that remains after the suffix is removed\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function removeSuffix(str: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", suffix: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/utils/helpers.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "str", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "suffix", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "removeSuffix" }, { "kind": "Interface", "canonicalReference": "ibm-cloud-sdk-core!SDKLogger:interface", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface SDKLogger " } ], "fileUrlPath": "dist/es/lib/get-new-logger.d.ts", "releaseTag": "Public", "name": "SDKLogger", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!SDKLogger#debug:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "debug: " }, { "kind": "Reference", "text": "Debugger", "canonicalReference": "@types/debug!debug.Debugger:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "debug", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!SDKLogger#error:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "error: " }, { "kind": "Reference", "text": "Debugger", "canonicalReference": "@types/debug!debug.Debugger:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "error", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!SDKLogger#info:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "info: " }, { "kind": "Reference", "text": "Debugger", "canonicalReference": "@types/debug!debug.Debugger:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "info", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!SDKLogger#verbose:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "verbose: " }, { "kind": "Reference", "text": "Debugger", "canonicalReference": "@types/debug!debug.Debugger:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "verbose", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!SDKLogger#warn:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "warn: " }, { "kind": "Reference", "text": "Debugger", "canonicalReference": "@types/debug!debug.Debugger:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "warn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!streamToPromise:function(1)", "docComment": "/**\n * Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer or array of text chunks Essentially a smaller version of concat-stream wrapped in a promise\n *\n * @param stream - optional stream param for when not bound to an existing stream instance.\n *\n * @returns Promise\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function streamToPromise(stream: " }, { "kind": "Reference", "text": "Stream", "canonicalReference": "ibm-cloud-sdk-core!~Stream" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/stream-to-promise.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "stream", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "streamToPromise" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!stripTrailingSlash:function(1)", "docComment": "/**\n * Strips trailing slashes from \"url\", if present.\n *\n * @param url - the url string\n *\n * @returns the url with any trailing slashes removed\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function stripTrailingSlash(url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "url", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "stripTrailingSlash" }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!TokenManager:class", "docComment": "/**\n * A class for shared functionality for storing, and requesting tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement \"requestToken()\" to retrieve the token from intended sources and \"saveTokenInfo(tokenResponse)\" to parse and save token information from the response.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class TokenManager " } ], "fileUrlPath": "dist/es/auth/token-managers/token-manager.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "TokenManager", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!TokenManager:constructor(1)", "docComment": "/**\n * Create a new TokenManager instance.\n *\n * @param options - Configuration options. This should be an object containing these fields: - 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\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "TokenManagerOptions", "canonicalReference": "ibm-cloud-sdk-core!TokenManagerOptions:type" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#accessToken:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected accessToken: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "accessToken", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#disableSslVerification:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected disableSslVerification: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "disableSslVerification", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#expireTime:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected expireTime: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "expireTime", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#getToken:member(1)", "docComment": "/**\n * Retrieves a new token using \"requestToken()\" if there is not a currently stored token from a previous call, or the previous token has expired.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getToken(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "getToken" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#headers:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected headers: " }, { "kind": "Reference", "text": "OutgoingHttpHeaders", "canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "headers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#isTokenExpired:member(1)", "docComment": "/**\n * Checks if currently-stored token is expired\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected isTokenExpired(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isTokenExpired" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#pacedRequestToken:member(1)", "docComment": "/**\n * Paces requests to requestToken().\n *\n * This method pseudo-serializes requests for an access_token when the current token is undefined or expired. The first caller to this method records its `requestTime` and then issues the token request. Subsequent callers will check the `requestTime` to see if a request is active (has been issued within the past 60 seconds), and if so will queue their promise for the active requestor to resolve when that request completes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected pacedRequestToken(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "pacedRequestToken" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#refreshTime:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected refreshTime: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "refreshTime", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#requestToken:member(1)", "docComment": "/**\n * Request a token using an API endpoint.\n *\n * @returns Promise\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected requestToken(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "requestToken" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#requestWrapperInstance:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requestWrapperInstance: " }, { "kind": "Reference", "text": "RequestWrapper", "canonicalReference": "ibm-cloud-sdk-core!~RequestWrapper:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "requestWrapperInstance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#saveTokenInfo:member(1)", "docComment": "/**\n * Parse and save token information from the response. Save the requested token into field `accessToken`. Calculate expiration and refresh time from the received info and store them in fields `expireTime` and `refreshTime`.\n *\n * @param tokenResponse - the response object from a token service request\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected saveTokenInfo(tokenResponse: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [ { "parameterName": "tokenResponse", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "saveTokenInfo" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#setDisableSslVerification:member(1)", "docComment": "/**\n * Sets the \"disableSslVerification\" property.\n *\n * @param value - the new value for the disableSslVerification property\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDisableSslVerification(value: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setDisableSslVerification" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#setHeaders:member(1)", "docComment": "/**\n * Sets the headers to be included with each outbound request to the token server.\n *\n * @param headers - the set of headers to send with each request to the token server\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setHeaders(headers: " }, { "kind": "Reference", "text": "OutgoingHttpHeaders", "canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "headers", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setHeaders" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#url:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected url: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!TokenManager#userAgent:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected userAgent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "userAgent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "ibm-cloud-sdk-core!TokenManagerOptions:type", "docComment": "/**\n * Configuration options for token retrieval.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TokenManagerOptions = " }, { "kind": "Content", "text": "{\n url?: string;\n headers?: " }, { "kind": "Reference", "text": "OutgoingHttpHeaders", "canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface" }, { "kind": "Content", "text": ";\n disableSslVerification?: boolean;\n [propName: string]: any;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/token-managers/token-manager.d.ts", "releaseTag": "Public", "name": "TokenManagerOptions", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator:class", "docComment": "/**\n * Class for common functionality shared by token-request authenticators. TokenRequestBasedAuthenticators use token managers to retrieve, store, and refresh tokens. Not intended to be used as stand-alone authenticator, but as base class to authenticators that have their own token manager implementations.\n *\n * The token will be added as an Authorization header in the form:\n *\n * Authorization: Bearer \\\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class TokenRequestBasedAuthenticator extends " }, { "kind": "Reference", "text": "TokenRequestBasedAuthenticatorImmutable", "canonicalReference": "ibm-cloud-sdk-core!~TokenRequestBasedAuthenticatorImmutable:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/authenticators/token-request-based-authenticator.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "TokenRequestBasedAuthenticator", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator#setDisableSslVerification:member(1)", "docComment": "/**\n * Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not.\n *\n * @param value - a flag that indicates whether verification of the token server's SSL certificate should be disabled or not.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDisableSslVerification(value: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setDisableSslVerification" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator#setHeaders:member(1)", "docComment": "/**\n * Set headers.\n *\n * @param headers - a set of HTTP headers to be sent with each outbound token server request. Overwrites previous default headers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setHeaders(headers: " }, { "kind": "Reference", "text": "OutgoingHttpHeaders", "canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "headers", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setHeaders" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!toLowerKeys:function(1)", "docComment": "/**\n * This function converts an object's keys to lower case. note: does not convert nested keys\n *\n * @param obj - The object to convert the keys of.\n *\n * @returns the object with keys folded to lowercase\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function toLowerKeys(obj: " }, { "kind": "Reference", "text": "Object", "canonicalReference": "!Object:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Object", "canonicalReference": "!Object:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "obj", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "toLowerKeys" }, { "kind": "Interface", "canonicalReference": "ibm-cloud-sdk-core!UserOptions:interface", "docComment": "/**\n * Configuration values for a service.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface UserOptions " } ], "fileUrlPath": "dist/es/lib/base-service.d.ts", "releaseTag": "Public", "name": "UserOptions", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "ibm-cloud-sdk-core!UserOptions:index(1)", "docComment": "/**\n * Allow additional request config parameters\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[propName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "propName", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!UserOptions#authenticator:member", "docComment": "/**\n * The Authenticator object used to authenticate requests to the service\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticator?: " }, { "kind": "Reference", "text": "AuthenticatorInterface", "canonicalReference": "ibm-cloud-sdk-core!AuthenticatorInterface:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "authenticator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!UserOptions#disableSslVerification:member", "docComment": "/**\n * Set to `true` to allow unauthorized requests - not recommended for production use.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disableSslVerification?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "disableSslVerification", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!UserOptions#headers:member", "docComment": "/**\n * Default headers that shall be included with every request to the service.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "headers?: " }, { "kind": "Reference", "text": "OutgoingHttpHeaders", "canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "headers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!UserOptions#jar:member", "docComment": "/**\n * Set your own cookie jar object\n */\n", "excerptTokens": [ { "kind": "Content", "text": "jar?: " }, { "kind": "Reference", "text": "CookieJar", "canonicalReference": "@types/tough-cookie!CookieJar:class" }, { "kind": "Content", "text": " | boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "jar", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!UserOptions#serviceUrl:member", "docComment": "/**\n * The base url to use when contacting the service. The base url may differ between IBM Cloud regions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "serviceUrl?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "serviceUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!UserOptions#url:member", "docComment": "/**\n * Deprecated. Use `serviceUrl` instead.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "url?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "ibm-cloud-sdk-core!UserOptions#version:member", "docComment": "/**\n * The API version date to use with the service, in \"YYYY-MM-DD\" format.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "version?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "version", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!validateInput:function(1)", "docComment": "/**\n * Validates \"options\".\n *\n * @param options - a configuration options object\n *\n * @param requiredOptions - the list of properties that must be present in \"options\"\n *\n * @throws\n *\n * Error: \"options\" failed validation\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function validateInput(options: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ", requiredOptions: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/auth/utils/helpers.d.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "requiredOptions", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "name": "validateInput" }, { "kind": "Function", "canonicalReference": "ibm-cloud-sdk-core!validateParams:function(1)", "docComment": "/**\n * Validates that \"params\" contains a value for each key listed in \"requiredParams\", and that each key contained in \"params\" is a valid key listed in \"allParams\". In essence, we want params to contain only valid keys and we want params to contain at least the required keys.\n *\n * @param params - the \"params\" object passed into an operation containing method parameters.\n *\n * @param requiredParams - the names of required parameters. If null, then the \"required params\" check is bypassed.\n *\n * @param allParams - the names of all valid parameters. If null, then the \"valid params\" check is bypassed.\n *\n * @returns null if no errors found, otherwise an Error instance\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function validateParams(params: " }, { "kind": "Content", "text": "{\n [key: string]: any;\n}" }, { "kind": "Content", "text": ", requiredParams: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ", allParams: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "Error", "canonicalReference": "!Error:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "dist/es/lib/helper.d.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "params", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "requiredParams", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "allParams", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false } ], "name": "validateParams" }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceAuthenticator:class", "docComment": "/**\n * The VpcInstanceAuthenticator implements an authentication scheme in which it retrieves an \"instance identity token\" and exchanges that for an IAM access token using the VPC Instance Metadata Service API which is available on the local compute resource (VM). The instance identity token is similar to an IAM apikey, except that it is managed automatically by the compute resource provider (VPC).\n *\n * The resulting IAM access token is then added to outbound requests in an Authorization header\n *\n * Authorization: Bearer \\\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class VpcInstanceAuthenticator extends " }, { "kind": "Reference", "text": "TokenRequestBasedAuthenticator", "canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/authenticators/vpc-instance-authenticator.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "VpcInstanceAuthenticator", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceAuthenticator:constructor(1)", "docComment": "/**\n * Create a new VpcInstanceAuthenticator instance.\n *\n * @remarks\n *\n * At most one of \"iamProfileCrn\" or \"iamProfileId\" may be specified. If neither one is specified, then the default IAM profile defined for the compute resource will be used.\n *\n * @param options - Configuration options for VpcInstance authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the VPC Instance Metadata Service (default value: \"http://169.254.169.254\") - iamProfileCrn: (optional) the CRN of the linked IAM trusted profile to be used to obtain the IAM access token - iamProfileId: (optional) the ID of the linked IAM trusted profile to be used to obtain the IAM access token\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_10:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceAuthenticator#authenticationType:member(1)", "docComment": "/**\n * Returns the authenticator's type ('vpc').\n *\n * @returns a string that indicates the authenticator's type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "authenticationType(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "authenticationType" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceAuthenticator#setIamProfileCrn:member(1)", "docComment": "/**\n * Sets the \"iamProfileCrn\" value to be used when obtaining an IAM access token\n *\n * @param iamProfileCrn - the CRN of the linked IAM trusted profile to use when obtaining an IAM access token\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIamProfileCrn(iamProfileCrn: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "iamProfileCrn", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setIamProfileCrn" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceAuthenticator#setIamProfileId:member(1)", "docComment": "/**\n * Sets the \"iamProfileId\" value to be used when obtaining an IAM access token\n *\n * @param iamProfileId - the ID of the linked IAM trusted profile to use when obtaining an IAM access token\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIamProfileId(iamProfileId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "iamProfileId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setIamProfileId" }, { "kind": "Property", "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceAuthenticator#tokenManager:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected tokenManager: " }, { "kind": "Reference", "text": "VpcInstanceTokenManager", "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceTokenManager:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tokenManager", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceTokenManager:class", "docComment": "/**\n * Token Manager for VPC Instance Authentication.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class VpcInstanceTokenManager extends " }, { "kind": "Reference", "text": "JwtTokenManager", "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "dist/es/auth/token-managers/vpc-instance-token-manager.d.ts", "releaseTag": "Public", "isAbstract": false, "name": "VpcInstanceTokenManager", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceTokenManager:constructor(1)", "docComment": "/**\n * Create a new VpcInstanceTokenManager instance.\n *\n * @remarks\n *\n * At most one of \"iamProfileCrn\" or \"iamProfileId\" may be specified. If neither one is specified, then the default IAM profile defined for the compute resource will be used.\n *\n * @param options - Configuration options. This should be an object containing these fields: - url: (optional) the endpoint URL for the VPC Instance Metadata Service (default value: \"http://169.254.169.254\") - iamProfileCrn: (optional) the CRN of the linked IAM trusted profile to be used to obtain the IAM access token - iamProfileId: (optional) the ID of the linked IAM trusted profile to be used to obtain the IAM access token\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "ibm-cloud-sdk-core!~Options_9:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceTokenManager#isTokenExpired:member(1)", "docComment": "/**\n * Returns true iff the currently-cached IAM access token is expired. We'll consider an access token as expired when we reach its IAM server-reported expiration time minus our expiration window (10 secs). We do this to avoid using an access token that might expire in the middle of a long-running transaction within an IBM Cloud service.\n *\n * @returns true if the token has expired, false otherwise\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected isTokenExpired(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "isTokenExpired" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceTokenManager#requestToken:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected requestToken(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": true, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "requestToken" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceTokenManager#setIamProfileCrn:member(1)", "docComment": "/**\n * Sets the CRN of the IAM trusted profile to use when fetching the access token from the IAM token server.\n *\n * @param iamProfileCrn - the CRN of the IAM trusted profile\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIamProfileCrn(iamProfileCrn: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "iamProfileCrn", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setIamProfileCrn" }, { "kind": "Method", "canonicalReference": "ibm-cloud-sdk-core!VpcInstanceTokenManager#setIamProfileId:member(1)", "docComment": "/**\n * Sets the Id of the IAM trusted profile to use when fetching the access token from the IAM token server.\n *\n * @param iamProfileId - the ID of the IAM trusted profile\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setIamProfileId(iamProfileId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "iamProfileId", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setIamProfileId" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] } ] } ] }