@sap-cloud-sdk/connectivity/dist/scp-cf/destination/ias-types.d.ts

SAP Cloud SDK for JavaScript connectivity

import type { Xor } from '@sap-cloud-sdk/util';
import type { AuthenticationType } from './destination-service-types';
import type { IdentityService } from '@sap/xssec';
import type { CachingOptions } from '../cache';
import type { JwtPayload } from '../jsonwebtoken-type';
/**
 * The application resource for which the token is requested for App-to-App communication.
 * The token will only be usable to call the requested application.
 * Either provide the app name (common case) or the provider client ID
 * and tenant ID.
 */
export type IasResource = Xor<{
    /**
     * The name of the application resource.
     */
    name: string;
}, {
    /**
     * The client ID of the application resource.
     */
    providerClientId: string;
    /**
     * The tenant ID of the application resource.
     */
    providerTenantId?: string;
}>;
/**
 * Base options shared by all IAS authentication modes.
 */
export interface IasOptionsBase {
    /**
     * The target URL of the destination that the IAS token is requested for.
     * It is recommended to provide this for App-to-App communication (when resource parameter is used),
     * otherwise the destination will point to the identity service URL from the service binding.
     * @default The (identity service) URL from the service binding.
     */
    targetUrl?: string;
    /**
     * The application resource(s) for which the token is requested.
     * The token will only be usable to call the requested application(s).
     * Either provide the app name (common case) or the provider client ID
     * and tenant ID.
     *
     * It is recommended to also provide the `targetUrl` parameter, otherwise
     * the destination will point to the identity service URL from the service binding,
     * instead of the actual target application.
     */
    resource?: IasResource;
    /**
     * The consumer (BTP) tenant ID of the application.
     * May be required for multi-tenant communication.
     */
    appTid?: string;
    /**
     * Additional parameters for the token request to be forwarded to the token fetching function
     * of `@sap/xssec`.
     */
    extraParams?: Omit<IdentityService.TokenFetchOptions & IdentityService.IdentityServiceTokenFetchOptions, 'token_format' | 'resource' | 'app_tid'>;
}
/**
 * IAS options for technical user authentication (client credentials).
 */
export interface IasOptionsTechnicalUser extends IasOptionsBase {
    /**
     * Authentication type. Use 'OAuth2ClientCredentials' for technical users.
     * @defaultValue 'OAuth2ClientCredentials'
     */
    authenticationType?: Extract<AuthenticationType, 'OAuth2ClientCredentials'>;
    /**
     * Assertion not used for technical user authentication.
     */
    assertion?: never;
    /**
     * Specifies whether the token request is made in the context of the current tenant or the provider tenant.
     * @defaultValue 'current-tenant'
     */
    requestAs?: 'current-tenant' | 'provider-tenant';
}
/**
 * IAS options for business user authentication (JWT bearer).
 */
export interface IasOptionsBusinessUser extends IasOptionsBase {
    /**
     * Authentication type. Use 'OAuth2JWTBearer' for business user authentication.
     */
    authenticationType: Extract<AuthenticationType, 'OAuth2JWTBearer'>;
    /**
     * The JWT assertion string to use for business user authentication.
     */
    assertion: string;
}
/**
 * Options for IAS token retrieval with type-safe authentication type/assertion relationship.
 */
export type IasOptions = IasOptionsTechnicalUser | IasOptionsBusinessUser;
/**
 * Options for fetching an IAS token via {@link getIasToken}.
 */
export type IasTokenOptions = IasOptions & CachingOptions & {
    /**
     * JWT for tenant context resolution.
     * For technical user flows (OAuth2ClientCredentials), this JWT's `app_tid` claim
     * is used to determine the current tenant when `requestAs` is 'current-tenant' (default).
     * Not needed for business user flows (OAuth2JWTBearer) where the assertion provides context.
     */
    jwt?: JwtPayload;
};
/**
 * Result of an IAS token request via {@link getIasToken}.
 * Contains the access token expiration information, and an optional refresh token (available for JWT bearer flows).
 */
export interface IasTokenResult {
    /**
     * The IAS access token as a string.
     */
    token: string;
    /**
     * The refresh token, if returned by the token endpoint.
     * Only sometimes available for JWT bearer (`OAuth2JWTBearer`) flows.
     * Fetching refresh tokens is disabled in most cases by the SAP Cloud SDK.
     */
    refreshToken?: string;
    /**
     * The number of seconds until the access token expires, as returned by the token endpoint.
     */
    expiresIn: number;
}