432 lines
17 KiB
TypeScript
432 lines
17 KiB
TypeScript
 
|
/* tslint:disable */
|
||
|
|
/* eslint-disable */
|
||
|
|
/**
|
||
|
|
* Boundary controller HTTP API
|
||
|
|
* Welcome to the Boundary controller HTTP API documentation. This page provides a reference guide for using the Boundary controller API, a JSON-based HTTP API. The API implements commonly seen HTTP API patterns for status codes, paths, and errors. See the [API overview](https://developer.hashicorp.com/boundary/docs/api-clients/api) for more information. Before you read this page, it is useful to understand Boundary\'s [domain model](https://developer.hashicorp.com/boundary/docs/concepts/domain-model) and to be aware of the terminology used here. To get started, search for the service you want to interact with in the sidebar to the left. Each resource in Boundary, such as accounts and credential stores, has its own service. Each service contains all the API endpoints for the resource. ## Status codes - `2XX`: Boundary returns a code between `200` and `299` on success. Generally this is `200`, but implementations should be prepared to accept any `2XX` status code as indicating success. If a call returns a `2XX` code that is not `200`, it follows well-understood semantics for those status codes. - `400`: Boundary returns `400` when a command cannot be completed due to invalid user input, except for a properly-formatted identifier that does not map to an existing resource, which returns a `404` as discussed below. - `401`: Boundary returns `401` if no authentication token is provided or if the provided token is invalid. A valid token that simply does not have permission for a resource returns a `403` instead. A token that is invalid or missing, but where the anonymous user (`u_anon`) is able to successfully perform the action, will not return a `401` but instead will return the result of the action. - `403`: Boundary returns `403` if a provided token was valid but does not have the grants required to perform the requested action. - `404`: Boundary returns `404` if a resource cannot be found. Note that this happens _prior_ to authentication/authorization checking in nearly all cases as the resource information (such as its scope, available actions, etc.) is a required part of that check. As a result, an action against a resource that does not exist returns a `404` instead of a `401` or `403`. While this could be considered an information leak, since IDs are randomly generated and this only discloses whether an ID is valid, it\'s tolerable as it allows for far simpler and more robust client implementation. - `405`: Boundary returns a `405` to indicate that the method (HTTP verb or custom action) is not implemented for the given resource. - `429`: Boundary returns a `429` if any of the API rate limit quotas have been exhausted for the resource and action. It includes the `Retry-After` header so that the client knows how long to wait before making a new request. - `500`: Boundary returns `500` if an error occurred that is not (directly) tied to invalid user input. If a `500` is generated, information about the error is logged to Boundary\'s server log but is not generally provided to the client. - `503`: Boundary returns a `503` if it is unable to store a quota due to the API rate limit being exceeded. It includes the `Retry-After` header so that the client knows how long to wait before making a new request. ## List pagination Boundary uses [API pagination](https://developer.hashicorp.com/boundary/docs/api-clients/api/pagination) to support searching and filtering large lists of results efficiently.
|
||
|
|
*
|
||
|
|
* The version of the OpenAPI document: 0.19.0
|
||
|
|
*
|
||
|
|
*
|
||
|
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||
|
|
* https://openapi-generator.tech
|
||
|
|
* Do not edit the class manually.
|
||
|
|
*/
|
||
|
|
|
||
|
|
|
||
|
|
export const BASE_PATH = "https://your-boundary-hostname.com".replace(/\/+$/, "");
|
||
|
|
|
||
|
|
export interface ConfigurationParameters {
|
||
|
|
basePath?: string; // override base path
|
||
|
|
fetchApi?: FetchAPI; // override for fetch implementation
|
||
|
|
middleware?: Middleware[]; // middleware to apply before/after fetch requests
|
||
|
|
queryParamsStringify?: (params: HTTPQuery) => string; // stringify function for query strings
|
||
|
|
username?: string; // parameter for basic security
|
||
|
|
password?: string; // parameter for basic security
|
||
|
|
apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>); // parameter for apiKey security
|
||
|
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>); // parameter for oauth2 security
|
||
|
|
headers?: HTTPHeaders; //header params we want to use on every request
|
||
|
|
credentials?: RequestCredentials; //value for the credentials param we want to use on each request
|
||
|
|
}
|
||
|
|
|
||
|
|
export class Configuration {
|
||
|
|
constructor(private configuration: ConfigurationParameters = {}) {}
|
||
|
|
|
||
|
|
set config(configuration: Configuration) {
|
||
|
|
this.configuration = configuration;
|
||
|
|
}
|
||
|
|
|
||
|
|
get basePath(): string {
|
||
|
|
return this.configuration.basePath != null ? this.configuration.basePath : BASE_PATH;
|
||
|
|
}
|
||
|
|
|
||
|
|
get fetchApi(): FetchAPI | undefined {
|
||
|
|
return this.configuration.fetchApi;
|
||
|
|
}
|
||
|
|
|
||
|
|
get middleware(): Middleware[] {
|
||
|
|
return this.configuration.middleware || [];
|
||
|
|
}
|
||
|
|
|
||
|
|
get queryParamsStringify(): (params: HTTPQuery) => string {
|
||
|
|
return this.configuration.queryParamsStringify || querystring;
|
||
|
|
}
|
||
|
|
|
||
|
|
get username(): string | undefined {
|
||
|
|
return this.configuration.username;
|
||
|
|
}
|
||
|
|
|
||
|
|
get password(): string | undefined {
|
||
|
|
return this.configuration.password;
|
||
|
|
}
|
||
|
|
|
||
|
|
get apiKey(): ((name: string) => string | Promise<string>) | undefined {
|
||
|
|
const apiKey = this.configuration.apiKey;
|
||
|
|
if (apiKey) {
|
||
|
|
return typeof apiKey === 'function' ? apiKey : () => apiKey;
|
||
|
|
}
|
||
|
|
return undefined;
|
||
|
|
}
|
||
|
|
|
||
|
|
get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined {
|
||
|
|
const accessToken = this.configuration.accessToken;
|
||
|
|
if (accessToken) {
|
||
|
|
return typeof accessToken === 'function' ? accessToken : async () => accessToken;
|
||
|
|
}
|
||
|
|
return undefined;
|
||
|
|
}
|
||
|
|
|
||
|
|
get headers(): HTTPHeaders | undefined {
|
||
|
|
return this.configuration.headers;
|
||
|
|
}
|
||
|
|
|
||
|
|
get credentials(): RequestCredentials | undefined {
|
||
|
|
return this.configuration.credentials;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
export const DefaultConfig = new Configuration();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This is the base class for all generated API classes.
|
||
|
|
*/
|
||
|
|
export class BaseAPI {
|
||
|
|
|
||
|
|
private static readonly jsonRegex = new RegExp('^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$', 'i');
|
||
|
|
private middleware: Middleware[];
|
||
|
|
|
||
|
|
constructor(protected configuration = DefaultConfig) {
|
||
|
|
this.middleware = configuration.middleware;
|
||
|
|
}
|
||
|
|
|
||
|
|
withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]) {
|
||
|
|
const next = this.clone<T>();
|
||
|
|
next.middleware = next.middleware.concat(...middlewares);
|
||
|
|
return next;
|
||
|
|
}
|
||
|
|
|
||
|
|
withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>) {
|
||
|
|
const middlewares = preMiddlewares.map((pre) => ({ pre }));
|
||
|
|
return this.withMiddleware<T>(...middlewares);
|
||
|
|
}
|
||
|
|
|
||
|
|
withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>) {
|
||
|
|
const middlewares = postMiddlewares.map((post) => ({ post }));
|
||
|
|
return this.withMiddleware<T>(...middlewares);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check if the given MIME is a JSON MIME.
|
||
|
|
* JSON MIME examples:
|
||
|
|
* application/json
|
||
|
|
* application/json; charset=UTF8
|
||
|
|
* APPLICATION/JSON
|
||
|
|
* application/vnd.company+json
|
||
|
|
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
||
|
|
* @return True if the given MIME is JSON, false otherwise.
|
||
|
|
*/
|
||
|
|
protected isJsonMime(mime: string | null | undefined): boolean {
|
||
|
|
if (!mime) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
return BaseAPI.jsonRegex.test(mime);
|
||
|
|
}
|
||
|
|
|
||
|
|
protected async request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response> {
|
||
|
|
const { url, init } = await this.createFetchParams(context, initOverrides);
|
||
|
|
const response = await this.fetchApi(url, init);
|
||
|
|
if (response && (response.status >= 200 && response.status < 300)) {
|
||
|
|
return response;
|
||
|
|
}
|
||
|
|
throw new ResponseError(response, 'Response returned an error code');
|
||
|
|
}
|
||
|
|
|
||
|
|
private async createFetchParams(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction) {
|
||
|
|
let url = this.configuration.basePath + context.path;
|
||
|
|
if (context.query !== undefined && Object.keys(context.query).length !== 0) {
|
||
|
|
// only add the querystring to the URL if there are query parameters.
|
||
|
|
// this is done to avoid urls ending with a "?" character which buggy webservers
|
||
|
|
// do not handle correctly sometimes.
|
||
|
|
url += '?' + this.configuration.queryParamsStringify(context.query);
|
||
|
|
}
|
||
|
|
|
||
|
|
const headers = Object.assign({}, this.configuration.headers, context.headers);
|
||
|
|
Object.keys(headers).forEach(key => headers[key] === undefined ? delete headers[key] : {});
|
||
|
|
|
||
|
|
const initOverrideFn =
|
||
|
|
typeof initOverrides === "function"
|
||
|
|
? initOverrides
|
||
|
|
: async () => initOverrides;
|
||
|
|
|
||
|
|
const initParams = {
|
||
|
|
method: context.method,
|
||
|
|
headers,
|
||
|
|
body: context.body,
|
||
|
|
credentials: this.configuration.credentials,
|
||
|
|
};
|
||
|
|
|
||
|
|
const overriddenInit: RequestInit = {
|
||
|
|
...initParams,
|
||
|
|
...(await initOverrideFn({
|
||
|
|
init: initParams,
|
||
|
|
context,
|
||
|
|
}))
|
||
|
|
};
|
||
|
|
|
||
|
|
let body: any;
|
||
|
|
if (isFormData(overriddenInit.body)
|
||
|
|
|| (overriddenInit.body instanceof URLSearchParams)
|
||
|
|
|| isBlob(overriddenInit.body)) {
|
||
|
|
body = overriddenInit.body;
|
||
|
|
} else if (this.isJsonMime(headers['Content-Type'])) {
|
||
|
|
body = JSON.stringify(overriddenInit.body);
|
||
|
|
} else {
|
||
|
|
body = overriddenInit.body;
|
||
|
|
}
|
||
|
|
|
||
|
|
const init: RequestInit = {
|
||
|
|
...overriddenInit,
|
||
|
|
body
|
||
|
|
};
|
||
|
|
|
||
|
|
return { url, init };
|
||
|
|
}
|
||
|
|
|
||
|
|
private fetchApi = async (url: string, init: RequestInit) => {
|
||
|
|
let fetchParams = { url, init };
|
||
|
|
for (const middleware of this.middleware) {
|
||
|
|
if (middleware.pre) {
|
||
|
|
fetchParams = await middleware.pre({
|
||
|
|
fetch: this.fetchApi,
|
||
|
|
...fetchParams,
|
||
|
|
}) || fetchParams;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
let response: Response | undefined = undefined;
|
||
|
|
try {
|
||
|
|
response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
|
||
|
|
} catch (e) {
|
||
|
|
for (const middleware of this.middleware) {
|
||
|
|
if (middleware.onError) {
|
||
|
|
response = await middleware.onError({
|
||
|
|
fetch: this.fetchApi,
|
||
|
|
url: fetchParams.url,
|
||
|
|
init: fetchParams.init,
|
||
|
|
error: e,
|
||
|
|
response: response ? response.clone() : undefined,
|
||
|
|
}) || response;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if (response === undefined) {
|
||
|
|
if (e instanceof Error) {
|
||
|
|
throw new FetchError(e, 'The request failed and the interceptors did not return an alternative response');
|
||
|
|
} else {
|
||
|
|
throw e;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
for (const middleware of this.middleware) {
|
||
|
|
if (middleware.post) {
|
||
|
|
response = await middleware.post({
|
||
|
|
fetch: this.fetchApi,
|
||
|
|
url: fetchParams.url,
|
||
|
|
init: fetchParams.init,
|
||
|
|
response: response.clone(),
|
||
|
|
}) || response;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return response;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Create a shallow clone of `this` by constructing a new instance
|
||
|
|
* and then shallow cloning data members.
|
||
|
|
*/
|
||
|
|
private clone<T extends BaseAPI>(this: T): T {
|
||
|
|
const constructor = this.constructor as any;
|
||
|
|
const next = new constructor(this.configuration);
|
||
|
|
next.middleware = this.middleware.slice();
|
||
|
|
return next;
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
function isBlob(value: any): value is Blob {
|
||
|
|
return typeof Blob !== 'undefined' && value instanceof Blob;
|
||
|
|
}
|
||
|
|
|
||
|
|
function isFormData(value: any): value is FormData {
|
||
|
|
return typeof FormData !== "undefined" && value instanceof FormData;
|
||
|
|
}
|
||
|
|
|
||
|
|
export class ResponseError extends Error {
|
||
|
|
override name: "ResponseError" = "ResponseError";
|
||
|
|
constructor(public response: Response, msg?: string) {
|
||
|
|
super(msg);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
export class FetchError extends Error {
|
||
|
|
override name: "FetchError" = "FetchError";
|
||
|
|
constructor(public cause: Error, msg?: string) {
|
||
|
|
super(msg);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
export class RequiredError extends Error {
|
||
|
|
override name: "RequiredError" = "RequiredError";
|
||
|
|
constructor(public field: string, msg?: string) {
|
||
|
|
super(msg);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
export const COLLECTION_FORMATS = {
|
||
|
|
csv: ",",
|
||
|
|
ssv: " ",
|
||
|
|
tsv: "\t",
|
||
|
|
pipes: "|",
|
||
|
|
};
|
||
|
|
|
||
|
|
export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
|
||
|
|
|
||
|
|
export type Json = any;
|
||
|
|
export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
|
||
|
|
export type HTTPHeaders = { [key: string]: string };
|
||
|
|
export type HTTPQuery = { [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery };
|
||
|
|
export type HTTPBody = Json | FormData | URLSearchParams;
|
||
|
|
export type HTTPRequestInit = { headers?: HTTPHeaders; method: HTTPMethod; credentials?: RequestCredentials; body?: HTTPBody };
|
||
|
|
export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
|
||
|
|
|
||
|
|
export type InitOverrideFunction = (requestContext: { init: HTTPRequestInit, context: RequestOpts }) => Promise<RequestInit>
|
||
|
|
|
||
|
|
export interface FetchParams {
|
||
|
|
url: string;
|
||
|
|
init: RequestInit;
|
||
|
|
}
|
||
|
|
|
||
|
|
export interface RequestOpts {
|
||
|
|
path: string;
|
||
|
|
method: HTTPMethod;
|
||
|
|
headers: HTTPHeaders;
|
||
|
|
query?: HTTPQuery;
|
||
|
|
body?: HTTPBody;
|
||
|
|
}
|
||
|
|
|
||
|
|
export function querystring(params: HTTPQuery, prefix: string = ''): string {
|
||
|
|
return Object.keys(params)
|
||
|
|
.map(key => querystringSingleKey(key, params[key], prefix))
|
||
|
|
.filter(part => part.length > 0)
|
||
|
|
.join('&');
|
||
|
|
}
|
||
|
|
|
||
|
|
function querystringSingleKey(key: string, value: string | number | null | undefined | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery, keyPrefix: string = ''): string {
|
||
|
|
const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
|
||
|
|
if (value instanceof Array) {
|
||
|
|
const multiValue = value.map(singleValue => encodeURIComponent(String(singleValue)))
|
||
|
|
.join(`&${encodeURIComponent(fullKey)}=`);
|
||
|
|
return `${encodeURIComponent(fullKey)}=${multiValue}`;
|
||
|
|
}
|
||
|
|
if (value instanceof Set) {
|
||
|
|
const valueAsArray = Array.from(value);
|
||
|
|
return querystringSingleKey(key, valueAsArray, keyPrefix);
|
||
|
|
}
|
||
|
|
if (value instanceof Date) {
|
||
|
|
return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
|
||
|
|
}
|
||
|
|
if (value instanceof Object) {
|
||
|
|
return querystring(value as HTTPQuery, fullKey);
|
||
|
|
}
|
||
|
|
return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
|
||
|
|
}
|
||
|
|
|
||
|
|
export function exists(json: any, key: string) {
|
||
|
|
const value = json[key];
|
||
|
|
return value !== null && value !== undefined;
|
||
|
|
}
|
||
|
|
|
||
|
|
export function mapValues(data: any, fn: (item: any) => any) {
|
||
|
|
const result: { [key: string]: any } = {};
|
||
|
|
for (const key of Object.keys(data)) {
|
||
|
|
result[key] = fn(data[key]);
|
||
|
|
}
|
||
|
|
return result;
|
||
|
|
}
|
||
|
|
|
||
|
|
export function canConsumeForm(consumes: Consume[]): boolean {
|
||
|
|
for (const consume of consumes) {
|
||
|
|
if ('multipart/form-data' === consume.contentType) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
export interface Consume {
|
||
|
|
contentType: string;
|
||
|
|
}
|
||
|
|
|
||
|
|
export interface RequestContext {
|
||
|
|
fetch: FetchAPI;
|
||
|
|
url: string;
|
||
|
|
init: RequestInit;
|
||
|
|
}
|
||
|
|
|
||
|
|
export interface ResponseContext {
|
||
|
|
fetch: FetchAPI;
|
||
|
|
url: string;
|
||
|
|
init: RequestInit;
|
||
|
|
response: Response;
|
||
|
|
}
|
||
|
|
|
||
|
|
export interface ErrorContext {
|
||
|
|
fetch: FetchAPI;
|
||
|
|
url: string;
|
||
|
|
init: RequestInit;
|
||
|
|
error: unknown;
|
||
|
|
response?: Response;
|
||
|
|
}
|
||
|
|
|
||
|
|
export interface Middleware {
|
||
|
|
pre?(context: RequestContext): Promise<FetchParams | void>;
|
||
|
|
post?(context: ResponseContext): Promise<Response | void>;
|
||
|
|
onError?(context: ErrorContext): Promise<Response | void>;
|
||
|
|
}
|
||
|
|
|
||
|
|
export interface ApiResponse<T> {
|
||
|
|
raw: Response;
|
||
|
|
value(): Promise<T>;
|
||
|
|
}
|
||
|
|
|
||
|
|
export interface ResponseTransformer<T> {
|
||
|
|
(json: any): T;
|
||
|
|
}
|
||
|
|
|
||
|
|
export class JSONApiResponse<T> {
|
||
|
|
constructor(public raw: Response, private transformer: ResponseTransformer<T> = (jsonValue: any) => jsonValue) {}
|
||
|
|
|
||
|
|
async value(): Promise<T> {
|
||
|
|
return this.transformer(await this.raw.json());
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
export class VoidApiResponse {
|
||
|
|
constructor(public raw: Response) {}
|
||
|
|
|
||
|
|
async value(): Promise<void> {
|
||
|
|
return undefined;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
export class BlobApiResponse {
|
||
|
|
constructor(public raw: Response) {}
|
||
|
|
|
||
|
|
async value(): Promise<Blob> {
|
||
|
|
return await this.raw.blob();
|
||
|
|
};
|
||
|
|
}
|
||
|
|
|
||
|
|
export class TextApiResponse {
|
||
|
|
constructor(public raw: Response) {}
|
||
|
|
|
||
|
|
async value(): Promise<string> {
|
||
|
|
return await this.raw.text();
|
||
|
|
};
|
||
|
|
}
|