Add api client for playwright e2e tests (#2901)
* chore: 🤖 add @openapitools/openapi-generator-cli * chore: 🤖 Add @nestjs/core and @openapitools/openapi-generator-cli to ignoredBuiltDependencies These packages use postinstall for a opencollective notice * chore: 🤖 add package.json scripts for open-api client gen * chore: 🤖 add openapi generated files * chore: 🤖 add boundary api client fixture * chore: 🤖 incorporate api client fixture with base fixture * chore: 🤖 migrate existing test to use boundary api fixture * refactor: 💡 remove org cleanup from test * refactor: 💡 update sorting e2e test to use api client * refactor: 💡 clean up api client resource clean up logging * docs: ✏️ update jsdoc links for domain clients * chore: 🤖 avoid adding copywright headers to generated api * Add missing copyright headers * chore: 🤖 remove fetch argument from api client class The hope was to use request.fetch but playwright's fetch is a non-standard fetch which causes the generated api client to fail when using .clone() on the response * chore: 🤖 add optional OPENAPI_SWAGGER_URL_OR_FILE for openapi-client generation The OPENAPI_SWAGGER_URL_OR_FILE env var can be used to specify the -i flag the generate:api-client script with either: * a relative path * an absolute path * a url like: https://raw.githubusercontent.com/hashicorp/boundary/refs/heads/main/internal/gen/controller.swagger.json * refactor: 💡 clean up and refactor boundary-api-client fixture * chore: 🤖 add extra doc links and delete methods * test: 💍 add test to ensure that api-client fixture works * test: 💍 update existing e2e test examples with api-client * docs: ✏️ add comment for api-client e2e test * docs: ✏️ add additional links to service docs for api clients * refactor: 💡 cleanup api-client and corresponding test * docs: ✏️ add api client fixture docs to e2e README * fix: 🐛 fix regex * remove unnecessary capture group * add "-" to regex to allow for url segments like "storage-buckets" in "/v1/storage-buckets" * docs: ✏️ comment potential edge case in e2e api client cleanup * docs: ✏️ fix comment typo Co-authored-by: Zhihe Li <zhihe.li@hashicorp.com> * docs: ✏️ remove auth flag for generating e2e client * docs: ✏️ add mention that java is required for generate:api * chore: 🤖 implement pr feedback * chore: 🤖 Clean up api client and add more extensive test * chore: 🤖 fix casing in api-client test Co-authored-by: Zhihe Li <zhihe.li@hashicorp.com> --------- Co-authored-by: Zhihe Li <zhihe.li@hashicorp.com>
This commit is contained in:
hashiccandZhihe Li authored and 
GitHub committed
1 parent
5fd9f0216a
commit
b42ecbff36
262 files changed
+31646
-192
No files matched your search
@@ -0,0 +1,187 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesAccountsV1Account
|
||||
*/
|
||||
export interface ControllerApiResourcesAccountsV1Account {
|
||||
/**
|
||||
* The ID of the account.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAccountsV1Account
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesAccountsV1Account
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAccountsV1Account
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAccountsV1Account
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesAccountsV1Account
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesAccountsV1Account
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation fails if the version does not match the latest known good version.
|
||||
* Version is not required when you create an account.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesAccountsV1Account
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The type of this account. If you do not set an account type, Boundary infers it from the type of the auth method.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAccountsV1Account
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The ID of the auth method that is associated with this account.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAccountsV1Account
|
||||
*/
|
||||
authMethodId?: string;
|
||||
/**
|
||||
* The attributes that are applicable for the specific account type. The schema of this field depends on the type of the auth method that you create the account in.
|
||||
* For password auth methods, the parameters are:
|
||||
* ```json
|
||||
* {
|
||||
* "login_name": "login_name",
|
||||
* "password": "password"
|
||||
* }
|
||||
* ```
|
||||
* For OIDC auth methods, the parameters are:
|
||||
* ```json
|
||||
* {
|
||||
* "issuer": "issuer",
|
||||
* "subject": "subject",
|
||||
* "full_name": "full_name",
|
||||
* "email": "email",
|
||||
* "token_claims": {},
|
||||
* "userinfo_claims": {}
|
||||
* }
|
||||
* ```
|
||||
* For LDAP auth methods, the parameters are:
|
||||
* ```json
|
||||
* {
|
||||
* "login_name": "login_name",
|
||||
* "full_name": "full_name",
|
||||
* "email": "email",
|
||||
* "dn": "dn",
|
||||
* "member_of_groups": ["member_of_groups"]
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesAccountsV1Account
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
*
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesAccountsV1Account
|
||||
*/
|
||||
readonly managedGroupIds?: Array<string>;
|
||||
/**
|
||||
* The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesAccountsV1Account
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesAccountsV1Account interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesAccountsV1Account(value: object): value is ControllerApiResourcesAccountsV1Account {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAccountsV1AccountFromJSON(json: any): ControllerApiResourcesAccountsV1Account {
|
||||
return ControllerApiResourcesAccountsV1AccountFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAccountsV1AccountFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesAccountsV1Account {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'authMethodId': json['auth_method_id'] == null ? undefined : json['auth_method_id'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'managedGroupIds': json['managed_group_ids'] == null ? undefined : json['managed_group_ids'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAccountsV1AccountToJSON(json: any): ControllerApiResourcesAccountsV1Account {
|
||||
return ControllerApiResourcesAccountsV1AccountToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAccountsV1AccountToJSONTyped(value?: Omit<ControllerApiResourcesAccountsV1Account, 'id'|'created_time'|'updated_time'|'managed_group_ids'|'authorized_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
'type': value['type'],
|
||||
'auth_method_id': value['authMethodId'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,175 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesAliasesV1Alias
|
||||
*/
|
||||
export interface ControllerApiResourcesAliasesV1Alias {
|
||||
/**
|
||||
* The ID of the alias.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAliasesV1Alias
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The ID of the scope of which this alias is a part.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAliasesV1Alias
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesAliasesV1Alias
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Optional user-set name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAliasesV1Alias
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set descripton for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAliasesV1Alias
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesAliasesV1Alias
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesAliasesV1Alias
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation fails if the version does not match the latest known good version.
|
||||
* Version is not required when you create an alias.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesAliasesV1Alias
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* Value of the alias. This is the value referenced by the user that
|
||||
* is resolved to the destination id.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAliasesV1Alias
|
||||
*/
|
||||
value?: string;
|
||||
/**
|
||||
* destination_id is the id of the resource that this alias points to.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAliasesV1Alias
|
||||
*/
|
||||
destinationId?: string;
|
||||
/**
|
||||
* type is the type of the alias.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAliasesV1Alias
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The attributes that are applicable for the specific alias type. The schema of this field depends on the type of resource that you create the alias for.
|
||||
* For target aliases, the parameters are:
|
||||
* ```json
|
||||
* {
|
||||
* "authorize_session_arguments": {"host_id":"host_id"}
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesAliasesV1Alias
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesAliasesV1Alias
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesAliasesV1Alias interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesAliasesV1Alias(value: object): value is ControllerApiResourcesAliasesV1Alias {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAliasesV1AliasFromJSON(json: any): ControllerApiResourcesAliasesV1Alias {
|
||||
return ControllerApiResourcesAliasesV1AliasFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAliasesV1AliasFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesAliasesV1Alias {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'value': json['value'] == null ? undefined : json['value'],
|
||||
'destinationId': json['destination_id'] == null ? undefined : json['destination_id'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAliasesV1AliasToJSON(json: any): ControllerApiResourcesAliasesV1Alias {
|
||||
return ControllerApiResourcesAliasesV1AliasToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAliasesV1AliasToJSONTyped(value?: Omit<ControllerApiResourcesAliasesV1Alias, 'id'|'created_time'|'updated_time'|'authorized_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope_id': value['scopeId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
'value': value['value'],
|
||||
'destination_id': value['destinationId'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,218 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesAuthmethodsV1AuthMethod
|
||||
*/
|
||||
export interface ControllerApiResourcesAuthmethodsV1AuthMethod {
|
||||
/**
|
||||
* The ID of the auth method.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAuthmethodsV1AuthMethod
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The ID of the Scope of which this auth method is a part.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAuthmethodsV1AuthMethod
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesAuthmethodsV1AuthMethod
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAuthmethodsV1AuthMethod
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAuthmethodsV1AuthMethod
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesAuthmethodsV1AuthMethod
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesAuthmethodsV1AuthMethod
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* Version is not required when you create an auth method.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesAuthmethodsV1AuthMethod
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The auth method type.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAuthmethodsV1AuthMethod
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The attributes that are applicable for the specific auth method type. The schema of this field depends on the type of the auth method that you create want to create.
|
||||
* For password auth methods, the parameters are:
|
||||
* ```json
|
||||
* {
|
||||
* "min_login_name_length": "min_login_name_length",
|
||||
* "min_password_length": "min_password_length"
|
||||
* }
|
||||
* ```
|
||||
* For OIDC auth methods, the parameters are:
|
||||
* ```json
|
||||
* {
|
||||
* "issuer": "issuer",
|
||||
* "client_id": "client_id",
|
||||
* "client_secret": "client_secret",
|
||||
* "max_age": 3600,
|
||||
* "signing_algorithms": [],
|
||||
* "api_url_prefix": "api_url_prefix",
|
||||
* "idp_ca_certs": [],
|
||||
* "allowed_audiences": [],
|
||||
* "claims_scopes": [],
|
||||
* "account_claim_maps": [],
|
||||
* "disable_discovered_config_validation": false,
|
||||
* "prompts": []
|
||||
* }
|
||||
* ```
|
||||
* For LDAP auth methods, the parameters are:
|
||||
* ```json
|
||||
* {
|
||||
* "start_tls": false,
|
||||
* "insecure_tls": false,
|
||||
* "discover_dn": false,
|
||||
* "anon_group_search": false,
|
||||
* "upn_domain": "upn_domain",
|
||||
* "urls": [],
|
||||
* "user_dn": "user_dn",
|
||||
* "user_attr": "user_attr",
|
||||
* "user_filter": "user_filter",
|
||||
* "enable_groups": false,
|
||||
* "group_dn": "group_dn",
|
||||
* "group_attr": "group_attr",
|
||||
* "group_filter": "group_filter",
|
||||
* "certificates": [],
|
||||
* "client_certificate": "client_certificate",
|
||||
* "client_certificate_key": "client_certificate_key",
|
||||
* "bind_dn": "bind_dn",
|
||||
* "bind_password": "bind_password",
|
||||
* "use_token_groups": false,
|
||||
* "account_attribute_maps": [],
|
||||
* "maximum_page_size": 1000,
|
||||
* "dereference_aliases": "never"
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesAuthmethodsV1AuthMethod
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* Whether this auth method is the primary auth method for it's scope.
|
||||
* To change this value update the primary_auth_method_id field on the scope.
|
||||
* @type {boolean}
|
||||
* @memberof ControllerApiResourcesAuthmethodsV1AuthMethod
|
||||
*/
|
||||
readonly isPrimary?: boolean;
|
||||
/**
|
||||
* The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesAuthmethodsV1AuthMethod
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
/**
|
||||
* The authorized actions for the scope's collections.
|
||||
* @type {{ [key: string]: Array<object>; }}
|
||||
* @memberof ControllerApiResourcesAuthmethodsV1AuthMethod
|
||||
*/
|
||||
readonly authorizedCollectionActions?: { [key: string]: Array<object>; };
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesAuthmethodsV1AuthMethod interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesAuthmethodsV1AuthMethod(value: object): value is ControllerApiResourcesAuthmethodsV1AuthMethod {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAuthmethodsV1AuthMethodFromJSON(json: any): ControllerApiResourcesAuthmethodsV1AuthMethod {
|
||||
return ControllerApiResourcesAuthmethodsV1AuthMethodFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAuthmethodsV1AuthMethodFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesAuthmethodsV1AuthMethod {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'isPrimary': json['is_primary'] == null ? undefined : json['is_primary'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
'authorizedCollectionActions': json['authorized_collection_actions'] == null ? undefined : json['authorized_collection_actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAuthmethodsV1AuthMethodToJSON(json: any): ControllerApiResourcesAuthmethodsV1AuthMethod {
|
||||
return ControllerApiResourcesAuthmethodsV1AuthMethodToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAuthmethodsV1AuthMethodToJSONTyped(value?: Omit<ControllerApiResourcesAuthmethodsV1AuthMethod, 'id'|'created_time'|'updated_time'|'is_primary'|'authorized_actions'|'authorized_collection_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope_id': value['scopeId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,151 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesAuthtokensV1AuthToken
|
||||
*/
|
||||
export interface ControllerApiResourcesAuthtokensV1AuthToken {
|
||||
/**
|
||||
* Output only. The ID of the Auth Token.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAuthtokensV1AuthToken
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The Scope in which this Auth Token was generated.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAuthtokensV1AuthToken
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesAuthtokensV1AuthToken
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Output only. The token value, which will only be populated after authentication and is only ever visible to the end user whose login request resulted in this Auth Token being created.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAuthtokensV1AuthToken
|
||||
*/
|
||||
readonly token?: string;
|
||||
/**
|
||||
* Output only. The ID of the User associated with this Auth Token.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAuthtokensV1AuthToken
|
||||
*/
|
||||
readonly userId?: string;
|
||||
/**
|
||||
* Output only. The ID of the Auth Method associated with this Auth Token.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAuthtokensV1AuthToken
|
||||
*/
|
||||
readonly authMethodId?: string;
|
||||
/**
|
||||
* Output only. The ID of the Account associated with this Auth Token.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesAuthtokensV1AuthToken
|
||||
*/
|
||||
readonly accountId?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesAuthtokensV1AuthToken
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesAuthtokensV1AuthToken
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Output only. The approximate time this Auth Token was last used.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesAuthtokensV1AuthToken
|
||||
*/
|
||||
readonly approximateLastUsedTime?: Date;
|
||||
/**
|
||||
* Output only. The time this Auth Token expires.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesAuthtokensV1AuthToken
|
||||
*/
|
||||
readonly expirationTime?: Date;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesAuthtokensV1AuthToken
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesAuthtokensV1AuthToken interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesAuthtokensV1AuthToken(value: object): value is ControllerApiResourcesAuthtokensV1AuthToken {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAuthtokensV1AuthTokenFromJSON(json: any): ControllerApiResourcesAuthtokensV1AuthToken {
|
||||
return ControllerApiResourcesAuthtokensV1AuthTokenFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAuthtokensV1AuthTokenFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesAuthtokensV1AuthToken {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'token': json['token'] == null ? undefined : json['token'],
|
||||
'userId': json['user_id'] == null ? undefined : json['user_id'],
|
||||
'authMethodId': json['auth_method_id'] == null ? undefined : json['auth_method_id'],
|
||||
'accountId': json['account_id'] == null ? undefined : json['account_id'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'approximateLastUsedTime': json['approximate_last_used_time'] == null ? undefined : (new Date(json['approximate_last_used_time'])),
|
||||
'expirationTime': json['expiration_time'] == null ? undefined : (new Date(json['expiration_time'])),
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAuthtokensV1AuthTokenToJSON(json: any): ControllerApiResourcesAuthtokensV1AuthToken {
|
||||
return ControllerApiResourcesAuthtokensV1AuthTokenToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesAuthtokensV1AuthTokenToJSONTyped(value?: Omit<ControllerApiResourcesAuthtokensV1AuthToken, 'id'|'token'|'user_id'|'auth_method_id'|'account_id'|'created_time'|'updated_time'|'approximate_last_used_time'|'expiration_time'|'authorized_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope_id': value['scopeId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,78 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesBillingV1ActiveUsers
|
||||
*/
|
||||
export interface ControllerApiResourcesBillingV1ActiveUsers {
|
||||
/**
|
||||
* Output only. The number of active users between the start time and end time.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesBillingV1ActiveUsers
|
||||
*/
|
||||
readonly count?: number;
|
||||
/**
|
||||
* Output only. The start time of the active users count, inclusive.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesBillingV1ActiveUsers
|
||||
*/
|
||||
readonly startTime?: Date;
|
||||
/**
|
||||
* Output only. The end time of the active users count, exclusive.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesBillingV1ActiveUsers
|
||||
*/
|
||||
readonly endTime?: Date;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesBillingV1ActiveUsers interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesBillingV1ActiveUsers(value: object): value is ControllerApiResourcesBillingV1ActiveUsers {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesBillingV1ActiveUsersFromJSON(json: any): ControllerApiResourcesBillingV1ActiveUsers {
|
||||
return ControllerApiResourcesBillingV1ActiveUsersFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesBillingV1ActiveUsersFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesBillingV1ActiveUsers {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'count': json['count'] == null ? undefined : json['count'],
|
||||
'startTime': json['start_time'] == null ? undefined : (new Date(json['start_time'])),
|
||||
'endTime': json['end_time'] == null ? undefined : (new Date(json['end_time'])),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesBillingV1ActiveUsersToJSON(json: any): ControllerApiResourcesBillingV1ActiveUsers {
|
||||
return ControllerApiResourcesBillingV1ActiveUsersToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesBillingV1ActiveUsersToJSONTyped(value?: Omit<ControllerApiResourcesBillingV1ActiveUsers, 'count'|'start_time'|'end_time'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
};
|
||||
}
|
||||
|
||||
+166
@@ -0,0 +1,166 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesCredentiallibrariesV1CredentialLibrary
|
||||
*/
|
||||
export interface ControllerApiResourcesCredentiallibrariesV1CredentialLibrary {
|
||||
/**
|
||||
* Output only. The ID of the Credential Library.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentiallibrariesV1CredentialLibrary
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The ID of the Credential Store of which this Credential Library is a part.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentiallibrariesV1CredentialLibrary
|
||||
*/
|
||||
credentialStoreId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesCredentiallibrariesV1CredentialLibrary
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentiallibrariesV1CredentialLibrary
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentiallibrariesV1CredentialLibrary
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesCredentiallibrariesV1CredentialLibrary
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesCredentiallibrariesV1CredentialLibrary
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesCredentiallibrariesV1CredentialLibrary
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The Credential Library type.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentiallibrariesV1CredentialLibrary
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The attributes that are applicable for the specific Credential Library type.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesCredentiallibrariesV1CredentialLibrary
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesCredentiallibrariesV1CredentialLibrary
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentiallibrariesV1CredentialLibrary
|
||||
*/
|
||||
credentialType?: string;
|
||||
/**
|
||||
*
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesCredentiallibrariesV1CredentialLibrary
|
||||
*/
|
||||
credentialMappingOverrides?: object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesCredentiallibrariesV1CredentialLibrary interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesCredentiallibrariesV1CredentialLibrary(value: object): value is ControllerApiResourcesCredentiallibrariesV1CredentialLibrary {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesCredentiallibrariesV1CredentialLibraryFromJSON(json: any): ControllerApiResourcesCredentiallibrariesV1CredentialLibrary {
|
||||
return ControllerApiResourcesCredentiallibrariesV1CredentialLibraryFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesCredentiallibrariesV1CredentialLibraryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesCredentiallibrariesV1CredentialLibrary {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'credentialStoreId': json['credential_store_id'] == null ? undefined : json['credential_store_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
'credentialType': json['credential_type'] == null ? undefined : json['credential_type'],
|
||||
'credentialMappingOverrides': json['credential_mapping_overrides'] == null ? undefined : json['credential_mapping_overrides'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesCredentiallibrariesV1CredentialLibraryToJSON(json: any): ControllerApiResourcesCredentiallibrariesV1CredentialLibrary {
|
||||
return ControllerApiResourcesCredentiallibrariesV1CredentialLibraryToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesCredentiallibrariesV1CredentialLibraryToJSONTyped(value?: Omit<ControllerApiResourcesCredentiallibrariesV1CredentialLibrary, 'id'|'created_time'|'updated_time'|'authorized_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'credential_store_id': value['credentialStoreId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
'credential_type': value['credentialType'],
|
||||
'credential_mapping_overrides': value['credentialMappingOverrides'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,150 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesCredentialsV1Credential
|
||||
*/
|
||||
export interface ControllerApiResourcesCredentialsV1Credential {
|
||||
/**
|
||||
* Output only. The ID of the Credential.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentialsV1Credential
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The ID of the Credential Store of which this Credential is a part.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentialsV1Credential
|
||||
*/
|
||||
credentialStoreId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesCredentialsV1Credential
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentialsV1Credential
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentialsV1Credential
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesCredentialsV1Credential
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesCredentialsV1Credential
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesCredentialsV1Credential
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The Credential type.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentialsV1Credential
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The attributes that are applicable for the specific Credential type.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesCredentialsV1Credential
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesCredentialsV1Credential
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesCredentialsV1Credential interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesCredentialsV1Credential(value: object): value is ControllerApiResourcesCredentialsV1Credential {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesCredentialsV1CredentialFromJSON(json: any): ControllerApiResourcesCredentialsV1Credential {
|
||||
return ControllerApiResourcesCredentialsV1CredentialFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesCredentialsV1CredentialFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesCredentialsV1Credential {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'credentialStoreId': json['credential_store_id'] == null ? undefined : json['credential_store_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesCredentialsV1CredentialToJSON(json: any): ControllerApiResourcesCredentialsV1Credential {
|
||||
return ControllerApiResourcesCredentialsV1CredentialToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesCredentialsV1CredentialToJSONTyped(value?: Omit<ControllerApiResourcesCredentialsV1Credential, 'id'|'created_time'|'updated_time'|'authorized_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'credential_store_id': value['credentialStoreId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
+157
@@ -0,0 +1,157 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesCredentialstoresV1CredentialStore
|
||||
*/
|
||||
export interface ControllerApiResourcesCredentialstoresV1CredentialStore {
|
||||
/**
|
||||
* Output only. The ID of the Credential Store.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentialstoresV1CredentialStore
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The ID of the Scope of which this Credential Store is a part.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentialstoresV1CredentialStore
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesCredentialstoresV1CredentialStore
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentialstoresV1CredentialStore
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentialstoresV1CredentialStore
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesCredentialstoresV1CredentialStore
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesCredentialstoresV1CredentialStore
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesCredentialstoresV1CredentialStore
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The Credential Store type.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesCredentialstoresV1CredentialStore
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The attributes that are applicable for the specific Credential Store type.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesCredentialstoresV1CredentialStore
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesCredentialstoresV1CredentialStore
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
/**
|
||||
* Output only. The authorized actions for the scope's collections.
|
||||
* @type {{ [key: string]: Array<object>; }}
|
||||
* @memberof ControllerApiResourcesCredentialstoresV1CredentialStore
|
||||
*/
|
||||
readonly authorizedCollectionActions?: { [key: string]: Array<object>; };
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesCredentialstoresV1CredentialStore interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesCredentialstoresV1CredentialStore(value: object): value is ControllerApiResourcesCredentialstoresV1CredentialStore {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesCredentialstoresV1CredentialStoreFromJSON(json: any): ControllerApiResourcesCredentialstoresV1CredentialStore {
|
||||
return ControllerApiResourcesCredentialstoresV1CredentialStoreFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesCredentialstoresV1CredentialStoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesCredentialstoresV1CredentialStore {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
'authorizedCollectionActions': json['authorized_collection_actions'] == null ? undefined : json['authorized_collection_actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesCredentialstoresV1CredentialStoreToJSON(json: any): ControllerApiResourcesCredentialstoresV1CredentialStore {
|
||||
return ControllerApiResourcesCredentialstoresV1CredentialStoreToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesCredentialstoresV1CredentialStoreToJSONTyped(value?: Omit<ControllerApiResourcesCredentialstoresV1CredentialStore, 'id'|'created_time'|'updated_time'|'authorized_actions'|'authorized_collection_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope_id': value['scopeId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,155 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import type { ControllerApiResourcesGroupsV1Member } from './ControllerApiResourcesGroupsV1Member';
|
||||
import {
|
||||
ControllerApiResourcesGroupsV1MemberFromJSON,
|
||||
ControllerApiResourcesGroupsV1MemberFromJSONTyped,
|
||||
ControllerApiResourcesGroupsV1MemberToJSON,
|
||||
ControllerApiResourcesGroupsV1MemberToJSONTyped,
|
||||
} from './ControllerApiResourcesGroupsV1Member';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesGroupsV1Group
|
||||
*/
|
||||
export interface ControllerApiResourcesGroupsV1Group {
|
||||
/**
|
||||
* Output only. The ID of the Group.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesGroupsV1Group
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The ID of the scope of which this Group is a part.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesGroupsV1Group
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesGroupsV1Group
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesGroupsV1Group
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set descripton for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesGroupsV1Group
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesGroupsV1Group
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesGroupsV1Group
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesGroupsV1Group
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* Output only. Contains the list of member IDs in this Group.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesGroupsV1Group
|
||||
*/
|
||||
readonly memberIds?: Array<string>;
|
||||
/**
|
||||
* Output only. The members of this Group.
|
||||
* @type {Array<ControllerApiResourcesGroupsV1Member>}
|
||||
* @memberof ControllerApiResourcesGroupsV1Group
|
||||
*/
|
||||
readonly members?: Array<ControllerApiResourcesGroupsV1Member>;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesGroupsV1Group
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesGroupsV1Group interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesGroupsV1Group(value: object): value is ControllerApiResourcesGroupsV1Group {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesGroupsV1GroupFromJSON(json: any): ControllerApiResourcesGroupsV1Group {
|
||||
return ControllerApiResourcesGroupsV1GroupFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesGroupsV1GroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesGroupsV1Group {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'memberIds': json['member_ids'] == null ? undefined : json['member_ids'],
|
||||
'members': json['members'] == null ? undefined : ((json['members'] as Array<any>).map(ControllerApiResourcesGroupsV1MemberFromJSON)),
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesGroupsV1GroupToJSON(json: any): ControllerApiResourcesGroupsV1Group {
|
||||
return ControllerApiResourcesGroupsV1GroupToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesGroupsV1GroupToJSONTyped(value?: Omit<ControllerApiResourcesGroupsV1Group, 'id'|'created_time'|'updated_time'|'member_ids'|'members'|'authorized_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope_id': value['scopeId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesGroupsV1Member
|
||||
*/
|
||||
export interface ControllerApiResourcesGroupsV1Member {
|
||||
/**
|
||||
* Output only. The ID of the member.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesGroupsV1Member
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* Output only. The Scope ID of the member.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesGroupsV1Member
|
||||
*/
|
||||
readonly scopeId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesGroupsV1Member interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesGroupsV1Member(value: object): value is ControllerApiResourcesGroupsV1Member {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesGroupsV1MemberFromJSON(json: any): ControllerApiResourcesGroupsV1Member {
|
||||
return ControllerApiResourcesGroupsV1MemberFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesGroupsV1MemberFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesGroupsV1Member {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesGroupsV1MemberToJSON(json: any): ControllerApiResourcesGroupsV1Member {
|
||||
return ControllerApiResourcesGroupsV1MemberToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesGroupsV1MemberToJSONTyped(value?: Omit<ControllerApiResourcesGroupsV1Member, 'id'|'scope_id'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,203 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesPluginsV1PluginInfo } from './ControllerApiResourcesPluginsV1PluginInfo';
|
||||
import {
|
||||
ControllerApiResourcesPluginsV1PluginInfoFromJSON,
|
||||
ControllerApiResourcesPluginsV1PluginInfoFromJSONTyped,
|
||||
ControllerApiResourcesPluginsV1PluginInfoToJSON,
|
||||
ControllerApiResourcesPluginsV1PluginInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesPluginsV1PluginInfo';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
export interface ControllerApiResourcesHostcatalogsV1HostCatalog {
|
||||
/**
|
||||
* Output only. The ID of the host.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The ID of the Scope of which this Host Catalog is a part.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* The ID of the plugin of which this catalog is created.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
pluginId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesPluginsV1PluginInfo}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
plugin?: ControllerApiResourcesPluginsV1PluginInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The type of Host Catalog.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* Attributes specific to the catalog type.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* Secrets specific to the catalog type. These are never output.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
secrets?: object;
|
||||
/**
|
||||
* Output only. The HMAC of the last secrets supplied via the API, if any.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
readonly secretsHmac?: string;
|
||||
/**
|
||||
* Optional worker filter for plugin-subtype host catalogs. Boundary Enterprise only.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
workerFilter?: string;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
/**
|
||||
* Output only. The authorized actions for the scope's collections.
|
||||
* @type {{ [key: string]: Array<object>; }}
|
||||
* @memberof ControllerApiResourcesHostcatalogsV1HostCatalog
|
||||
*/
|
||||
readonly authorizedCollectionActions?: { [key: string]: Array<object>; };
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesHostcatalogsV1HostCatalog interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesHostcatalogsV1HostCatalog(value: object): value is ControllerApiResourcesHostcatalogsV1HostCatalog {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesHostcatalogsV1HostCatalogFromJSON(json: any): ControllerApiResourcesHostcatalogsV1HostCatalog {
|
||||
return ControllerApiResourcesHostcatalogsV1HostCatalogFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesHostcatalogsV1HostCatalogFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesHostcatalogsV1HostCatalog {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'pluginId': json['plugin_id'] == null ? undefined : json['plugin_id'],
|
||||
'plugin': json['plugin'] == null ? undefined : ControllerApiResourcesPluginsV1PluginInfoFromJSON(json['plugin']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'secrets': json['secrets'] == null ? undefined : json['secrets'],
|
||||
'secretsHmac': json['secrets_hmac'] == null ? undefined : json['secrets_hmac'],
|
||||
'workerFilter': json['worker_filter'] == null ? undefined : json['worker_filter'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
'authorizedCollectionActions': json['authorized_collection_actions'] == null ? undefined : json['authorized_collection_actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesHostcatalogsV1HostCatalogToJSON(json: any): ControllerApiResourcesHostcatalogsV1HostCatalog {
|
||||
return ControllerApiResourcesHostcatalogsV1HostCatalogToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesHostcatalogsV1HostCatalogToJSONTyped(value?: Omit<ControllerApiResourcesHostcatalogsV1HostCatalog, 'id'|'created_time'|'updated_time'|'secrets_hmac'|'authorized_actions'|'authorized_collection_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope_id': value['scopeId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'plugin_id': value['pluginId'],
|
||||
'plugin': ControllerApiResourcesPluginsV1PluginInfoToJSON(value['plugin']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
'secrets': value['secrets'],
|
||||
'worker_filter': value['workerFilter'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,200 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesPluginsV1PluginInfo } from './ControllerApiResourcesPluginsV1PluginInfo';
|
||||
import {
|
||||
ControllerApiResourcesPluginsV1PluginInfoFromJSON,
|
||||
ControllerApiResourcesPluginsV1PluginInfoFromJSONTyped,
|
||||
ControllerApiResourcesPluginsV1PluginInfoToJSON,
|
||||
ControllerApiResourcesPluginsV1PluginInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesPluginsV1PluginInfo';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
export interface ControllerApiResourcesHostsV1Host {
|
||||
/**
|
||||
* Output only. The ID of the Host.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The Host Catalog of which this Host is a part.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
hostCatalogId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesPluginsV1PluginInfo}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
plugin?: ControllerApiResourcesPluginsV1PluginInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The type of the resource.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* Output only. A list of Host Sets containing this Host.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
readonly hostSetIds?: Array<string>;
|
||||
/**
|
||||
* The attributes that are applicable to the specific Host type.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* Output only. The list of ip addresses associated with this host.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
readonly ipAddresses?: Array<string>;
|
||||
/**
|
||||
* Output only. The list of dns addresses associated with this host.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
readonly dnsNames?: Array<string>;
|
||||
/**
|
||||
* Output only. The external ID of the host, if any.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
readonly externalId?: string;
|
||||
/**
|
||||
* Output only. Refers to the name for a given host provided by the plugin enabled backing service.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
readonly externalName?: string;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesHostsV1Host
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesHostsV1Host interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesHostsV1Host(value: object): value is ControllerApiResourcesHostsV1Host {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesHostsV1HostFromJSON(json: any): ControllerApiResourcesHostsV1Host {
|
||||
return ControllerApiResourcesHostsV1HostFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesHostsV1HostFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesHostsV1Host {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'hostCatalogId': json['host_catalog_id'] == null ? undefined : json['host_catalog_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'plugin': json['plugin'] == null ? undefined : ControllerApiResourcesPluginsV1PluginInfoFromJSON(json['plugin']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'hostSetIds': json['host_set_ids'] == null ? undefined : json['host_set_ids'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'ipAddresses': json['ip_addresses'] == null ? undefined : json['ip_addresses'],
|
||||
'dnsNames': json['dns_names'] == null ? undefined : json['dns_names'],
|
||||
'externalId': json['external_id'] == null ? undefined : json['external_id'],
|
||||
'externalName': json['external_name'] == null ? undefined : json['external_name'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesHostsV1HostToJSON(json: any): ControllerApiResourcesHostsV1Host {
|
||||
return ControllerApiResourcesHostsV1HostToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesHostsV1HostToJSONTyped(value?: Omit<ControllerApiResourcesHostsV1Host, 'id'|'created_time'|'updated_time'|'host_set_ids'|'ip_addresses'|'dns_names'|'external_id'|'external_name'|'authorized_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'host_catalog_id': value['hostCatalogId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'plugin': ControllerApiResourcesPluginsV1PluginInfoToJSON(value['plugin']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,198 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesPluginsV1PluginInfo } from './ControllerApiResourcesPluginsV1PluginInfo';
|
||||
import {
|
||||
ControllerApiResourcesPluginsV1PluginInfoFromJSON,
|
||||
ControllerApiResourcesPluginsV1PluginInfoFromJSONTyped,
|
||||
ControllerApiResourcesPluginsV1PluginInfoToJSON,
|
||||
ControllerApiResourcesPluginsV1PluginInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesPluginsV1PluginInfo';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
export interface ControllerApiResourcesHostsetsV1HostSet {
|
||||
/**
|
||||
* Output only. The ID of the Host Set.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The Host Catalog of which this Host Set is a part.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
hostCatalogId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesPluginsV1PluginInfo}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
plugin?: ControllerApiResourcesPluginsV1PluginInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The type of the Host Set.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* Output only. A list of Hosts in this Host Set.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
readonly hostIds?: Array<string>;
|
||||
/**
|
||||
* multiple possible endpoints for a host. Preferences are specified by
|
||||
* "cidr:<valid IPv4/6 CIDR>" or "dns:<globbed name>", specifying which IP
|
||||
* address or DNS name out of a host's available possibilities should be
|
||||
* preferred. If no preferences are specified, a value will be chosen from
|
||||
* among all avialable values using a built-in priority order. May not be
|
||||
* valid for all plugin types.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
preferredEndpoints?: Array<string>;
|
||||
/**
|
||||
* An interger number of seconds indicating the amount of time that should
|
||||
* elapse between syncs of the host set. The interval will be applied to the
|
||||
* end of the previous sync operation, not the start. Setting to -1 will
|
||||
* disable syncing for that host set; setting to zero will cause the set to
|
||||
* use Boundary's default. The default may change between releases. May not
|
||||
* be valid for all plugin types.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
syncIntervalSeconds?: number;
|
||||
/**
|
||||
* The attributes that are applicable for the specific Host Set type.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesHostsetsV1HostSet
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesHostsetsV1HostSet interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesHostsetsV1HostSet(value: object): value is ControllerApiResourcesHostsetsV1HostSet {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesHostsetsV1HostSetFromJSON(json: any): ControllerApiResourcesHostsetsV1HostSet {
|
||||
return ControllerApiResourcesHostsetsV1HostSetFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesHostsetsV1HostSetFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesHostsetsV1HostSet {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'hostCatalogId': json['host_catalog_id'] == null ? undefined : json['host_catalog_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'plugin': json['plugin'] == null ? undefined : ControllerApiResourcesPluginsV1PluginInfoFromJSON(json['plugin']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'hostIds': json['host_ids'] == null ? undefined : json['host_ids'],
|
||||
'preferredEndpoints': json['preferred_endpoints'] == null ? undefined : json['preferred_endpoints'],
|
||||
'syncIntervalSeconds': json['sync_interval_seconds'] == null ? undefined : json['sync_interval_seconds'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesHostsetsV1HostSetToJSON(json: any): ControllerApiResourcesHostsetsV1HostSet {
|
||||
return ControllerApiResourcesHostsetsV1HostSetToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesHostsetsV1HostSetToJSONTyped(value?: Omit<ControllerApiResourcesHostsetsV1HostSet, 'id'|'created_time'|'updated_time'|'host_ids'|'authorized_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'host_catalog_id': value['hostCatalogId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'plugin': ControllerApiResourcesPluginsV1PluginInfoToJSON(value['plugin']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
'type': value['type'],
|
||||
'preferred_endpoints': value['preferredEndpoints'],
|
||||
'sync_interval_seconds': value['syncIntervalSeconds'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,157 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesManagedgroupsV1ManagedGroup
|
||||
*/
|
||||
export interface ControllerApiResourcesManagedgroupsV1ManagedGroup {
|
||||
/**
|
||||
* Output only. The ID of the ManagedGroup.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesManagedgroupsV1ManagedGroup
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesManagedgroupsV1ManagedGroup
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesManagedgroupsV1ManagedGroup
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesManagedgroupsV1ManagedGroup
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesManagedgroupsV1ManagedGroup
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesManagedgroupsV1ManagedGroup
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesManagedgroupsV1ManagedGroup
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The type of this ManagedGroup.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesManagedgroupsV1ManagedGroup
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The ID of the Auth Method that is associated with this ManagedGroup.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesManagedgroupsV1ManagedGroup
|
||||
*/
|
||||
authMethodId?: string;
|
||||
/**
|
||||
* The attributes that are applicable for the specific ManagedGroup type.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesManagedgroupsV1ManagedGroup
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* Output only. The IDs of the current set of members (accounts) that are associated with this ManagedGroup.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesManagedgroupsV1ManagedGroup
|
||||
*/
|
||||
readonly memberIds?: Array<string>;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesManagedgroupsV1ManagedGroup
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesManagedgroupsV1ManagedGroup interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesManagedgroupsV1ManagedGroup(value: object): value is ControllerApiResourcesManagedgroupsV1ManagedGroup {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesManagedgroupsV1ManagedGroupFromJSON(json: any): ControllerApiResourcesManagedgroupsV1ManagedGroup {
|
||||
return ControllerApiResourcesManagedgroupsV1ManagedGroupFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesManagedgroupsV1ManagedGroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesManagedgroupsV1ManagedGroup {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'authMethodId': json['auth_method_id'] == null ? undefined : json['auth_method_id'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'memberIds': json['member_ids'] == null ? undefined : json['member_ids'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesManagedgroupsV1ManagedGroupToJSON(json: any): ControllerApiResourcesManagedgroupsV1ManagedGroup {
|
||||
return ControllerApiResourcesManagedgroupsV1ManagedGroupToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesManagedgroupsV1ManagedGroupToJSONTyped(value?: Omit<ControllerApiResourcesManagedgroupsV1ManagedGroup, 'id'|'created_time'|'updated_time'|'member_ids'|'authorized_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
'type': value['type'],
|
||||
'auth_method_id': value['authMethodId'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,78 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesPluginsV1PluginInfo
|
||||
*/
|
||||
export interface ControllerApiResourcesPluginsV1PluginInfo {
|
||||
/**
|
||||
* Output only. The ID of the Plugin.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesPluginsV1PluginInfo
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* Output only. The name of the plugin resource in boundary, if any.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesPluginsV1PluginInfo
|
||||
*/
|
||||
readonly name?: string;
|
||||
/**
|
||||
* Output only. The description of the plugin in boundary, if any.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesPluginsV1PluginInfo
|
||||
*/
|
||||
readonly description?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesPluginsV1PluginInfo interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesPluginsV1PluginInfo(value: object): value is ControllerApiResourcesPluginsV1PluginInfo {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesPluginsV1PluginInfoFromJSON(json: any): ControllerApiResourcesPluginsV1PluginInfo {
|
||||
return ControllerApiResourcesPluginsV1PluginInfoFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesPluginsV1PluginInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesPluginsV1PluginInfo {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesPluginsV1PluginInfoToJSON(json: any): ControllerApiResourcesPluginsV1PluginInfo {
|
||||
return ControllerApiResourcesPluginsV1PluginInfoToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesPluginsV1PluginInfoToJSONTyped(value?: Omit<ControllerApiResourcesPluginsV1PluginInfo, 'id'|'name'|'description'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,152 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesPoliciesV1Policy
|
||||
*/
|
||||
export interface ControllerApiResourcesPoliciesV1Policy {
|
||||
/**
|
||||
* Output only. The id of the storage policy.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesPoliciesV1Policy
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The scope id of this policy. This must be defined for policy creation, but
|
||||
* is otherwise output only.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesPoliciesV1Policy
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesPoliciesV1Policy
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesPoliciesV1Policy
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesPoliciesV1Policy
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesPoliciesV1Policy
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesPoliciesV1Policy
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* The policy's type.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesPoliciesV1Policy
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure
|
||||
* this resource has not changed. The mutation will fail if the version does
|
||||
* not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesPoliciesV1Policy
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
*
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesPoliciesV1Policy
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesPoliciesV1Policy
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesPoliciesV1Policy interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesPoliciesV1Policy(value: object): value is ControllerApiResourcesPoliciesV1Policy {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesPoliciesV1PolicyFromJSON(json: any): ControllerApiResourcesPoliciesV1Policy {
|
||||
return ControllerApiResourcesPoliciesV1PolicyFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesPoliciesV1PolicyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesPoliciesV1Policy {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesPoliciesV1PolicyToJSON(json: any): ControllerApiResourcesPoliciesV1Policy {
|
||||
return ControllerApiResourcesPoliciesV1PolicyToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesPoliciesV1PolicyToJSONTyped(value?: Omit<ControllerApiResourcesPoliciesV1Policy, 'id'|'created_time'|'updated_time'|'authorized_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope_id': value['scopeId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'type': value['type'],
|
||||
'version': value['version'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,87 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesRolesV1GrantJson } from './ControllerApiResourcesRolesV1GrantJson';
|
||||
import {
|
||||
ControllerApiResourcesRolesV1GrantJsonFromJSON,
|
||||
ControllerApiResourcesRolesV1GrantJsonFromJSONTyped,
|
||||
ControllerApiResourcesRolesV1GrantJsonToJSON,
|
||||
ControllerApiResourcesRolesV1GrantJsonToJSONTyped,
|
||||
} from './ControllerApiResourcesRolesV1GrantJson';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesRolesV1Grant
|
||||
*/
|
||||
export interface ControllerApiResourcesRolesV1Grant {
|
||||
/**
|
||||
* Output only. The original user-supplied string.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesRolesV1Grant
|
||||
*/
|
||||
readonly raw?: string;
|
||||
/**
|
||||
* Output only. The canonically-formatted string.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesRolesV1Grant
|
||||
*/
|
||||
readonly canonical?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesRolesV1GrantJson}
|
||||
* @memberof ControllerApiResourcesRolesV1Grant
|
||||
*/
|
||||
json?: ControllerApiResourcesRolesV1GrantJson;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesRolesV1Grant interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesRolesV1Grant(value: object): value is ControllerApiResourcesRolesV1Grant {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1GrantFromJSON(json: any): ControllerApiResourcesRolesV1Grant {
|
||||
return ControllerApiResourcesRolesV1GrantFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1GrantFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesRolesV1Grant {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'raw': json['raw'] == null ? undefined : json['raw'],
|
||||
'canonical': json['canonical'] == null ? undefined : json['canonical'],
|
||||
'json': json['json'] == null ? undefined : ControllerApiResourcesRolesV1GrantJsonFromJSON(json['json']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1GrantToJSON(json: any): ControllerApiResourcesRolesV1Grant {
|
||||
return ControllerApiResourcesRolesV1GrantToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1GrantToJSONTyped(value?: Omit<ControllerApiResourcesRolesV1Grant, 'raw'|'canonical'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'json': ControllerApiResourcesRolesV1GrantJsonToJSON(value['json']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,86 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesRolesV1GrantJson
|
||||
*/
|
||||
export interface ControllerApiResourcesRolesV1GrantJson {
|
||||
/**
|
||||
* Output only. The ID, if set.
|
||||
* Deprecated: use "ids" instead.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesRolesV1GrantJson
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* Output only. The IDs, if set.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesRolesV1GrantJson
|
||||
*/
|
||||
readonly ids?: Array<string>;
|
||||
/**
|
||||
* Output only. The type, if set.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesRolesV1GrantJson
|
||||
*/
|
||||
readonly type?: string;
|
||||
/**
|
||||
* Output only. The actions.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesRolesV1GrantJson
|
||||
*/
|
||||
readonly actions?: Array<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesRolesV1GrantJson interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesRolesV1GrantJson(value: object): value is ControllerApiResourcesRolesV1GrantJson {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1GrantJsonFromJSON(json: any): ControllerApiResourcesRolesV1GrantJson {
|
||||
return ControllerApiResourcesRolesV1GrantJsonFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1GrantJsonFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesRolesV1GrantJson {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'ids': json['ids'] == null ? undefined : json['ids'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'actions': json['actions'] == null ? undefined : json['actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1GrantJsonToJSON(json: any): ControllerApiResourcesRolesV1GrantJson {
|
||||
return ControllerApiResourcesRolesV1GrantJsonToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1GrantJsonToJSONTyped(value?: Omit<ControllerApiResourcesRolesV1GrantJson, 'id'|'ids'|'type'|'actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,78 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesRolesV1Principal
|
||||
*/
|
||||
export interface ControllerApiResourcesRolesV1Principal {
|
||||
/**
|
||||
* Output only. The ID of the principal.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesRolesV1Principal
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* Output only. The type of the principal.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesRolesV1Principal
|
||||
*/
|
||||
readonly type?: string;
|
||||
/**
|
||||
* Output only. The Scope of the principal.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesRolesV1Principal
|
||||
*/
|
||||
readonly scopeId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesRolesV1Principal interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesRolesV1Principal(value: object): value is ControllerApiResourcesRolesV1Principal {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1PrincipalFromJSON(json: any): ControllerApiResourcesRolesV1Principal {
|
||||
return ControllerApiResourcesRolesV1PrincipalFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1PrincipalFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesRolesV1Principal {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1PrincipalToJSON(json: any): ControllerApiResourcesRolesV1Principal {
|
||||
return ControllerApiResourcesRolesV1PrincipalToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1PrincipalToJSONTyped(value?: Omit<ControllerApiResourcesRolesV1Principal, 'id'|'type'|'scope_id'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,189 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesRolesV1Principal } from './ControllerApiResourcesRolesV1Principal';
|
||||
import {
|
||||
ControllerApiResourcesRolesV1PrincipalFromJSON,
|
||||
ControllerApiResourcesRolesV1PrincipalFromJSONTyped,
|
||||
ControllerApiResourcesRolesV1PrincipalToJSON,
|
||||
ControllerApiResourcesRolesV1PrincipalToJSONTyped,
|
||||
} from './ControllerApiResourcesRolesV1Principal';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import type { ControllerApiResourcesRolesV1Grant } from './ControllerApiResourcesRolesV1Grant';
|
||||
import {
|
||||
ControllerApiResourcesRolesV1GrantFromJSON,
|
||||
ControllerApiResourcesRolesV1GrantFromJSONTyped,
|
||||
ControllerApiResourcesRolesV1GrantToJSON,
|
||||
ControllerApiResourcesRolesV1GrantToJSONTyped,
|
||||
} from './ControllerApiResourcesRolesV1Grant';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
export interface ControllerApiResourcesRolesV1Role {
|
||||
/**
|
||||
* Output only. The ID of the Role.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The ID of the Scope containing this Role.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* Output only. The IDs of Scopes the grants will apply to. This can include
|
||||
* the role's own scope ID, or "this" for the same behavior; specific IDs of
|
||||
* scopes that are children of the role's scope; the value "children" to match
|
||||
* all direct child scopes of the role's scope; or the value "descendants" to
|
||||
* match all descendant scopes (e.g. child scopes, children of child scopes;
|
||||
* only valid at "global" scope since it is the only one with children of
|
||||
* children).
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
readonly grantScopeIds?: Array<string>;
|
||||
/**
|
||||
* Output only. The IDs (only) of principals that are assigned to this role.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
readonly principalIds?: Array<string>;
|
||||
/**
|
||||
* Output only. The principals that are assigned to this role.
|
||||
* @type {Array<ControllerApiResourcesRolesV1Principal>}
|
||||
* @memberof ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
readonly principals?: Array<ControllerApiResourcesRolesV1Principal>;
|
||||
/**
|
||||
* Output only. The grants that this role provides for its principals.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
readonly grantStrings?: Array<string>;
|
||||
/**
|
||||
* Output only. The parsed grant information.
|
||||
* @type {Array<ControllerApiResourcesRolesV1Grant>}
|
||||
* @memberof ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
readonly grants?: Array<ControllerApiResourcesRolesV1Grant>;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesRolesV1Role
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesRolesV1Role interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesRolesV1Role(value: object): value is ControllerApiResourcesRolesV1Role {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1RoleFromJSON(json: any): ControllerApiResourcesRolesV1Role {
|
||||
return ControllerApiResourcesRolesV1RoleFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1RoleFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesRolesV1Role {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'grantScopeIds': json['grant_scope_ids'] == null ? undefined : json['grant_scope_ids'],
|
||||
'principalIds': json['principal_ids'] == null ? undefined : json['principal_ids'],
|
||||
'principals': json['principals'] == null ? undefined : ((json['principals'] as Array<any>).map(ControllerApiResourcesRolesV1PrincipalFromJSON)),
|
||||
'grantStrings': json['grant_strings'] == null ? undefined : json['grant_strings'],
|
||||
'grants': json['grants'] == null ? undefined : ((json['grants'] as Array<any>).map(ControllerApiResourcesRolesV1GrantFromJSON)),
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1RoleToJSON(json: any): ControllerApiResourcesRolesV1Role {
|
||||
return ControllerApiResourcesRolesV1RoleToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesRolesV1RoleToJSONTyped(value?: Omit<ControllerApiResourcesRolesV1Role, 'id'|'created_time'|'updated_time'|'grant_scope_ids'|'principal_ids'|'principals'|'grant_strings'|'grants'|'authorized_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope_id': value['scopeId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,120 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import type { ControllerApiResourcesScopesV1KeyVersion } from './ControllerApiResourcesScopesV1KeyVersion';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1KeyVersionFromJSON,
|
||||
ControllerApiResourcesScopesV1KeyVersionFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1KeyVersionToJSON,
|
||||
ControllerApiResourcesScopesV1KeyVersionToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1KeyVersion';
|
||||
|
||||
/**
|
||||
* Key contains all fields related to a Key in a Scope.
|
||||
* @export
|
||||
* @interface ControllerApiResourcesScopesV1Key
|
||||
*/
|
||||
export interface ControllerApiResourcesScopesV1Key {
|
||||
/**
|
||||
* The ID of the Key.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1Key
|
||||
*/
|
||||
id?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesScopesV1Key
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* The purpose of the Key.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1Key
|
||||
*/
|
||||
purpose?: string;
|
||||
/**
|
||||
* The time this Key was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesScopesV1Key
|
||||
*/
|
||||
createdTime?: Date;
|
||||
/**
|
||||
* The type of the Key.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1Key
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The versions of the key.
|
||||
* @type {Array<ControllerApiResourcesScopesV1KeyVersion>}
|
||||
* @memberof ControllerApiResourcesScopesV1Key
|
||||
*/
|
||||
versions?: Array<ControllerApiResourcesScopesV1KeyVersion>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesScopesV1Key interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesScopesV1Key(value: object): value is ControllerApiResourcesScopesV1Key {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1KeyFromJSON(json: any): ControllerApiResourcesScopesV1Key {
|
||||
return ControllerApiResourcesScopesV1KeyFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1KeyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesScopesV1Key {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'purpose': json['purpose'] == null ? undefined : json['purpose'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'versions': json['versions'] == null ? undefined : ((json['versions'] as Array<any>).map(ControllerApiResourcesScopesV1KeyVersionFromJSON)),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1KeyToJSON(json: any): ControllerApiResourcesScopesV1Key {
|
||||
return ControllerApiResourcesScopesV1KeyToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1KeyToJSONTyped(value?: ControllerApiResourcesScopesV1Key | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'id': value['id'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'purpose': value['purpose'],
|
||||
'created_time': value['createdTime'] == null ? undefined : ((value['createdTime']).toISOString()),
|
||||
'type': value['type'],
|
||||
'versions': value['versions'] == null ? undefined : ((value['versions'] as Array<any>).map(ControllerApiResourcesScopesV1KeyVersionToJSON)),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesScopesV1KeyVersion
|
||||
*/
|
||||
export interface ControllerApiResourcesScopesV1KeyVersion {
|
||||
/**
|
||||
* The ID of the key version.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1KeyVersion
|
||||
*/
|
||||
id?: string;
|
||||
/**
|
||||
* The iteration of the Key that this version represents.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesScopesV1KeyVersion
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* When this version was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesScopesV1KeyVersion
|
||||
*/
|
||||
createdTime?: Date;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesScopesV1KeyVersion interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesScopesV1KeyVersion(value: object): value is ControllerApiResourcesScopesV1KeyVersion {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1KeyVersionFromJSON(json: any): ControllerApiResourcesScopesV1KeyVersion {
|
||||
return ControllerApiResourcesScopesV1KeyVersionFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1KeyVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesScopesV1KeyVersion {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1KeyVersionToJSON(json: any): ControllerApiResourcesScopesV1KeyVersion {
|
||||
return ControllerApiResourcesScopesV1KeyVersionToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1KeyVersionToJSONTyped(value?: ControllerApiResourcesScopesV1KeyVersion | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'id': value['id'],
|
||||
'version': value['version'],
|
||||
'created_time': value['createdTime'] == null ? undefined : ((value['createdTime']).toISOString()),
|
||||
};
|
||||
}
|
||||
|
||||
+114
@@ -0,0 +1,114 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
* KeyVersionDestructionJob holds information about a pending key version destruction job.
|
||||
* @export
|
||||
* @interface ControllerApiResourcesScopesV1KeyVersionDestructionJob
|
||||
*/
|
||||
export interface ControllerApiResourcesScopesV1KeyVersionDestructionJob {
|
||||
/**
|
||||
* The ID of the Key version this job relates to.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1KeyVersionDestructionJob
|
||||
*/
|
||||
keyVersionId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesScopesV1KeyVersionDestructionJob
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* The current status of the key version destruction job. One of "pending", "running" or "completed".
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1KeyVersionDestructionJob
|
||||
*/
|
||||
status?: string;
|
||||
/**
|
||||
* The time this key version destruction job was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesScopesV1KeyVersionDestructionJob
|
||||
*/
|
||||
createdTime?: Date;
|
||||
/**
|
||||
* The number of rows that have been successfully re-encrypted with a new key version.
|
||||
* All rows must be re-encrypted before the key version can be destroyed.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1KeyVersionDestructionJob
|
||||
*/
|
||||
completedCount?: string;
|
||||
/**
|
||||
* The total number of rows that need re-encrypting.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1KeyVersionDestructionJob
|
||||
*/
|
||||
totalCount?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesScopesV1KeyVersionDestructionJob interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesScopesV1KeyVersionDestructionJob(value: object): value is ControllerApiResourcesScopesV1KeyVersionDestructionJob {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1KeyVersionDestructionJobFromJSON(json: any): ControllerApiResourcesScopesV1KeyVersionDestructionJob {
|
||||
return ControllerApiResourcesScopesV1KeyVersionDestructionJobFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1KeyVersionDestructionJobFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesScopesV1KeyVersionDestructionJob {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'keyVersionId': json['key_version_id'] == null ? undefined : json['key_version_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'status': json['status'] == null ? undefined : json['status'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'completedCount': json['completed_count'] == null ? undefined : json['completed_count'],
|
||||
'totalCount': json['total_count'] == null ? undefined : json['total_count'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1KeyVersionDestructionJobToJSON(json: any): ControllerApiResourcesScopesV1KeyVersionDestructionJob {
|
||||
return ControllerApiResourcesScopesV1KeyVersionDestructionJobToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1KeyVersionDestructionJobToJSONTyped(value?: ControllerApiResourcesScopesV1KeyVersionDestructionJob | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'key_version_id': value['keyVersionId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'status': value['status'],
|
||||
'created_time': value['createdTime'] == null ? undefined : ((value['createdTime']).toISOString()),
|
||||
'completed_count': value['completedCount'],
|
||||
'total_count': value['totalCount'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,164 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesScopesV1Scope
|
||||
*/
|
||||
export interface ControllerApiResourcesScopesV1Scope {
|
||||
/**
|
||||
* The ID of the scope.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1Scope
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The ID of the scope this resource is in. If this is the "global" scope this field will be empty.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1Scope
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesScopesV1Scope
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1Scope
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set descripton for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1Scope
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesScopesV1Scope
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesScopesV1Scope
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesScopesV1Scope
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The type of the resource.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1Scope
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1Scope
|
||||
*/
|
||||
primaryAuthMethodId?: string;
|
||||
/**
|
||||
* The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesScopesV1Scope
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
/**
|
||||
* The authorized actions for the scope's collections.
|
||||
* @type {{ [key: string]: Array<object>; }}
|
||||
* @memberof ControllerApiResourcesScopesV1Scope
|
||||
*/
|
||||
readonly authorizedCollectionActions?: { [key: string]: Array<object>; };
|
||||
/**
|
||||
* The attached storage policy id.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1Scope
|
||||
*/
|
||||
readonly storagePolicyId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesScopesV1Scope interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesScopesV1Scope(value: object): value is ControllerApiResourcesScopesV1Scope {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1ScopeFromJSON(json: any): ControllerApiResourcesScopesV1Scope {
|
||||
return ControllerApiResourcesScopesV1ScopeFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1ScopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesScopesV1Scope {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'primaryAuthMethodId': json['primary_auth_method_id'] == null ? undefined : json['primary_auth_method_id'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
'authorizedCollectionActions': json['authorized_collection_actions'] == null ? undefined : json['authorized_collection_actions'],
|
||||
'storagePolicyId': json['storage_policy_id'] == null ? undefined : json['storage_policy_id'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1ScopeToJSON(json: any): ControllerApiResourcesScopesV1Scope {
|
||||
return ControllerApiResourcesScopesV1ScopeToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1ScopeToJSONTyped(value?: Omit<ControllerApiResourcesScopesV1Scope, 'id'|'created_time'|'updated_time'|'authorized_actions'|'authorized_collection_actions'|'storage_policy_id'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope_id': value['scopeId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
'type': value['type'],
|
||||
'primary_auth_method_id': value['primaryAuthMethodId'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,92 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesScopesV1ScopeInfo
|
||||
*/
|
||||
export interface ControllerApiResourcesScopesV1ScopeInfo {
|
||||
/**
|
||||
* The ID of the scope.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1ScopeInfo
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The type of the scope.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1ScopeInfo
|
||||
*/
|
||||
readonly type?: string;
|
||||
/**
|
||||
* The name of the scope, if any.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1ScopeInfo
|
||||
*/
|
||||
readonly name?: string;
|
||||
/**
|
||||
* The description of the scope, if any.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1ScopeInfo
|
||||
*/
|
||||
readonly description?: string;
|
||||
/**
|
||||
* The ID of the parent scope, if any. This field is empty if it is the "global" scope.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesScopesV1ScopeInfo
|
||||
*/
|
||||
readonly parentScopeId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesScopesV1ScopeInfo interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesScopesV1ScopeInfo(value: object): value is ControllerApiResourcesScopesV1ScopeInfo {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1ScopeInfoFromJSON(json: any): ControllerApiResourcesScopesV1ScopeInfo {
|
||||
return ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesScopesV1ScopeInfo {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'parentScopeId': json['parent_scope_id'] == null ? undefined : json['parent_scope_id'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1ScopeInfoToJSON(json: any): ControllerApiResourcesScopesV1ScopeInfo {
|
||||
return ControllerApiResourcesScopesV1ScopeInfoToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesScopesV1ScopeInfoToJSONTyped(value?: Omit<ControllerApiResourcesScopesV1ScopeInfo, 'id'|'type'|'name'|'description'|'parent_scope_id'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
};
|
||||
}
|
||||
|
||||
+132
@@ -0,0 +1,132 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
* ChannelRecording contains recorded information about a single Channel within a Connection.
|
||||
* Channels are only present in multiplexed protocols, such as SSH.
|
||||
* @export
|
||||
* @interface ControllerApiResourcesSessionrecordingsV1ChannelRecording
|
||||
*/
|
||||
export interface ControllerApiResourcesSessionrecordingsV1ChannelRecording {
|
||||
/**
|
||||
* The ID of the Channel recording.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ChannelRecording
|
||||
*/
|
||||
id?: string;
|
||||
/**
|
||||
* The total number of bytes uploaded from the client in the Channel.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ChannelRecording
|
||||
*/
|
||||
bytesUp?: string;
|
||||
/**
|
||||
* The total number of bytes downloaded to the client in the Channel.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ChannelRecording
|
||||
*/
|
||||
bytesDown?: string;
|
||||
/**
|
||||
* The time the Channel was created in the controller.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ChannelRecording
|
||||
*/
|
||||
createdTime?: Date;
|
||||
/**
|
||||
* The time of the most recent update to the Channel.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ChannelRecording
|
||||
*/
|
||||
updatedTime?: Date;
|
||||
/**
|
||||
* The time the Channel started.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ChannelRecording
|
||||
*/
|
||||
startTime?: Date;
|
||||
/**
|
||||
* The time the Channel ended.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ChannelRecording
|
||||
*/
|
||||
endTime?: Date;
|
||||
/**
|
||||
* The total duration of the Channel.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ChannelRecording
|
||||
*/
|
||||
duration?: string;
|
||||
/**
|
||||
* MimeTypes define the mime types that can
|
||||
* be used to consume the recording of this Channel.
|
||||
* The only supported mime type is "application/x-asciicast".
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ChannelRecording
|
||||
*/
|
||||
mimeTypes?: Array<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesSessionrecordingsV1ChannelRecording interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesSessionrecordingsV1ChannelRecording(value: object): value is ControllerApiResourcesSessionrecordingsV1ChannelRecording {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1ChannelRecordingFromJSON(json: any): ControllerApiResourcesSessionrecordingsV1ChannelRecording {
|
||||
return ControllerApiResourcesSessionrecordingsV1ChannelRecordingFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1ChannelRecordingFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesSessionrecordingsV1ChannelRecording {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'bytesUp': json['bytes_up'] == null ? undefined : json['bytes_up'],
|
||||
'bytesDown': json['bytes_down'] == null ? undefined : json['bytes_down'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'startTime': json['start_time'] == null ? undefined : (new Date(json['start_time'])),
|
||||
'endTime': json['end_time'] == null ? undefined : (new Date(json['end_time'])),
|
||||
'duration': json['duration'] == null ? undefined : json['duration'],
|
||||
'mimeTypes': json['mime_types'] == null ? undefined : json['mime_types'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1ChannelRecordingToJSON(json: any): ControllerApiResourcesSessionrecordingsV1ChannelRecording {
|
||||
return ControllerApiResourcesSessionrecordingsV1ChannelRecordingToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1ChannelRecordingToJSONTyped(value?: ControllerApiResourcesSessionrecordingsV1ChannelRecording | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'id': value['id'],
|
||||
'bytes_up': value['bytesUp'],
|
||||
'bytes_down': value['bytesDown'],
|
||||
'created_time': value['createdTime'] == null ? undefined : ((value['createdTime']).toISOString()),
|
||||
'updated_time': value['updatedTime'] == null ? undefined : ((value['updatedTime']).toISOString()),
|
||||
'start_time': value['startTime'] == null ? undefined : ((value['startTime']).toISOString()),
|
||||
'end_time': value['endTime'] == null ? undefined : ((value['endTime']).toISOString()),
|
||||
'duration': value['duration'],
|
||||
'mime_types': value['mimeTypes'],
|
||||
};
|
||||
}
|
||||
|
||||
+150
@@ -0,0 +1,150 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesSessionrecordingsV1ChannelRecording } from './ControllerApiResourcesSessionrecordingsV1ChannelRecording';
|
||||
import {
|
||||
ControllerApiResourcesSessionrecordingsV1ChannelRecordingFromJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1ChannelRecordingFromJSONTyped,
|
||||
ControllerApiResourcesSessionrecordingsV1ChannelRecordingToJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1ChannelRecordingToJSONTyped,
|
||||
} from './ControllerApiResourcesSessionrecordingsV1ChannelRecording';
|
||||
|
||||
/**
|
||||
* ConnectionRecording contains the recording of a single Connection within a Session.
|
||||
* @export
|
||||
* @interface ControllerApiResourcesSessionrecordingsV1ConnectionRecording
|
||||
*/
|
||||
export interface ControllerApiResourcesSessionrecordingsV1ConnectionRecording {
|
||||
/**
|
||||
* The ID of the Connection recording.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ConnectionRecording
|
||||
*/
|
||||
id?: string;
|
||||
/**
|
||||
* The total number of bytes uploaded from the client in the Connection.
|
||||
* This includes any protocol overhead.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ConnectionRecording
|
||||
*/
|
||||
bytesUp?: string;
|
||||
/**
|
||||
* The total number of bytes downloaded to the client in the Connection.
|
||||
* This includes any protocol overhead.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ConnectionRecording
|
||||
*/
|
||||
bytesDown?: string;
|
||||
/**
|
||||
* The time the Connection was created in the controller.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ConnectionRecording
|
||||
*/
|
||||
createdTime?: Date;
|
||||
/**
|
||||
* The time of the most recent update to the Connection.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ConnectionRecording
|
||||
*/
|
||||
updatedTime?: Date;
|
||||
/**
|
||||
* The time the Connection started.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ConnectionRecording
|
||||
*/
|
||||
startTime?: Date;
|
||||
/**
|
||||
* The time the Connection ended.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ConnectionRecording
|
||||
*/
|
||||
endTime?: Date;
|
||||
/**
|
||||
* The total duration of the Connection.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ConnectionRecording
|
||||
*/
|
||||
duration?: string;
|
||||
/**
|
||||
* MimeTypes define the mime types that can
|
||||
* be used to consume the recording of this Connection.
|
||||
* No mime types are currently supported.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ConnectionRecording
|
||||
*/
|
||||
mimeTypes?: Array<string>;
|
||||
/**
|
||||
* Optionally, the channels used in this Connection,
|
||||
* if it is using a multiplexed protocol, such as SSH.
|
||||
* @type {Array<ControllerApiResourcesSessionrecordingsV1ChannelRecording>}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ConnectionRecording
|
||||
*/
|
||||
channelRecordings?: Array<ControllerApiResourcesSessionrecordingsV1ChannelRecording>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesSessionrecordingsV1ConnectionRecording interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesSessionrecordingsV1ConnectionRecording(value: object): value is ControllerApiResourcesSessionrecordingsV1ConnectionRecording {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1ConnectionRecordingFromJSON(json: any): ControllerApiResourcesSessionrecordingsV1ConnectionRecording {
|
||||
return ControllerApiResourcesSessionrecordingsV1ConnectionRecordingFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1ConnectionRecordingFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesSessionrecordingsV1ConnectionRecording {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'bytesUp': json['bytes_up'] == null ? undefined : json['bytes_up'],
|
||||
'bytesDown': json['bytes_down'] == null ? undefined : json['bytes_down'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'startTime': json['start_time'] == null ? undefined : (new Date(json['start_time'])),
|
||||
'endTime': json['end_time'] == null ? undefined : (new Date(json['end_time'])),
|
||||
'duration': json['duration'] == null ? undefined : json['duration'],
|
||||
'mimeTypes': json['mime_types'] == null ? undefined : json['mime_types'],
|
||||
'channelRecordings': json['channel_recordings'] == null ? undefined : ((json['channel_recordings'] as Array<any>).map(ControllerApiResourcesSessionrecordingsV1ChannelRecordingFromJSON)),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1ConnectionRecordingToJSON(json: any): ControllerApiResourcesSessionrecordingsV1ConnectionRecording {
|
||||
return ControllerApiResourcesSessionrecordingsV1ConnectionRecordingToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1ConnectionRecordingToJSONTyped(value?: ControllerApiResourcesSessionrecordingsV1ConnectionRecording | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'id': value['id'],
|
||||
'bytes_up': value['bytesUp'],
|
||||
'bytes_down': value['bytesDown'],
|
||||
'created_time': value['createdTime'] == null ? undefined : ((value['createdTime']).toISOString()),
|
||||
'updated_time': value['updatedTime'] == null ? undefined : ((value['updatedTime']).toISOString()),
|
||||
'start_time': value['startTime'] == null ? undefined : ((value['startTime']).toISOString()),
|
||||
'end_time': value['endTime'] == null ? undefined : ((value['endTime']).toISOString()),
|
||||
'duration': value['duration'],
|
||||
'mime_types': value['mimeTypes'],
|
||||
'channel_recordings': value['channelRecordings'] == null ? undefined : ((value['channelRecordings'] as Array<any>).map(ControllerApiResourcesSessionrecordingsV1ChannelRecordingToJSON)),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,121 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesSessionrecordingsV1CredentialStore } from './ControllerApiResourcesSessionrecordingsV1CredentialStore';
|
||||
import {
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialStoreFromJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialStoreFromJSONTyped,
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialStoreToJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialStoreToJSONTyped,
|
||||
} from './ControllerApiResourcesSessionrecordingsV1CredentialStore';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesSessionrecordingsV1Credential
|
||||
*/
|
||||
export interface ControllerApiResourcesSessionrecordingsV1Credential {
|
||||
/**
|
||||
* The ID of the Credential.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Credential
|
||||
*/
|
||||
id?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesSessionrecordingsV1CredentialStore}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Credential
|
||||
*/
|
||||
credentialStore?: ControllerApiResourcesSessionrecordingsV1CredentialStore;
|
||||
/**
|
||||
* The name of the credential.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Credential
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Credential
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* The purposes for which this Credential was attached to the sesssion.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Credential
|
||||
*/
|
||||
purposes?: Array<string>;
|
||||
/**
|
||||
* The Credential type.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Credential
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The attributes that are applicable for the specific Credential type.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Credential
|
||||
*/
|
||||
attributes?: object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesSessionrecordingsV1Credential interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesSessionrecordingsV1Credential(value: object): value is ControllerApiResourcesSessionrecordingsV1Credential {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1CredentialFromJSON(json: any): ControllerApiResourcesSessionrecordingsV1Credential {
|
||||
return ControllerApiResourcesSessionrecordingsV1CredentialFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1CredentialFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesSessionrecordingsV1Credential {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'credentialStore': json['credential_store'] == null ? undefined : ControllerApiResourcesSessionrecordingsV1CredentialStoreFromJSON(json['credential_store']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'purposes': json['purposes'] == null ? undefined : json['purposes'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1CredentialToJSON(json: any): ControllerApiResourcesSessionrecordingsV1Credential {
|
||||
return ControllerApiResourcesSessionrecordingsV1CredentialToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1CredentialToJSONTyped(value?: ControllerApiResourcesSessionrecordingsV1Credential | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'id': value['id'],
|
||||
'credential_store': ControllerApiResourcesSessionrecordingsV1CredentialStoreToJSON(value['credentialStore']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'purposes': value['purposes'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
+121
@@ -0,0 +1,121 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesSessionrecordingsV1CredentialStore } from './ControllerApiResourcesSessionrecordingsV1CredentialStore';
|
||||
import {
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialStoreFromJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialStoreFromJSONTyped,
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialStoreToJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialStoreToJSONTyped,
|
||||
} from './ControllerApiResourcesSessionrecordingsV1CredentialStore';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesSessionrecordingsV1CredentialLibrary
|
||||
*/
|
||||
export interface ControllerApiResourcesSessionrecordingsV1CredentialLibrary {
|
||||
/**
|
||||
* The ID of the Credential Library.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1CredentialLibrary
|
||||
*/
|
||||
id?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesSessionrecordingsV1CredentialStore}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1CredentialLibrary
|
||||
*/
|
||||
credentialStore?: ControllerApiResourcesSessionrecordingsV1CredentialStore;
|
||||
/**
|
||||
* Optional name of this Credential Library.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1CredentialLibrary
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description of this Credential Library.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1CredentialLibrary
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* The purposes for which this CredentialLibrary was attached to the sesssion.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1CredentialLibrary
|
||||
*/
|
||||
purposes?: Array<string>;
|
||||
/**
|
||||
* The Credential Library type.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1CredentialLibrary
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The attributes that are applicable for the specific Credential Library type.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1CredentialLibrary
|
||||
*/
|
||||
attributes?: object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesSessionrecordingsV1CredentialLibrary interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesSessionrecordingsV1CredentialLibrary(value: object): value is ControllerApiResourcesSessionrecordingsV1CredentialLibrary {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1CredentialLibraryFromJSON(json: any): ControllerApiResourcesSessionrecordingsV1CredentialLibrary {
|
||||
return ControllerApiResourcesSessionrecordingsV1CredentialLibraryFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1CredentialLibraryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesSessionrecordingsV1CredentialLibrary {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'credentialStore': json['credential_store'] == null ? undefined : ControllerApiResourcesSessionrecordingsV1CredentialStoreFromJSON(json['credential_store']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'purposes': json['purposes'] == null ? undefined : json['purposes'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1CredentialLibraryToJSON(json: any): ControllerApiResourcesSessionrecordingsV1CredentialLibrary {
|
||||
return ControllerApiResourcesSessionrecordingsV1CredentialLibraryToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1CredentialLibraryToJSONTyped(value?: ControllerApiResourcesSessionrecordingsV1CredentialLibrary | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'id': value['id'],
|
||||
'credential_store': ControllerApiResourcesSessionrecordingsV1CredentialStoreToJSON(value['credentialStore']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'purposes': value['purposes'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
+105
@@ -0,0 +1,105 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesSessionrecordingsV1CredentialStore
|
||||
*/
|
||||
export interface ControllerApiResourcesSessionrecordingsV1CredentialStore {
|
||||
/**
|
||||
* The ID of the Credential Store.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1CredentialStore
|
||||
*/
|
||||
id?: string;
|
||||
/**
|
||||
* The ID of the Scope of which this Credential Store is a part.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1CredentialStore
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
* The name for identification purposes if set.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1CredentialStore
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* The description for identification purposes if set.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1CredentialStore
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* The Credential Store type.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1CredentialStore
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The attributes that are applicable for the specific Credential Store type.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1CredentialStore
|
||||
*/
|
||||
attributes?: object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesSessionrecordingsV1CredentialStore interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesSessionrecordingsV1CredentialStore(value: object): value is ControllerApiResourcesSessionrecordingsV1CredentialStore {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1CredentialStoreFromJSON(json: any): ControllerApiResourcesSessionrecordingsV1CredentialStore {
|
||||
return ControllerApiResourcesSessionrecordingsV1CredentialStoreFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1CredentialStoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesSessionrecordingsV1CredentialStore {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1CredentialStoreToJSON(json: any): ControllerApiResourcesSessionrecordingsV1CredentialStore {
|
||||
return ControllerApiResourcesSessionrecordingsV1CredentialStoreToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1CredentialStoreToJSONTyped(value?: ControllerApiResourcesSessionrecordingsV1CredentialStore | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'id': value['id'],
|
||||
'scope_id': value['scopeId'],
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,129 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesSessionrecordingsV1HostCatalog } from './ControllerApiResourcesSessionrecordingsV1HostCatalog';
|
||||
import {
|
||||
ControllerApiResourcesSessionrecordingsV1HostCatalogFromJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1HostCatalogFromJSONTyped,
|
||||
ControllerApiResourcesSessionrecordingsV1HostCatalogToJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1HostCatalogToJSONTyped,
|
||||
} from './ControllerApiResourcesSessionrecordingsV1HostCatalog';
|
||||
|
||||
/**
|
||||
* Host describes the Host that was chosen for the recorded session.
|
||||
* @export
|
||||
* @interface ControllerApiResourcesSessionrecordingsV1Host
|
||||
*/
|
||||
export interface ControllerApiResourcesSessionrecordingsV1Host {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Host
|
||||
*/
|
||||
id?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesSessionrecordingsV1HostCatalog}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Host
|
||||
*/
|
||||
hostCatalog?: ControllerApiResourcesSessionrecordingsV1HostCatalog;
|
||||
/**
|
||||
* The name of the Host, if set.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Host
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* The description of the Host, if set.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Host
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Host
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The attributes that are applicable for the specific Host.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Host
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* The external id of the Host, if any.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Host
|
||||
*/
|
||||
externalId?: string;
|
||||
/**
|
||||
* The external name of the Host, if any.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Host
|
||||
*/
|
||||
externalName?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesSessionrecordingsV1Host interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesSessionrecordingsV1Host(value: object): value is ControllerApiResourcesSessionrecordingsV1Host {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1HostFromJSON(json: any): ControllerApiResourcesSessionrecordingsV1Host {
|
||||
return ControllerApiResourcesSessionrecordingsV1HostFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1HostFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesSessionrecordingsV1Host {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'hostCatalog': json['host_catalog'] == null ? undefined : ControllerApiResourcesSessionrecordingsV1HostCatalogFromJSON(json['host_catalog']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'externalId': json['external_id'] == null ? undefined : json['external_id'],
|
||||
'externalName': json['external_name'] == null ? undefined : json['external_name'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1HostToJSON(json: any): ControllerApiResourcesSessionrecordingsV1Host {
|
||||
return ControllerApiResourcesSessionrecordingsV1HostToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1HostToJSONTyped(value?: ControllerApiResourcesSessionrecordingsV1Host | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'id': value['id'],
|
||||
'host_catalog': ControllerApiResourcesSessionrecordingsV1HostCatalogToJSON(value['hostCatalog']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
'external_id': value['externalId'],
|
||||
'external_name': value['externalName'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,122 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
* HostCatalog describes the HostCatalog that contains the host chosen for the
|
||||
* recorded session.
|
||||
* @export
|
||||
* @interface ControllerApiResourcesSessionrecordingsV1HostCatalog
|
||||
*/
|
||||
export interface ControllerApiResourcesSessionrecordingsV1HostCatalog {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1HostCatalog
|
||||
*/
|
||||
id?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1HostCatalog
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* The plugin id used by this Host Catalog, if any.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1HostCatalog
|
||||
*/
|
||||
pluginId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1HostCatalog
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* The description of the Host Catalog.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1HostCatalog
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1HostCatalog
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The attributes of the Host Catalog.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1HostCatalog
|
||||
*/
|
||||
attributes?: object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesSessionrecordingsV1HostCatalog interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesSessionrecordingsV1HostCatalog(value: object): value is ControllerApiResourcesSessionrecordingsV1HostCatalog {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1HostCatalogFromJSON(json: any): ControllerApiResourcesSessionrecordingsV1HostCatalog {
|
||||
return ControllerApiResourcesSessionrecordingsV1HostCatalogFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1HostCatalogFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesSessionrecordingsV1HostCatalog {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'pluginId': json['plugin_id'] == null ? undefined : json['plugin_id'],
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1HostCatalogToJSON(json: any): ControllerApiResourcesSessionrecordingsV1HostCatalog {
|
||||
return ControllerApiResourcesSessionrecordingsV1HostCatalogToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1HostCatalogToJSONTyped(value?: ControllerApiResourcesSessionrecordingsV1HostCatalog | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'id': value['id'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'plugin_id': value['pluginId'],
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
+256
@@ -0,0 +1,256 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesSessionrecordingsV1ValuesAtTime } from './ControllerApiResourcesSessionrecordingsV1ValuesAtTime';
|
||||
import {
|
||||
ControllerApiResourcesSessionrecordingsV1ValuesAtTimeFromJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1ValuesAtTimeFromJSONTyped,
|
||||
ControllerApiResourcesSessionrecordingsV1ValuesAtTimeToJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1ValuesAtTimeToJSONTyped,
|
||||
} from './ControllerApiResourcesSessionrecordingsV1ValuesAtTime';
|
||||
import type { ControllerApiResourcesSessionrecordingsV1ConnectionRecording } from './ControllerApiResourcesSessionrecordingsV1ConnectionRecording';
|
||||
import {
|
||||
ControllerApiResourcesSessionrecordingsV1ConnectionRecordingFromJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1ConnectionRecordingFromJSONTyped,
|
||||
ControllerApiResourcesSessionrecordingsV1ConnectionRecordingToJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1ConnectionRecordingToJSONTyped,
|
||||
} from './ControllerApiResourcesSessionrecordingsV1ConnectionRecording';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
* SessionRecording contains information about the recording of a Session.
|
||||
* @export
|
||||
* @interface ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
export interface ControllerApiResourcesSessionrecordingsV1SessionRecording {
|
||||
/**
|
||||
* The ID of the Session recording.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
id?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* The ID of the Session which this Session Recording recorded.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
sessionId?: string;
|
||||
/**
|
||||
* The ID of the Storage Bucket for the Target of this Session Recording.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
storageBucketId?: string;
|
||||
/**
|
||||
* The total number of bytes uploaded from the client in the Session.
|
||||
* This includes all bytes uploaded over all Connections, including
|
||||
* any protocol overhead.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
bytesUp?: string;
|
||||
/**
|
||||
* The total number of bytes downloaded to the client in the Session.
|
||||
* This includes all bytes downloaded over all Connections, including
|
||||
* any protocol overhead.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
bytesDown?: string;
|
||||
/**
|
||||
* The time the Session Recording was created in the controller.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
createdTime?: Date;
|
||||
/**
|
||||
* The time of the most recent update to the Session Recording.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
updatedTime?: Date;
|
||||
/**
|
||||
* The time the Session started.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
startTime?: Date;
|
||||
/**
|
||||
* The time the Session ended.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
endTime?: Date;
|
||||
/**
|
||||
* The total duration of the Session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
duration?: string;
|
||||
/**
|
||||
* Type of the Session that was recorded (e.g. ssh).
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The current state of the session recording. One of
|
||||
* "started", "available" and "unknown".
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
state?: string;
|
||||
/**
|
||||
* Any error seen during the closing of the session recording.
|
||||
* Currently only set if state is "unknown".
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
errorDetails?: string;
|
||||
/**
|
||||
* MimeTypes define the mime types that can
|
||||
* be used to consume the recording of this Session.
|
||||
* No mime types are currently supported.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
mimeTypes?: Array<string>;
|
||||
/**
|
||||
* The endpoint of the Session; that is, the address to which the egress worker connected.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
endpoint?: string;
|
||||
/**
|
||||
* The recordings of the connections that were created in the Session.
|
||||
* This field may be unset when listing Session recordings.
|
||||
* @type {Array<ControllerApiResourcesSessionrecordingsV1ConnectionRecording>}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
connectionRecordings?: Array<ControllerApiResourcesSessionrecordingsV1ConnectionRecording>;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesSessionrecordingsV1ValuesAtTime}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
createTimeValues?: ControllerApiResourcesSessionrecordingsV1ValuesAtTime;
|
||||
/**
|
||||
* The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
authorizedActions?: Array<string>;
|
||||
/**
|
||||
* The time until a session recording is required to be stored.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
retainUntil?: Date;
|
||||
/**
|
||||
* The time a session recording is scheduled to be automatically deleted.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1SessionRecording
|
||||
*/
|
||||
deleteAfter?: Date;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesSessionrecordingsV1SessionRecording interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesSessionrecordingsV1SessionRecording(value: object): value is ControllerApiResourcesSessionrecordingsV1SessionRecording {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1SessionRecordingFromJSON(json: any): ControllerApiResourcesSessionrecordingsV1SessionRecording {
|
||||
return ControllerApiResourcesSessionrecordingsV1SessionRecordingFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1SessionRecordingFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesSessionrecordingsV1SessionRecording {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'sessionId': json['session_id'] == null ? undefined : json['session_id'],
|
||||
'storageBucketId': json['storage_bucket_id'] == null ? undefined : json['storage_bucket_id'],
|
||||
'bytesUp': json['bytes_up'] == null ? undefined : json['bytes_up'],
|
||||
'bytesDown': json['bytes_down'] == null ? undefined : json['bytes_down'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'startTime': json['start_time'] == null ? undefined : (new Date(json['start_time'])),
|
||||
'endTime': json['end_time'] == null ? undefined : (new Date(json['end_time'])),
|
||||
'duration': json['duration'] == null ? undefined : json['duration'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'state': json['state'] == null ? undefined : json['state'],
|
||||
'errorDetails': json['error_details'] == null ? undefined : json['error_details'],
|
||||
'mimeTypes': json['mime_types'] == null ? undefined : json['mime_types'],
|
||||
'endpoint': json['endpoint'] == null ? undefined : json['endpoint'],
|
||||
'connectionRecordings': json['connection_recordings'] == null ? undefined : ((json['connection_recordings'] as Array<any>).map(ControllerApiResourcesSessionrecordingsV1ConnectionRecordingFromJSON)),
|
||||
'createTimeValues': json['create_time_values'] == null ? undefined : ControllerApiResourcesSessionrecordingsV1ValuesAtTimeFromJSON(json['create_time_values']),
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
'retainUntil': json['retain_until'] == null ? undefined : (new Date(json['retain_until'])),
|
||||
'deleteAfter': json['delete_after'] == null ? undefined : (new Date(json['delete_after'])),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1SessionRecordingToJSON(json: any): ControllerApiResourcesSessionrecordingsV1SessionRecording {
|
||||
return ControllerApiResourcesSessionrecordingsV1SessionRecordingToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1SessionRecordingToJSONTyped(value?: ControllerApiResourcesSessionrecordingsV1SessionRecording | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'id': value['id'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'session_id': value['sessionId'],
|
||||
'storage_bucket_id': value['storageBucketId'],
|
||||
'bytes_up': value['bytesUp'],
|
||||
'bytes_down': value['bytesDown'],
|
||||
'created_time': value['createdTime'] == null ? undefined : ((value['createdTime']).toISOString()),
|
||||
'updated_time': value['updatedTime'] == null ? undefined : ((value['updatedTime']).toISOString()),
|
||||
'start_time': value['startTime'] == null ? undefined : ((value['startTime']).toISOString()),
|
||||
'end_time': value['endTime'] == null ? undefined : ((value['endTime']).toISOString()),
|
||||
'duration': value['duration'],
|
||||
'type': value['type'],
|
||||
'state': value['state'],
|
||||
'error_details': value['errorDetails'],
|
||||
'mime_types': value['mimeTypes'],
|
||||
'endpoint': value['endpoint'],
|
||||
'connection_recordings': value['connectionRecordings'] == null ? undefined : ((value['connectionRecordings'] as Array<any>).map(ControllerApiResourcesSessionrecordingsV1ConnectionRecordingToJSON)),
|
||||
'create_time_values': ControllerApiResourcesSessionrecordingsV1ValuesAtTimeToJSON(value['createTimeValues']),
|
||||
'authorized_actions': value['authorizedActions'],
|
||||
'retain_until': value['retainUntil'] == null ? undefined : ((value['retainUntil']).toISOString()),
|
||||
'delete_after': value['deleteAfter'] == null ? undefined : ((value['deleteAfter']).toISOString()),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,153 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
* Target describes a target in Boundary.
|
||||
* @export
|
||||
* @interface ControllerApiResourcesSessionrecordingsV1Target
|
||||
*/
|
||||
export interface ControllerApiResourcesSessionrecordingsV1Target {
|
||||
/**
|
||||
* The ID of the Target.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Target
|
||||
*/
|
||||
id?: string;
|
||||
/**
|
||||
* The name of the Target, if set.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Target
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* The description of the Target, if set.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Target
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Target
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Maximum total lifetime of a created Session, in seconds.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Target
|
||||
*/
|
||||
sessionMaxSeconds?: number;
|
||||
/**
|
||||
* Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Target
|
||||
*/
|
||||
sessionConnectionLimit?: number;
|
||||
/**
|
||||
* Optional boolean expression to filter the workers that are allowed to satisfy this request.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Target
|
||||
*/
|
||||
workerFilter?: string;
|
||||
/**
|
||||
* Optional boolean expressions to filter the egress workers that are allowed to satisfy this request.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Target
|
||||
*/
|
||||
egressWorkerFilter?: string;
|
||||
/**
|
||||
* Optional boolean expressions to filter the ingress workers that are allowed to satisfy this request.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Target
|
||||
*/
|
||||
ingressWorkerFilter?: string;
|
||||
/**
|
||||
* The type of the Target.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Target
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The attributes that are applicable for the specific Target.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1Target
|
||||
*/
|
||||
attributes?: object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesSessionrecordingsV1Target interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesSessionrecordingsV1Target(value: object): value is ControllerApiResourcesSessionrecordingsV1Target {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1TargetFromJSON(json: any): ControllerApiResourcesSessionrecordingsV1Target {
|
||||
return ControllerApiResourcesSessionrecordingsV1TargetFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1TargetFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesSessionrecordingsV1Target {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'sessionMaxSeconds': json['session_max_seconds'] == null ? undefined : json['session_max_seconds'],
|
||||
'sessionConnectionLimit': json['session_connection_limit'] == null ? undefined : json['session_connection_limit'],
|
||||
'workerFilter': json['worker_filter'] == null ? undefined : json['worker_filter'],
|
||||
'egressWorkerFilter': json['egress_worker_filter'] == null ? undefined : json['egress_worker_filter'],
|
||||
'ingressWorkerFilter': json['ingress_worker_filter'] == null ? undefined : json['ingress_worker_filter'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1TargetToJSON(json: any): ControllerApiResourcesSessionrecordingsV1Target {
|
||||
return ControllerApiResourcesSessionrecordingsV1TargetToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1TargetToJSONTyped(value?: ControllerApiResourcesSessionrecordingsV1Target | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'id': value['id'],
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'session_max_seconds': value['sessionMaxSeconds'],
|
||||
'session_connection_limit': value['sessionConnectionLimit'],
|
||||
'worker_filter': value['workerFilter'],
|
||||
'egress_worker_filter': value['egressWorkerFilter'],
|
||||
'ingress_worker_filter': value['ingressWorkerFilter'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,97 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
* User describes an authenticated user in Boundary.
|
||||
* @export
|
||||
* @interface ControllerApiResourcesSessionrecordingsV1User
|
||||
*/
|
||||
export interface ControllerApiResourcesSessionrecordingsV1User {
|
||||
/**
|
||||
* The ID of the User.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1User
|
||||
*/
|
||||
id?: string;
|
||||
/**
|
||||
* The name of the User that created the Session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1User
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* The description of the User that created the Session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1User
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1User
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesSessionrecordingsV1User interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesSessionrecordingsV1User(value: object): value is ControllerApiResourcesSessionrecordingsV1User {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1UserFromJSON(json: any): ControllerApiResourcesSessionrecordingsV1User {
|
||||
return ControllerApiResourcesSessionrecordingsV1UserFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1UserFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesSessionrecordingsV1User {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1UserToJSON(json: any): ControllerApiResourcesSessionrecordingsV1User {
|
||||
return ControllerApiResourcesSessionrecordingsV1UserToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1UserToJSONTyped(value?: ControllerApiResourcesSessionrecordingsV1User | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'id': value['id'],
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,134 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesSessionrecordingsV1Host } from './ControllerApiResourcesSessionrecordingsV1Host';
|
||||
import {
|
||||
ControllerApiResourcesSessionrecordingsV1HostFromJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1HostFromJSONTyped,
|
||||
ControllerApiResourcesSessionrecordingsV1HostToJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1HostToJSONTyped,
|
||||
} from './ControllerApiResourcesSessionrecordingsV1Host';
|
||||
import type { ControllerApiResourcesSessionrecordingsV1Credential } from './ControllerApiResourcesSessionrecordingsV1Credential';
|
||||
import {
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialFromJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialFromJSONTyped,
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialToJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialToJSONTyped,
|
||||
} from './ControllerApiResourcesSessionrecordingsV1Credential';
|
||||
import type { ControllerApiResourcesSessionrecordingsV1CredentialLibrary } from './ControllerApiResourcesSessionrecordingsV1CredentialLibrary';
|
||||
import {
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialLibraryFromJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialLibraryFromJSONTyped,
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialLibraryToJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1CredentialLibraryToJSONTyped,
|
||||
} from './ControllerApiResourcesSessionrecordingsV1CredentialLibrary';
|
||||
import type { ControllerApiResourcesSessionrecordingsV1Target } from './ControllerApiResourcesSessionrecordingsV1Target';
|
||||
import {
|
||||
ControllerApiResourcesSessionrecordingsV1TargetFromJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1TargetFromJSONTyped,
|
||||
ControllerApiResourcesSessionrecordingsV1TargetToJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1TargetToJSONTyped,
|
||||
} from './ControllerApiResourcesSessionrecordingsV1Target';
|
||||
import type { ControllerApiResourcesSessionrecordingsV1User } from './ControllerApiResourcesSessionrecordingsV1User';
|
||||
import {
|
||||
ControllerApiResourcesSessionrecordingsV1UserFromJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1UserFromJSONTyped,
|
||||
ControllerApiResourcesSessionrecordingsV1UserToJSON,
|
||||
ControllerApiResourcesSessionrecordingsV1UserToJSONTyped,
|
||||
} from './ControllerApiResourcesSessionrecordingsV1User';
|
||||
|
||||
/**
|
||||
* ValuesAtTime contain information about other Boundary resources as they
|
||||
* were at a certain time through the lifetime of the Session Recording.
|
||||
* @export
|
||||
* @interface ControllerApiResourcesSessionrecordingsV1ValuesAtTime
|
||||
*/
|
||||
export interface ControllerApiResourcesSessionrecordingsV1ValuesAtTime {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesSessionrecordingsV1User}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ValuesAtTime
|
||||
*/
|
||||
user?: ControllerApiResourcesSessionrecordingsV1User;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesSessionrecordingsV1Target}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ValuesAtTime
|
||||
*/
|
||||
target?: ControllerApiResourcesSessionrecordingsV1Target;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesSessionrecordingsV1Host}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ValuesAtTime
|
||||
*/
|
||||
host?: ControllerApiResourcesSessionrecordingsV1Host;
|
||||
/**
|
||||
* Information about the Credentials used for this session.
|
||||
* @type {Array<ControllerApiResourcesSessionrecordingsV1Credential>}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ValuesAtTime
|
||||
*/
|
||||
credentials?: Array<ControllerApiResourcesSessionrecordingsV1Credential>;
|
||||
/**
|
||||
* Information about the Credential Libraries used for this session.
|
||||
* @type {Array<ControllerApiResourcesSessionrecordingsV1CredentialLibrary>}
|
||||
* @memberof ControllerApiResourcesSessionrecordingsV1ValuesAtTime
|
||||
*/
|
||||
credentialLibraries?: Array<ControllerApiResourcesSessionrecordingsV1CredentialLibrary>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesSessionrecordingsV1ValuesAtTime interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesSessionrecordingsV1ValuesAtTime(value: object): value is ControllerApiResourcesSessionrecordingsV1ValuesAtTime {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1ValuesAtTimeFromJSON(json: any): ControllerApiResourcesSessionrecordingsV1ValuesAtTime {
|
||||
return ControllerApiResourcesSessionrecordingsV1ValuesAtTimeFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1ValuesAtTimeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesSessionrecordingsV1ValuesAtTime {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'user': json['user'] == null ? undefined : ControllerApiResourcesSessionrecordingsV1UserFromJSON(json['user']),
|
||||
'target': json['target'] == null ? undefined : ControllerApiResourcesSessionrecordingsV1TargetFromJSON(json['target']),
|
||||
'host': json['host'] == null ? undefined : ControllerApiResourcesSessionrecordingsV1HostFromJSON(json['host']),
|
||||
'credentials': json['credentials'] == null ? undefined : ((json['credentials'] as Array<any>).map(ControllerApiResourcesSessionrecordingsV1CredentialFromJSON)),
|
||||
'credentialLibraries': json['credential_libraries'] == null ? undefined : ((json['credential_libraries'] as Array<any>).map(ControllerApiResourcesSessionrecordingsV1CredentialLibraryFromJSON)),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1ValuesAtTimeToJSON(json: any): ControllerApiResourcesSessionrecordingsV1ValuesAtTime {
|
||||
return ControllerApiResourcesSessionrecordingsV1ValuesAtTimeToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionrecordingsV1ValuesAtTimeToJSONTyped(value?: ControllerApiResourcesSessionrecordingsV1ValuesAtTime | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'user': ControllerApiResourcesSessionrecordingsV1UserToJSON(value['user']),
|
||||
'target': ControllerApiResourcesSessionrecordingsV1TargetToJSON(value['target']),
|
||||
'host': ControllerApiResourcesSessionrecordingsV1HostToJSON(value['host']),
|
||||
'credentials': value['credentials'] == null ? undefined : ((value['credentials'] as Array<any>).map(ControllerApiResourcesSessionrecordingsV1CredentialToJSON)),
|
||||
'credential_libraries': value['credentialLibraries'] == null ? undefined : ((value['credentialLibraries'] as Array<any>).map(ControllerApiResourcesSessionrecordingsV1CredentialLibraryToJSON)),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,113 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesSessionsV1Connection
|
||||
*/
|
||||
export interface ControllerApiResourcesSessionsV1Connection {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Connection
|
||||
*/
|
||||
clientTcpAddress?: string;
|
||||
/**
|
||||
*
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesSessionsV1Connection
|
||||
*/
|
||||
clientTcpPort?: number;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Connection
|
||||
*/
|
||||
endpointTcpAddress?: string;
|
||||
/**
|
||||
*
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesSessionsV1Connection
|
||||
*/
|
||||
endpointTcpPort?: number;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Connection
|
||||
*/
|
||||
bytesUp?: string;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Connection
|
||||
*/
|
||||
bytesDown?: string;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Connection
|
||||
*/
|
||||
closedReason?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesSessionsV1Connection interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesSessionsV1Connection(value: object): value is ControllerApiResourcesSessionsV1Connection {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionsV1ConnectionFromJSON(json: any): ControllerApiResourcesSessionsV1Connection {
|
||||
return ControllerApiResourcesSessionsV1ConnectionFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionsV1ConnectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesSessionsV1Connection {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'clientTcpAddress': json['client_tcp_address'] == null ? undefined : json['client_tcp_address'],
|
||||
'clientTcpPort': json['client_tcp_port'] == null ? undefined : json['client_tcp_port'],
|
||||
'endpointTcpAddress': json['endpoint_tcp_address'] == null ? undefined : json['endpoint_tcp_address'],
|
||||
'endpointTcpPort': json['endpoint_tcp_port'] == null ? undefined : json['endpoint_tcp_port'],
|
||||
'bytesUp': json['bytes_up'] == null ? undefined : json['bytes_up'],
|
||||
'bytesDown': json['bytes_down'] == null ? undefined : json['bytes_down'],
|
||||
'closedReason': json['closed_reason'] == null ? undefined : json['closed_reason'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionsV1ConnectionToJSON(json: any): ControllerApiResourcesSessionsV1Connection {
|
||||
return ControllerApiResourcesSessionsV1ConnectionToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionsV1ConnectionToJSONTyped(value?: ControllerApiResourcesSessionsV1Connection | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'client_tcp_address': value['clientTcpAddress'],
|
||||
'client_tcp_port': value['clientTcpPort'],
|
||||
'endpoint_tcp_address': value['endpointTcpAddress'],
|
||||
'endpoint_tcp_port': value['endpointTcpPort'],
|
||||
'bytes_up': value['bytesUp'],
|
||||
'bytes_down': value['bytesDown'],
|
||||
'closed_reason': value['closedReason'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,221 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesSessionsV1Connection } from './ControllerApiResourcesSessionsV1Connection';
|
||||
import {
|
||||
ControllerApiResourcesSessionsV1ConnectionFromJSON,
|
||||
ControllerApiResourcesSessionsV1ConnectionFromJSONTyped,
|
||||
ControllerApiResourcesSessionsV1ConnectionToJSON,
|
||||
ControllerApiResourcesSessionsV1ConnectionToJSONTyped,
|
||||
} from './ControllerApiResourcesSessionsV1Connection';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import type { ControllerApiResourcesSessionsV1SessionState } from './ControllerApiResourcesSessionsV1SessionState';
|
||||
import {
|
||||
ControllerApiResourcesSessionsV1SessionStateFromJSON,
|
||||
ControllerApiResourcesSessionsV1SessionStateFromJSONTyped,
|
||||
ControllerApiResourcesSessionsV1SessionStateToJSON,
|
||||
ControllerApiResourcesSessionsV1SessionStateToJSONTyped,
|
||||
} from './ControllerApiResourcesSessionsV1SessionState';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
export interface ControllerApiResourcesSessionsV1Session {
|
||||
/**
|
||||
* Output only. The ID of the Session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* Output only. The ID of the Target that created this Session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly targetId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used when canceling this Session to ensure that the operation is acting on a known session state.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* Output only. Type of the Session (e.g. tcp).
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly type?: string;
|
||||
/**
|
||||
* Output only. After this time the connection will be expired, e.g. forcefully terminated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly expirationTime?: Date;
|
||||
/**
|
||||
* Output only. The ID of the Auth Token used to authenticate.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly authTokenId?: string;
|
||||
/**
|
||||
* Output only. The ID of the User that requested the Session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly userId?: string;
|
||||
/**
|
||||
* Output only. The Host Set sourcing the Host for this Session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly hostSetId?: string;
|
||||
/**
|
||||
* Output only. The Host used by the Session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly hostId?: string;
|
||||
/**
|
||||
* Output only. The Scope of the Session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly scopeId?: string;
|
||||
/**
|
||||
* Output only. The endpoint of the Session; that is, the address to which the worker is proxying data.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly endpoint?: string;
|
||||
/**
|
||||
* Output only. The states of this Session in descending order from the current state to the first.
|
||||
* @type {Array<ControllerApiResourcesSessionsV1SessionState>}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly states?: Array<ControllerApiResourcesSessionsV1SessionState>;
|
||||
/**
|
||||
* Output only. The current status of this Session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly status?: string;
|
||||
/**
|
||||
* Output only. The certificate generated for the session. Raw DER bytes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly certificate?: string;
|
||||
/**
|
||||
* Output only. If the session is terminated, this provides a short description as to why.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly terminationReason?: string;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
/**
|
||||
* Output only. The associated connections with this session.
|
||||
* @type {Array<ControllerApiResourcesSessionsV1Connection>}
|
||||
* @memberof ControllerApiResourcesSessionsV1Session
|
||||
*/
|
||||
readonly connections?: Array<ControllerApiResourcesSessionsV1Connection>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesSessionsV1Session interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesSessionsV1Session(value: object): value is ControllerApiResourcesSessionsV1Session {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionsV1SessionFromJSON(json: any): ControllerApiResourcesSessionsV1Session {
|
||||
return ControllerApiResourcesSessionsV1SessionFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionsV1SessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesSessionsV1Session {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'targetId': json['target_id'] == null ? undefined : json['target_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'expirationTime': json['expiration_time'] == null ? undefined : (new Date(json['expiration_time'])),
|
||||
'authTokenId': json['auth_token_id'] == null ? undefined : json['auth_token_id'],
|
||||
'userId': json['user_id'] == null ? undefined : json['user_id'],
|
||||
'hostSetId': json['host_set_id'] == null ? undefined : json['host_set_id'],
|
||||
'hostId': json['host_id'] == null ? undefined : json['host_id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'endpoint': json['endpoint'] == null ? undefined : json['endpoint'],
|
||||
'states': json['states'] == null ? undefined : ((json['states'] as Array<any>).map(ControllerApiResourcesSessionsV1SessionStateFromJSON)),
|
||||
'status': json['status'] == null ? undefined : json['status'],
|
||||
'certificate': json['certificate'] == null ? undefined : json['certificate'],
|
||||
'terminationReason': json['termination_reason'] == null ? undefined : json['termination_reason'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
'connections': json['connections'] == null ? undefined : ((json['connections'] as Array<any>).map(ControllerApiResourcesSessionsV1ConnectionFromJSON)),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionsV1SessionToJSON(json: any): ControllerApiResourcesSessionsV1Session {
|
||||
return ControllerApiResourcesSessionsV1SessionToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionsV1SessionToJSONTyped(value?: Omit<ControllerApiResourcesSessionsV1Session, 'id'|'target_id'|'created_time'|'updated_time'|'type'|'expiration_time'|'auth_token_id'|'user_id'|'host_set_id'|'host_id'|'scope_id'|'endpoint'|'states'|'status'|'certificate'|'termination_reason'|'authorized_actions'|'connections'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'version': value['version'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,79 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesSessionsV1SessionState
|
||||
*/
|
||||
export interface ControllerApiResourcesSessionsV1SessionState {
|
||||
/**
|
||||
* The status of the Session, e.g. "pending", "active", "canceling", "terminated".
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesSessionsV1SessionState
|
||||
*/
|
||||
status?: string;
|
||||
/**
|
||||
* Output only. The time the Session entered this state.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionsV1SessionState
|
||||
*/
|
||||
readonly startTime?: Date;
|
||||
/**
|
||||
* Output only. The time the Session stopped being in this state.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesSessionsV1SessionState
|
||||
*/
|
||||
readonly endTime?: Date;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesSessionsV1SessionState interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesSessionsV1SessionState(value: object): value is ControllerApiResourcesSessionsV1SessionState {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionsV1SessionStateFromJSON(json: any): ControllerApiResourcesSessionsV1SessionState {
|
||||
return ControllerApiResourcesSessionsV1SessionStateFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionsV1SessionStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesSessionsV1SessionState {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'status': json['status'] == null ? undefined : json['status'],
|
||||
'startTime': json['start_time'] == null ? undefined : (new Date(json['start_time'])),
|
||||
'endTime': json['end_time'] == null ? undefined : (new Date(json['end_time'])),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionsV1SessionStateToJSON(json: any): ControllerApiResourcesSessionsV1SessionState {
|
||||
return ControllerApiResourcesSessionsV1SessionStateToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesSessionsV1SessionStateToJSONTyped(value?: Omit<ControllerApiResourcesSessionsV1SessionState, 'start_time'|'end_time'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'status': value['status'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,220 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesPluginsV1PluginInfo } from './ControllerApiResourcesPluginsV1PluginInfo';
|
||||
import {
|
||||
ControllerApiResourcesPluginsV1PluginInfoFromJSON,
|
||||
ControllerApiResourcesPluginsV1PluginInfoFromJSONTyped,
|
||||
ControllerApiResourcesPluginsV1PluginInfoToJSON,
|
||||
ControllerApiResourcesPluginsV1PluginInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesPluginsV1PluginInfo';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
export interface ControllerApiResourcesStoragebucketsV1StorageBucket {
|
||||
/**
|
||||
* Output only. The ID of the storage bucket.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The ID of the Scope of which this storage bucket is a part.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* The ID of the plugin of which this storage bucket is created.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
pluginId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesPluginsV1PluginInfo}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
plugin?: ControllerApiResourcesPluginsV1PluginInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* The name of the bucket within the external object store service.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
bucketName?: string;
|
||||
/**
|
||||
* The prefix used to organize the data held within the external object store.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
bucketPrefix?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The type of Storage Bucket (currently only plugin).
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* Attributes specific to the catalog type.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* Secrets specific to the storage bucket type. These are never output.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
secrets?: object;
|
||||
/**
|
||||
* Output only. The HMAC of the last secrets supplied via the API, if any.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
readonly secretsHmac?: string;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
workerFilter?: string;
|
||||
/**
|
||||
* Internal use only. The storage bucket credential id for this storage bucket.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
storageBucketCredentialId?: string;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesStoragebucketsV1StorageBucket
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesStoragebucketsV1StorageBucket interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesStoragebucketsV1StorageBucket(value: object): value is ControllerApiResourcesStoragebucketsV1StorageBucket {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesStoragebucketsV1StorageBucketFromJSON(json: any): ControllerApiResourcesStoragebucketsV1StorageBucket {
|
||||
return ControllerApiResourcesStoragebucketsV1StorageBucketFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesStoragebucketsV1StorageBucketFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesStoragebucketsV1StorageBucket {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'pluginId': json['plugin_id'] == null ? undefined : json['plugin_id'],
|
||||
'plugin': json['plugin'] == null ? undefined : ControllerApiResourcesPluginsV1PluginInfoFromJSON(json['plugin']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'bucketName': json['bucket_name'] == null ? undefined : json['bucket_name'],
|
||||
'bucketPrefix': json['bucket_prefix'] == null ? undefined : json['bucket_prefix'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'secrets': json['secrets'] == null ? undefined : json['secrets'],
|
||||
'secretsHmac': json['secrets_hmac'] == null ? undefined : json['secrets_hmac'],
|
||||
'workerFilter': json['worker_filter'] == null ? undefined : json['worker_filter'],
|
||||
'storageBucketCredentialId': json['storage_bucket_credential_id'] == null ? undefined : json['storage_bucket_credential_id'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesStoragebucketsV1StorageBucketToJSON(json: any): ControllerApiResourcesStoragebucketsV1StorageBucket {
|
||||
return ControllerApiResourcesStoragebucketsV1StorageBucketToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesStoragebucketsV1StorageBucketToJSONTyped(value?: Omit<ControllerApiResourcesStoragebucketsV1StorageBucket, 'id'|'created_time'|'updated_time'|'secrets_hmac'|'authorized_actions'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope_id': value['scopeId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'plugin_id': value['pluginId'],
|
||||
'plugin': ControllerApiResourcesPluginsV1PluginInfoToJSON(value['plugin']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'bucket_name': value['bucketName'],
|
||||
'bucket_prefix': value['bucketPrefix'],
|
||||
'version': value['version'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
'secrets': value['secrets'],
|
||||
'worker_filter': value['workerFilter'],
|
||||
'storage_bucket_credential_id': value['storageBucketCredentialId'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,96 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesTargetsV1TargetAliasAttributes } from './ControllerApiResourcesTargetsV1TargetAliasAttributes';
|
||||
import {
|
||||
ControllerApiResourcesTargetsV1TargetAliasAttributesFromJSON,
|
||||
ControllerApiResourcesTargetsV1TargetAliasAttributesFromJSONTyped,
|
||||
ControllerApiResourcesTargetsV1TargetAliasAttributesToJSON,
|
||||
ControllerApiResourcesTargetsV1TargetAliasAttributesToJSONTyped,
|
||||
} from './ControllerApiResourcesTargetsV1TargetAliasAttributes';
|
||||
|
||||
/**
|
||||
* Alias is the alias information related to the aliases associated with the target.
|
||||
* @export
|
||||
* @interface ControllerApiResourcesTargetsV1Alias
|
||||
*/
|
||||
export interface ControllerApiResourcesTargetsV1Alias {
|
||||
/**
|
||||
* Output only. The ID of the alias referencing this target.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1Alias
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* Ouput only. The value of the alias referencing this target.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1Alias
|
||||
*/
|
||||
value?: string;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1Alias
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesTargetsV1TargetAliasAttributes}
|
||||
* @memberof ControllerApiResourcesTargetsV1Alias
|
||||
*/
|
||||
attributes?: ControllerApiResourcesTargetsV1TargetAliasAttributes;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesTargetsV1Alias interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesTargetsV1Alias(value: object): value is ControllerApiResourcesTargetsV1Alias {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1AliasFromJSON(json: any): ControllerApiResourcesTargetsV1Alias {
|
||||
return ControllerApiResourcesTargetsV1AliasFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1AliasFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesTargetsV1Alias {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'value': json['value'] == null ? undefined : json['value'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'attributes': json['attributes'] == null ? undefined : ControllerApiResourcesTargetsV1TargetAliasAttributesFromJSON(json['attributes']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1AliasToJSON(json: any): ControllerApiResourcesTargetsV1Alias {
|
||||
return ControllerApiResourcesTargetsV1AliasToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1AliasToJSONTyped(value?: Omit<ControllerApiResourcesTargetsV1Alias, 'id'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'value': value['value'],
|
||||
'scope_id': value['scopeId'],
|
||||
'attributes': ControllerApiResourcesTargetsV1TargetAliasAttributesToJSON(value['attributes']),
|
||||
};
|
||||
}
|
||||
|
||||
+70
@@ -0,0 +1,70 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesTargetsV1AuthorizeSessionArguments
|
||||
*/
|
||||
export interface ControllerApiResourcesTargetsV1AuthorizeSessionArguments {
|
||||
/**
|
||||
* host_id is the id of the host that the session will be authorized for.
|
||||
* When specified authorizing a session using this alias will have the same
|
||||
* effect of authorizing a session to the alias' destination_id and passing
|
||||
* in this value through the -host-id flag. If the host-id flag is also
|
||||
* specified when calling authorize-session an error will be returned unless
|
||||
* the provided host-id matches this value.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1AuthorizeSessionArguments
|
||||
*/
|
||||
hostId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesTargetsV1AuthorizeSessionArguments interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesTargetsV1AuthorizeSessionArguments(value: object): value is ControllerApiResourcesTargetsV1AuthorizeSessionArguments {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1AuthorizeSessionArgumentsFromJSON(json: any): ControllerApiResourcesTargetsV1AuthorizeSessionArguments {
|
||||
return ControllerApiResourcesTargetsV1AuthorizeSessionArgumentsFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1AuthorizeSessionArgumentsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesTargetsV1AuthorizeSessionArguments {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'hostId': json['host_id'] == null ? undefined : json['host_id'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1AuthorizeSessionArgumentsToJSON(json: any): ControllerApiResourcesTargetsV1AuthorizeSessionArguments {
|
||||
return ControllerApiResourcesTargetsV1AuthorizeSessionArgumentsToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1AuthorizeSessionArgumentsToJSONTyped(value?: ControllerApiResourcesTargetsV1AuthorizeSessionArguments | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'host_id': value['hostId'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,100 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesTargetsV1CredentialSource
|
||||
*/
|
||||
export interface ControllerApiResourcesTargetsV1CredentialSource {
|
||||
/**
|
||||
* The ID of the Credential. May be empty if the credential is dynamically generated from a library.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1CredentialSource
|
||||
*/
|
||||
id?: string;
|
||||
/**
|
||||
* Output only. The name of the Credential source.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1CredentialSource
|
||||
*/
|
||||
readonly name?: string;
|
||||
/**
|
||||
* Output only. The description of the Credential source.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1CredentialSource
|
||||
*/
|
||||
readonly description?: string;
|
||||
/**
|
||||
* Output only. The Credential Store to which this Credential source belongs.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1CredentialSource
|
||||
*/
|
||||
readonly credentialStoreId?: string;
|
||||
/**
|
||||
* Output only. The type of the credential source (e.g. "vault"; not the type of the credential itself).
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1CredentialSource
|
||||
*/
|
||||
readonly type?: string;
|
||||
/**
|
||||
* Output only. The type of the credential, empty if unspecified.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1CredentialSource
|
||||
*/
|
||||
readonly credentialType?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesTargetsV1CredentialSource interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesTargetsV1CredentialSource(value: object): value is ControllerApiResourcesTargetsV1CredentialSource {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1CredentialSourceFromJSON(json: any): ControllerApiResourcesTargetsV1CredentialSource {
|
||||
return ControllerApiResourcesTargetsV1CredentialSourceFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1CredentialSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesTargetsV1CredentialSource {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'credentialStoreId': json['credential_store_id'] == null ? undefined : json['credential_store_id'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'credentialType': json['credential_type'] == null ? undefined : json['credential_type'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1CredentialSourceToJSON(json: any): ControllerApiResourcesTargetsV1CredentialSource {
|
||||
return ControllerApiResourcesTargetsV1CredentialSourceToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1CredentialSourceToJSONTyped(value?: Omit<ControllerApiResourcesTargetsV1CredentialSource, 'name'|'description'|'credential_store_id'|'type'|'credential_type'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'id': value['id'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesTargetsV1HostSource
|
||||
*/
|
||||
export interface ControllerApiResourcesTargetsV1HostSource {
|
||||
/**
|
||||
* Output only. The ID of the Host Set.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1HostSource
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* Output only. The Host Catalog to which this Host Source belongs.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1HostSource
|
||||
*/
|
||||
readonly hostCatalogId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesTargetsV1HostSource interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesTargetsV1HostSource(value: object): value is ControllerApiResourcesTargetsV1HostSource {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1HostSourceFromJSON(json: any): ControllerApiResourcesTargetsV1HostSource {
|
||||
return ControllerApiResourcesTargetsV1HostSourceFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1HostSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesTargetsV1HostSource {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'hostCatalogId': json['host_catalog_id'] == null ? undefined : json['host_catalog_id'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1HostSourceToJSON(json: any): ControllerApiResourcesTargetsV1HostSource {
|
||||
return ControllerApiResourcesTargetsV1HostSourceToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1HostSourceToJSONTyped(value?: Omit<ControllerApiResourcesTargetsV1HostSource, 'id'|'host_catalog_id'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,179 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesTargetsV1SessionCredential } from './ControllerApiResourcesTargetsV1SessionCredential';
|
||||
import {
|
||||
ControllerApiResourcesTargetsV1SessionCredentialFromJSON,
|
||||
ControllerApiResourcesTargetsV1SessionCredentialFromJSONTyped,
|
||||
ControllerApiResourcesTargetsV1SessionCredentialToJSON,
|
||||
ControllerApiResourcesTargetsV1SessionCredentialToJSONTyped,
|
||||
} from './ControllerApiResourcesTargetsV1SessionCredential';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
* SessionAuthorization contains all fields related to authorization for a Session. It's in the Targets package because it's returned by a Target's authorize action.
|
||||
* @export
|
||||
* @interface ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
export interface ControllerApiResourcesTargetsV1SessionAuthorization {
|
||||
/**
|
||||
* Output only. The ID of the Session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
readonly sessionId?: string;
|
||||
/**
|
||||
* Output only. The ID of the Target authorizing this Session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
readonly targetId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The User for which this Session was authorized.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
readonly userId?: string;
|
||||
/**
|
||||
* Output only. The Host Set containing the Host being used for this Session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
readonly hostSetId?: string;
|
||||
/**
|
||||
* Output only. The Host whose address is being used as the endpoint for this Session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
readonly hostId?: string;
|
||||
/**
|
||||
* Output only. Type of the Session (e.g. tcp, ssh, etc.).
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
readonly type?: string;
|
||||
/**
|
||||
* Output only. The marshaled SessionAuthorizationData message containing all information that the proxy needs.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
readonly authorizationToken?: string;
|
||||
/**
|
||||
* Output only. The connection limit being applied to this session. -1 means unlimited. This is not actually enforced on the client side but it provides for better listener handling by including it.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
readonly connectionLimit?: number;
|
||||
/**
|
||||
* Output only. The endpoint address that the worker will connect to, useful for setting TLS parameters.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
readonly endpoint?: string;
|
||||
/**
|
||||
* Output only. The endpoint port that will be connected to, either from a
|
||||
* port directly on the target or from a service definition.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
readonly endpointPort?: number;
|
||||
/**
|
||||
* Output only. The expiration time of the session.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
readonly expiration?: Date;
|
||||
/**
|
||||
* Output only. The credentials for this session.
|
||||
* @type {Array<ControllerApiResourcesTargetsV1SessionCredential>}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
readonly credentials?: Array<ControllerApiResourcesTargetsV1SessionCredential>;
|
||||
/**
|
||||
* Output only. The ID of the Session Recording.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionAuthorization
|
||||
*/
|
||||
readonly sessionRecordingId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesTargetsV1SessionAuthorization interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesTargetsV1SessionAuthorization(value: object): value is ControllerApiResourcesTargetsV1SessionAuthorization {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1SessionAuthorizationFromJSON(json: any): ControllerApiResourcesTargetsV1SessionAuthorization {
|
||||
return ControllerApiResourcesTargetsV1SessionAuthorizationFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1SessionAuthorizationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesTargetsV1SessionAuthorization {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'sessionId': json['session_id'] == null ? undefined : json['session_id'],
|
||||
'targetId': json['target_id'] == null ? undefined : json['target_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'userId': json['user_id'] == null ? undefined : json['user_id'],
|
||||
'hostSetId': json['host_set_id'] == null ? undefined : json['host_set_id'],
|
||||
'hostId': json['host_id'] == null ? undefined : json['host_id'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'authorizationToken': json['authorization_token'] == null ? undefined : json['authorization_token'],
|
||||
'connectionLimit': json['connection_limit'] == null ? undefined : json['connection_limit'],
|
||||
'endpoint': json['endpoint'] == null ? undefined : json['endpoint'],
|
||||
'endpointPort': json['endpoint_port'] == null ? undefined : json['endpoint_port'],
|
||||
'expiration': json['expiration'] == null ? undefined : (new Date(json['expiration'])),
|
||||
'credentials': json['credentials'] == null ? undefined : ((json['credentials'] as Array<any>).map(ControllerApiResourcesTargetsV1SessionCredentialFromJSON)),
|
||||
'sessionRecordingId': json['session_recording_id'] == null ? undefined : json['session_recording_id'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1SessionAuthorizationToJSON(json: any): ControllerApiResourcesTargetsV1SessionAuthorization {
|
||||
return ControllerApiResourcesTargetsV1SessionAuthorizationToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1SessionAuthorizationToJSONTyped(value?: Omit<ControllerApiResourcesTargetsV1SessionAuthorization, 'session_id'|'target_id'|'created_time'|'user_id'|'host_set_id'|'host_id'|'type'|'authorization_token'|'connection_limit'|'endpoint'|'endpoint_port'|'expiration'|'credentials'|'session_recording_id'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,96 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesTargetsV1CredentialSource } from './ControllerApiResourcesTargetsV1CredentialSource';
|
||||
import {
|
||||
ControllerApiResourcesTargetsV1CredentialSourceFromJSON,
|
||||
ControllerApiResourcesTargetsV1CredentialSourceFromJSONTyped,
|
||||
ControllerApiResourcesTargetsV1CredentialSourceToJSON,
|
||||
ControllerApiResourcesTargetsV1CredentialSourceToJSONTyped,
|
||||
} from './ControllerApiResourcesTargetsV1CredentialSource';
|
||||
import type { ControllerApiResourcesTargetsV1SessionSecret } from './ControllerApiResourcesTargetsV1SessionSecret';
|
||||
import {
|
||||
ControllerApiResourcesTargetsV1SessionSecretFromJSON,
|
||||
ControllerApiResourcesTargetsV1SessionSecretFromJSONTyped,
|
||||
ControllerApiResourcesTargetsV1SessionSecretToJSON,
|
||||
ControllerApiResourcesTargetsV1SessionSecretToJSONTyped,
|
||||
} from './ControllerApiResourcesTargetsV1SessionSecret';
|
||||
|
||||
/**
|
||||
* Credential information for a session.
|
||||
* @export
|
||||
* @interface ControllerApiResourcesTargetsV1SessionCredential
|
||||
*/
|
||||
export interface ControllerApiResourcesTargetsV1SessionCredential {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesTargetsV1CredentialSource}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionCredential
|
||||
*/
|
||||
credentialSource?: ControllerApiResourcesTargetsV1CredentialSource;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesTargetsV1SessionSecret}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionCredential
|
||||
*/
|
||||
secret?: ControllerApiResourcesTargetsV1SessionSecret;
|
||||
/**
|
||||
* Output only. The fields of the strongly typed credential, empty if the credential type of the
|
||||
* credential source is unspecified.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionCredential
|
||||
*/
|
||||
readonly credential?: object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesTargetsV1SessionCredential interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesTargetsV1SessionCredential(value: object): value is ControllerApiResourcesTargetsV1SessionCredential {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1SessionCredentialFromJSON(json: any): ControllerApiResourcesTargetsV1SessionCredential {
|
||||
return ControllerApiResourcesTargetsV1SessionCredentialFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1SessionCredentialFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesTargetsV1SessionCredential {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'credentialSource': json['credential_source'] == null ? undefined : ControllerApiResourcesTargetsV1CredentialSourceFromJSON(json['credential_source']),
|
||||
'secret': json['secret'] == null ? undefined : ControllerApiResourcesTargetsV1SessionSecretFromJSON(json['secret']),
|
||||
'credential': json['credential'] == null ? undefined : json['credential'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1SessionCredentialToJSON(json: any): ControllerApiResourcesTargetsV1SessionCredential {
|
||||
return ControllerApiResourcesTargetsV1SessionCredentialToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1SessionCredentialToJSONTyped(value?: Omit<ControllerApiResourcesTargetsV1SessionCredential, 'credential'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'credential_source': ControllerApiResourcesTargetsV1CredentialSourceToJSON(value['credentialSource']),
|
||||
'secret': ControllerApiResourcesTargetsV1SessionSecretToJSON(value['secret']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,72 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
* The actual secret for a session credential.
|
||||
* @export
|
||||
* @interface ControllerApiResourcesTargetsV1SessionSecret
|
||||
*/
|
||||
export interface ControllerApiResourcesTargetsV1SessionSecret {
|
||||
/**
|
||||
* Output only. The base64-encoded value representing the raw bytes from the
|
||||
* credential provider.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionSecret
|
||||
*/
|
||||
readonly raw?: string;
|
||||
/**
|
||||
* Output only. The decoded raw string, if a JSON object.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesTargetsV1SessionSecret
|
||||
*/
|
||||
readonly decoded?: object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesTargetsV1SessionSecret interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesTargetsV1SessionSecret(value: object): value is ControllerApiResourcesTargetsV1SessionSecret {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1SessionSecretFromJSON(json: any): ControllerApiResourcesTargetsV1SessionSecret {
|
||||
return ControllerApiResourcesTargetsV1SessionSecretFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1SessionSecretFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesTargetsV1SessionSecret {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'raw': json['raw'] == null ? undefined : json['raw'],
|
||||
'decoded': json['decoded'] == null ? undefined : json['decoded'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1SessionSecretToJSON(json: any): ControllerApiResourcesTargetsV1SessionSecret {
|
||||
return ControllerApiResourcesTargetsV1SessionSecretToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1SessionSecretToJSONTyped(value?: Omit<ControllerApiResourcesTargetsV1SessionSecret, 'raw'|'decoded'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,279 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesTargetsV1HostSource } from './ControllerApiResourcesTargetsV1HostSource';
|
||||
import {
|
||||
ControllerApiResourcesTargetsV1HostSourceFromJSON,
|
||||
ControllerApiResourcesTargetsV1HostSourceFromJSONTyped,
|
||||
ControllerApiResourcesTargetsV1HostSourceToJSON,
|
||||
ControllerApiResourcesTargetsV1HostSourceToJSONTyped,
|
||||
} from './ControllerApiResourcesTargetsV1HostSource';
|
||||
import type { ControllerApiResourcesTargetsV1Alias } from './ControllerApiResourcesTargetsV1Alias';
|
||||
import {
|
||||
ControllerApiResourcesTargetsV1AliasFromJSON,
|
||||
ControllerApiResourcesTargetsV1AliasFromJSONTyped,
|
||||
ControllerApiResourcesTargetsV1AliasToJSON,
|
||||
ControllerApiResourcesTargetsV1AliasToJSONTyped,
|
||||
} from './ControllerApiResourcesTargetsV1Alias';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import type { ControllerApiResourcesTargetsV1CredentialSource } from './ControllerApiResourcesTargetsV1CredentialSource';
|
||||
import {
|
||||
ControllerApiResourcesTargetsV1CredentialSourceFromJSON,
|
||||
ControllerApiResourcesTargetsV1CredentialSourceFromJSONTyped,
|
||||
ControllerApiResourcesTargetsV1CredentialSourceToJSON,
|
||||
ControllerApiResourcesTargetsV1CredentialSourceToJSONTyped,
|
||||
} from './ControllerApiResourcesTargetsV1CredentialSource';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
export interface ControllerApiResourcesTargetsV1Target {
|
||||
/**
|
||||
* Output only. The ID of the resource.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Required name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The type of the Target.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* Output only. The IDs of the Host Sources associated with this Target.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
readonly hostSourceIds?: Array<string>;
|
||||
/**
|
||||
* Output only. The Host Sources associated with this Target.
|
||||
* @type {Array<ControllerApiResourcesTargetsV1HostSource>}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
readonly hostSources?: Array<ControllerApiResourcesTargetsV1HostSource>;
|
||||
/**
|
||||
* Maximum total lifetime of a created Session, in seconds.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
sessionMaxSeconds?: number;
|
||||
/**
|
||||
* Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
sessionConnectionLimit?: number;
|
||||
/**
|
||||
* Optional boolean expression to filter the workers that are allowed to satisfy this request.
|
||||
* Deprecated; use egress or ingress worker filters instead.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
workerFilter?: string;
|
||||
/**
|
||||
* Optional boolean expressions to filter the egress workers that are allowed to satisfy this request.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
egressWorkerFilter?: string;
|
||||
/**
|
||||
* Optional boolean expressions to filter the ingress workers that are allowed to satisfy this request.
|
||||
* Unsupported on OSS.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
ingressWorkerFilter?: string;
|
||||
/**
|
||||
* Output only. The IDs of the brokered credential source ids associated with this Target.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
readonly brokeredCredentialSourceIds?: Array<string>;
|
||||
/**
|
||||
* Output only. The brokered credential sources associated with this Target.
|
||||
* @type {Array<ControllerApiResourcesTargetsV1CredentialSource>}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
readonly brokeredCredentialSources?: Array<ControllerApiResourcesTargetsV1CredentialSource>;
|
||||
/**
|
||||
* Output only. The IDs of the injected application credential source ids associated with this Target.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
readonly injectedApplicationCredentialSourceIds?: Array<string>;
|
||||
/**
|
||||
* Output only. The injected application credential sources associated with this Target.
|
||||
* @type {Array<ControllerApiResourcesTargetsV1CredentialSource>}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
readonly injectedApplicationCredentialSources?: Array<ControllerApiResourcesTargetsV1CredentialSource>;
|
||||
/**
|
||||
* The attributes that are applicable for the specific Target.
|
||||
* @type {object}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
/**
|
||||
* Optional string value that represents a network resource and is used when establishing a session.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
address?: string;
|
||||
/**
|
||||
* Output only. The aliases that point to this Target.
|
||||
* @type {Array<ControllerApiResourcesTargetsV1Alias>}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
readonly aliases?: Array<ControllerApiResourcesTargetsV1Alias>;
|
||||
/**
|
||||
* Input only. with_aliases specify the aliases that should be created when
|
||||
* the target is created. This field is only usable at target creation time.
|
||||
* @type {Array<ControllerApiResourcesTargetsV1Alias>}
|
||||
* @memberof ControllerApiResourcesTargetsV1Target
|
||||
*/
|
||||
withAliases?: Array<ControllerApiResourcesTargetsV1Alias>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesTargetsV1Target interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesTargetsV1Target(value: object): value is ControllerApiResourcesTargetsV1Target {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1TargetFromJSON(json: any): ControllerApiResourcesTargetsV1Target {
|
||||
return ControllerApiResourcesTargetsV1TargetFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1TargetFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesTargetsV1Target {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'hostSourceIds': json['host_source_ids'] == null ? undefined : json['host_source_ids'],
|
||||
'hostSources': json['host_sources'] == null ? undefined : ((json['host_sources'] as Array<any>).map(ControllerApiResourcesTargetsV1HostSourceFromJSON)),
|
||||
'sessionMaxSeconds': json['session_max_seconds'] == null ? undefined : json['session_max_seconds'],
|
||||
'sessionConnectionLimit': json['session_connection_limit'] == null ? undefined : json['session_connection_limit'],
|
||||
'workerFilter': json['worker_filter'] == null ? undefined : json['worker_filter'],
|
||||
'egressWorkerFilter': json['egress_worker_filter'] == null ? undefined : json['egress_worker_filter'],
|
||||
'ingressWorkerFilter': json['ingress_worker_filter'] == null ? undefined : json['ingress_worker_filter'],
|
||||
'brokeredCredentialSourceIds': json['brokered_credential_source_ids'] == null ? undefined : json['brokered_credential_source_ids'],
|
||||
'brokeredCredentialSources': json['brokered_credential_sources'] == null ? undefined : ((json['brokered_credential_sources'] as Array<any>).map(ControllerApiResourcesTargetsV1CredentialSourceFromJSON)),
|
||||
'injectedApplicationCredentialSourceIds': json['injected_application_credential_source_ids'] == null ? undefined : json['injected_application_credential_source_ids'],
|
||||
'injectedApplicationCredentialSources': json['injected_application_credential_sources'] == null ? undefined : ((json['injected_application_credential_sources'] as Array<any>).map(ControllerApiResourcesTargetsV1CredentialSourceFromJSON)),
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
'address': json['address'] == null ? undefined : json['address'],
|
||||
'aliases': json['aliases'] == null ? undefined : ((json['aliases'] as Array<any>).map(ControllerApiResourcesTargetsV1AliasFromJSON)),
|
||||
'withAliases': json['with_aliases'] == null ? undefined : ((json['with_aliases'] as Array<any>).map(ControllerApiResourcesTargetsV1AliasFromJSON)),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1TargetToJSON(json: any): ControllerApiResourcesTargetsV1Target {
|
||||
return ControllerApiResourcesTargetsV1TargetToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1TargetToJSONTyped(value?: Omit<ControllerApiResourcesTargetsV1Target, 'id'|'created_time'|'updated_time'|'host_source_ids'|'host_sources'|'brokered_credential_source_ids'|'brokered_credential_sources'|'injected_application_credential_source_ids'|'injected_application_credential_sources'|'authorized_actions'|'aliases'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope_id': value['scopeId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
'type': value['type'],
|
||||
'session_max_seconds': value['sessionMaxSeconds'],
|
||||
'session_connection_limit': value['sessionConnectionLimit'],
|
||||
'worker_filter': value['workerFilter'],
|
||||
'egress_worker_filter': value['egressWorkerFilter'],
|
||||
'ingress_worker_filter': value['ingressWorkerFilter'],
|
||||
'attributes': value['attributes'],
|
||||
'address': value['address'],
|
||||
'with_aliases': value['withAliases'] == null ? undefined : ((value['withAliases'] as Array<any>).map(ControllerApiResourcesTargetsV1AliasToJSON)),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesTargetsV1AuthorizeSessionArguments } from './ControllerApiResourcesTargetsV1AuthorizeSessionArguments';
|
||||
import {
|
||||
ControllerApiResourcesTargetsV1AuthorizeSessionArgumentsFromJSON,
|
||||
ControllerApiResourcesTargetsV1AuthorizeSessionArgumentsFromJSONTyped,
|
||||
ControllerApiResourcesTargetsV1AuthorizeSessionArgumentsToJSON,
|
||||
ControllerApiResourcesTargetsV1AuthorizeSessionArgumentsToJSONTyped,
|
||||
} from './ControllerApiResourcesTargetsV1AuthorizeSessionArguments';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesTargetsV1TargetAliasAttributes
|
||||
*/
|
||||
export interface ControllerApiResourcesTargetsV1TargetAliasAttributes {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesTargetsV1AuthorizeSessionArguments}
|
||||
* @memberof ControllerApiResourcesTargetsV1TargetAliasAttributes
|
||||
*/
|
||||
authorizeSessionArguments?: ControllerApiResourcesTargetsV1AuthorizeSessionArguments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesTargetsV1TargetAliasAttributes interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesTargetsV1TargetAliasAttributes(value: object): value is ControllerApiResourcesTargetsV1TargetAliasAttributes {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1TargetAliasAttributesFromJSON(json: any): ControllerApiResourcesTargetsV1TargetAliasAttributes {
|
||||
return ControllerApiResourcesTargetsV1TargetAliasAttributesFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1TargetAliasAttributesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesTargetsV1TargetAliasAttributes {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'authorizeSessionArguments': json['authorize_session_arguments'] == null ? undefined : ControllerApiResourcesTargetsV1AuthorizeSessionArgumentsFromJSON(json['authorize_session_arguments']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1TargetAliasAttributesToJSON(json: any): ControllerApiResourcesTargetsV1TargetAliasAttributes {
|
||||
return ControllerApiResourcesTargetsV1TargetAliasAttributesToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesTargetsV1TargetAliasAttributesToJSONTyped(value?: ControllerApiResourcesTargetsV1TargetAliasAttributes | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'authorize_session_arguments': ControllerApiResourcesTargetsV1AuthorizeSessionArgumentsToJSON(value['authorizeSessionArguments']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesUsersV1Account
|
||||
*/
|
||||
export interface ControllerApiResourcesUsersV1Account {
|
||||
/**
|
||||
* Output only. The ID of the Account.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesUsersV1Account
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* Output only. The Scope containing the Account.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesUsersV1Account
|
||||
*/
|
||||
readonly scopeId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesUsersV1Account interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesUsersV1Account(value: object): value is ControllerApiResourcesUsersV1Account {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesUsersV1AccountFromJSON(json: any): ControllerApiResourcesUsersV1Account {
|
||||
return ControllerApiResourcesUsersV1AccountFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesUsersV1AccountFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesUsersV1Account {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesUsersV1AccountToJSON(json: any): ControllerApiResourcesUsersV1Account {
|
||||
return ControllerApiResourcesUsersV1AccountToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesUsersV1AccountToJSONTyped(value?: Omit<ControllerApiResourcesUsersV1Account, 'id'|'scope_id'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,183 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesUsersV1Account } from './ControllerApiResourcesUsersV1Account';
|
||||
import {
|
||||
ControllerApiResourcesUsersV1AccountFromJSON,
|
||||
ControllerApiResourcesUsersV1AccountFromJSONTyped,
|
||||
ControllerApiResourcesUsersV1AccountToJSON,
|
||||
ControllerApiResourcesUsersV1AccountToJSONTyped,
|
||||
} from './ControllerApiResourcesUsersV1Account';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
export interface ControllerApiResourcesUsersV1User {
|
||||
/**
|
||||
* Output only. The ID of the User.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The ID of the Scope this resource is in.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Optional name for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* Output only. Contains the list of Account IDs linked to this User.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
readonly accountIds?: Array<string>;
|
||||
/**
|
||||
* Output only. The Accounts linked to this User.
|
||||
* @type {Array<ControllerApiResourcesUsersV1Account>}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
readonly accounts?: Array<ControllerApiResourcesUsersV1Account>;
|
||||
/**
|
||||
* Output only. The available actions on this resource for this user.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
readonly loginName?: string;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
readonly fullName?: string;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
readonly email?: string;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesUsersV1User
|
||||
*/
|
||||
readonly primaryAccountId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesUsersV1User interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesUsersV1User(value: object): value is ControllerApiResourcesUsersV1User {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesUsersV1UserFromJSON(json: any): ControllerApiResourcesUsersV1User {
|
||||
return ControllerApiResourcesUsersV1UserFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesUsersV1UserFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesUsersV1User {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'accountIds': json['account_ids'] == null ? undefined : json['account_ids'],
|
||||
'accounts': json['accounts'] == null ? undefined : ((json['accounts'] as Array<any>).map(ControllerApiResourcesUsersV1AccountFromJSON)),
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
'loginName': json['login_name'] == null ? undefined : json['login_name'],
|
||||
'fullName': json['full_name'] == null ? undefined : json['full_name'],
|
||||
'email': json['email'] == null ? undefined : json['email'],
|
||||
'primaryAccountId': json['primary_account_id'] == null ? undefined : json['primary_account_id'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesUsersV1UserToJSON(json: any): ControllerApiResourcesUsersV1User {
|
||||
return ControllerApiResourcesUsersV1UserToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesUsersV1UserToJSONTyped(value?: Omit<ControllerApiResourcesUsersV1User, 'id'|'created_time'|'updated_time'|'account_ids'|'accounts'|'authorized_actions'|'login_name'|'full_name'|'email'|'primary_account_id'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope_id': value['scopeId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,85 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesWorkersV1Certificate
|
||||
*/
|
||||
export interface ControllerApiResourcesWorkersV1Certificate {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1Certificate
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1Certificate
|
||||
*/
|
||||
readonly publicKeySha256?: string;
|
||||
/**
|
||||
*
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesWorkersV1Certificate
|
||||
*/
|
||||
readonly notBeforeTime?: Date;
|
||||
/**
|
||||
*
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesWorkersV1Certificate
|
||||
*/
|
||||
readonly notAfterTime?: Date;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesWorkersV1Certificate interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesWorkersV1Certificate(value: object): value is ControllerApiResourcesWorkersV1Certificate {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1CertificateFromJSON(json: any): ControllerApiResourcesWorkersV1Certificate {
|
||||
return ControllerApiResourcesWorkersV1CertificateFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1CertificateFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesWorkersV1Certificate {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'publicKeySha256': json['public_key_sha256'] == null ? undefined : json['public_key_sha256'],
|
||||
'notBeforeTime': json['not_before_time'] == null ? undefined : (new Date(json['not_before_time'])),
|
||||
'notAfterTime': json['not_after_time'] == null ? undefined : (new Date(json['not_after_time'])),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1CertificateToJSON(json: any): ControllerApiResourcesWorkersV1Certificate {
|
||||
return ControllerApiResourcesWorkersV1CertificateToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1CertificateToJSONTyped(value?: Omit<ControllerApiResourcesWorkersV1Certificate, 'id'|'public_key_sha256'|'not_before_time'|'not_after_time'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesWorkersV1Certificate } from './ControllerApiResourcesWorkersV1Certificate';
|
||||
import {
|
||||
ControllerApiResourcesWorkersV1CertificateFromJSON,
|
||||
ControllerApiResourcesWorkersV1CertificateFromJSONTyped,
|
||||
ControllerApiResourcesWorkersV1CertificateToJSON,
|
||||
ControllerApiResourcesWorkersV1CertificateToJSONTyped,
|
||||
} from './ControllerApiResourcesWorkersV1Certificate';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesWorkersV1CertificateAuthority
|
||||
*/
|
||||
export interface ControllerApiResourcesWorkersV1CertificateAuthority {
|
||||
/**
|
||||
*
|
||||
* @type {Array<ControllerApiResourcesWorkersV1Certificate>}
|
||||
* @memberof ControllerApiResourcesWorkersV1CertificateAuthority
|
||||
*/
|
||||
certs?: Array<ControllerApiResourcesWorkersV1Certificate>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesWorkersV1CertificateAuthority interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesWorkersV1CertificateAuthority(value: object): value is ControllerApiResourcesWorkersV1CertificateAuthority {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1CertificateAuthorityFromJSON(json: any): ControllerApiResourcesWorkersV1CertificateAuthority {
|
||||
return ControllerApiResourcesWorkersV1CertificateAuthorityFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1CertificateAuthorityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesWorkersV1CertificateAuthority {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'certs': json['certs'] == null ? undefined : ((json['certs'] as Array<any>).map(ControllerApiResourcesWorkersV1CertificateFromJSON)),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1CertificateAuthorityToJSON(json: any): ControllerApiResourcesWorkersV1CertificateAuthority {
|
||||
return ControllerApiResourcesWorkersV1CertificateAuthorityToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1CertificateAuthorityToJSONTyped(value?: ControllerApiResourcesWorkersV1CertificateAuthority | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'certs': value['certs'] == null ? undefined : ((value['certs'] as Array<any>).map(ControllerApiResourcesWorkersV1CertificateToJSON)),
|
||||
};
|
||||
}
|
||||
|
||||
+81
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesWorkersV1RemoteStoragePermissions
|
||||
*/
|
||||
export interface ControllerApiResourcesWorkersV1RemoteStoragePermissions {
|
||||
/**
|
||||
* Output only. The status of the write permission state for the given storage bucket.
|
||||
* Possible values are: unknown, error, and ok.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1RemoteStoragePermissions
|
||||
*/
|
||||
readonly write?: string;
|
||||
/**
|
||||
* Output only. The status of the read permission state for the given storage bucket.
|
||||
* Possible values are: unknown, error, and ok.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1RemoteStoragePermissions
|
||||
*/
|
||||
readonly read?: string;
|
||||
/**
|
||||
* Output only. The status of the delete permission state for the given storage bucket.
|
||||
* Possible values are: unknown, error, and ok.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1RemoteStoragePermissions
|
||||
*/
|
||||
readonly _delete?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesWorkersV1RemoteStoragePermissions interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesWorkersV1RemoteStoragePermissions(value: object): value is ControllerApiResourcesWorkersV1RemoteStoragePermissions {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1RemoteStoragePermissionsFromJSON(json: any): ControllerApiResourcesWorkersV1RemoteStoragePermissions {
|
||||
return ControllerApiResourcesWorkersV1RemoteStoragePermissionsFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1RemoteStoragePermissionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesWorkersV1RemoteStoragePermissions {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'write': json['write'] == null ? undefined : json['write'],
|
||||
'read': json['read'] == null ? undefined : json['read'],
|
||||
'_delete': json['delete'] == null ? undefined : json['delete'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1RemoteStoragePermissionsToJSON(json: any): ControllerApiResourcesWorkersV1RemoteStoragePermissions {
|
||||
return ControllerApiResourcesWorkersV1RemoteStoragePermissionsToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1RemoteStoragePermissionsToJSONTyped(value?: Omit<ControllerApiResourcesWorkersV1RemoteStoragePermissions, 'write'|'read'|'delete'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,82 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesWorkersV1RemoteStoragePermissions } from './ControllerApiResourcesWorkersV1RemoteStoragePermissions';
|
||||
import {
|
||||
ControllerApiResourcesWorkersV1RemoteStoragePermissionsFromJSON,
|
||||
ControllerApiResourcesWorkersV1RemoteStoragePermissionsFromJSONTyped,
|
||||
ControllerApiResourcesWorkersV1RemoteStoragePermissionsToJSON,
|
||||
ControllerApiResourcesWorkersV1RemoteStoragePermissionsToJSONTyped,
|
||||
} from './ControllerApiResourcesWorkersV1RemoteStoragePermissions';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesWorkersV1RemoteStorageState
|
||||
*/
|
||||
export interface ControllerApiResourcesWorkersV1RemoteStorageState {
|
||||
/**
|
||||
* Output only. The overall health status of the storage bucket. The possible values include: error and available.
|
||||
* The status exists in an available state if each remote storage permission state does not have an error. An unknown remote
|
||||
* storage permission state does not affect the overall health status.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1RemoteStorageState
|
||||
*/
|
||||
readonly status?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesWorkersV1RemoteStoragePermissions}
|
||||
* @memberof ControllerApiResourcesWorkersV1RemoteStorageState
|
||||
*/
|
||||
permissions?: ControllerApiResourcesWorkersV1RemoteStoragePermissions;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesWorkersV1RemoteStorageState interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesWorkersV1RemoteStorageState(value: object): value is ControllerApiResourcesWorkersV1RemoteStorageState {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1RemoteStorageStateFromJSON(json: any): ControllerApiResourcesWorkersV1RemoteStorageState {
|
||||
return ControllerApiResourcesWorkersV1RemoteStorageStateFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1RemoteStorageStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesWorkersV1RemoteStorageState {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'status': json['status'] == null ? undefined : json['status'],
|
||||
'permissions': json['permissions'] == null ? undefined : ControllerApiResourcesWorkersV1RemoteStoragePermissionsFromJSON(json['permissions']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1RemoteStorageStateToJSON(json: any): ControllerApiResourcesWorkersV1RemoteStorageState {
|
||||
return ControllerApiResourcesWorkersV1RemoteStorageStateToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1RemoteStorageStateToJSONTyped(value?: Omit<ControllerApiResourcesWorkersV1RemoteStorageState, 'status'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'permissions': ControllerApiResourcesWorkersV1RemoteStoragePermissionsToJSON(value['permissions']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,242 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesWorkersV1RemoteStorageState } from './ControllerApiResourcesWorkersV1RemoteStorageState';
|
||||
import {
|
||||
ControllerApiResourcesWorkersV1RemoteStorageStateFromJSON,
|
||||
ControllerApiResourcesWorkersV1RemoteStorageStateFromJSONTyped,
|
||||
ControllerApiResourcesWorkersV1RemoteStorageStateToJSON,
|
||||
ControllerApiResourcesWorkersV1RemoteStorageStateToJSONTyped,
|
||||
} from './ControllerApiResourcesWorkersV1RemoteStorageState';
|
||||
import type { ControllerApiResourcesScopesV1ScopeInfo } from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeInfoToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1ScopeInfo';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
export interface ControllerApiResourcesWorkersV1Worker {
|
||||
/**
|
||||
* Output only. The ID of the User.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly id?: string;
|
||||
/**
|
||||
* The ID of the Scope this resource is in.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1ScopeInfo}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
scope?: ControllerApiResourcesScopesV1ScopeInfo;
|
||||
/**
|
||||
* Optional name for identification purposes. Can only be set through the API
|
||||
* for `pki`-type workers; read-only for `kms`-type workers.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* Optional user-set description for identification purposes. Can only be set
|
||||
* through the API for `pki`-type workers; read-only for `kms`-type workers.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Output only. The time this resource was created.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly createdTime?: Date;
|
||||
/**
|
||||
* Output only. The time this resource was last updated.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly updatedTime?: Date;
|
||||
/**
|
||||
* Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* Output only. The address that this worker is reachable at, as sourced from
|
||||
* the worker's configuration file.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly address?: string;
|
||||
/**
|
||||
* Output only. The deduplicated union of the tags reported by the worker from
|
||||
* its configuration and any tags added through other means. This is used
|
||||
* when applying worker filters.
|
||||
* @type {{ [key: string]: Array<object>; }}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly canonicalTags?: { [key: string]: Array<object>; };
|
||||
/**
|
||||
* Output only. The tags set in the worker's configuration file.
|
||||
* @type {{ [key: string]: Array<object>; }}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly configTags?: { [key: string]: Array<object>; };
|
||||
/**
|
||||
* Output only. The time this worker daemon last reported its status.
|
||||
* @type {Date}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly lastStatusTime?: Date;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
workerGeneratedAuthToken?: string;
|
||||
/**
|
||||
* Output only. An activation token that can be given to a worker to correlate
|
||||
* it to the created resource.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly controllerGeneratedActivationToken?: string;
|
||||
/**
|
||||
* Output only. The number of connections that this worker is currently handling.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly activeConnectionCount?: number;
|
||||
/**
|
||||
* Output only. The type of the worker, denoted by how it authenticates: `pki`
|
||||
* or `kms`.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly type?: string;
|
||||
/**
|
||||
* Output only. The api tags set for the worker.
|
||||
* @type {{ [key: string]: Array<object>; }}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly apiTags?: { [key: string]: Array<object>; };
|
||||
/**
|
||||
* Output only. The version of the Boundary binary the worker is running.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly releaseVersion?: string;
|
||||
/**
|
||||
* Output only. The ids of the workers directly connected to this worker.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly directlyConnectedDownstreamWorkers?: Array<string>;
|
||||
/**
|
||||
* Output only. The available actions on this resource for the requester.
|
||||
* @type {Array<string>}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly authorizedActions?: Array<string>;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly localStorageState?: string;
|
||||
/**
|
||||
* Output only. The remote_storage_state indicats the permission state of the storage buckets that the Worker
|
||||
* is actively using. The possible permission state types include: write, read, and delete. The possible
|
||||
* permission state values include: unknown, error, and ok.
|
||||
* @type {{ [key: string]: ControllerApiResourcesWorkersV1RemoteStorageState; }}
|
||||
* @memberof ControllerApiResourcesWorkersV1Worker
|
||||
*/
|
||||
readonly remoteStorageState?: { [key: string]: ControllerApiResourcesWorkersV1RemoteStorageState; };
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiResourcesWorkersV1Worker interface.
|
||||
*/
|
||||
export function instanceOfControllerApiResourcesWorkersV1Worker(value: object): value is ControllerApiResourcesWorkersV1Worker {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1WorkerFromJSON(json: any): ControllerApiResourcesWorkersV1Worker {
|
||||
return ControllerApiResourcesWorkersV1WorkerFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1WorkerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiResourcesWorkersV1Worker {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'id': json['id'] == null ? undefined : json['id'],
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'scope': json['scope'] == null ? undefined : ControllerApiResourcesScopesV1ScopeInfoFromJSON(json['scope']),
|
||||
'name': json['name'] == null ? undefined : json['name'],
|
||||
'description': json['description'] == null ? undefined : json['description'],
|
||||
'createdTime': json['created_time'] == null ? undefined : (new Date(json['created_time'])),
|
||||
'updatedTime': json['updated_time'] == null ? undefined : (new Date(json['updated_time'])),
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'address': json['address'] == null ? undefined : json['address'],
|
||||
'canonicalTags': json['canonical_tags'] == null ? undefined : json['canonical_tags'],
|
||||
'configTags': json['config_tags'] == null ? undefined : json['config_tags'],
|
||||
'lastStatusTime': json['last_status_time'] == null ? undefined : (new Date(json['last_status_time'])),
|
||||
'workerGeneratedAuthToken': json['worker_generated_auth_token'] == null ? undefined : json['worker_generated_auth_token'],
|
||||
'controllerGeneratedActivationToken': json['controller_generated_activation_token'] == null ? undefined : json['controller_generated_activation_token'],
|
||||
'activeConnectionCount': json['active_connection_count'] == null ? undefined : json['active_connection_count'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'apiTags': json['api_tags'] == null ? undefined : json['api_tags'],
|
||||
'releaseVersion': json['release_version'] == null ? undefined : json['release_version'],
|
||||
'directlyConnectedDownstreamWorkers': json['directly_connected_downstream_workers'] == null ? undefined : json['directly_connected_downstream_workers'],
|
||||
'authorizedActions': json['authorized_actions'] == null ? undefined : json['authorized_actions'],
|
||||
'localStorageState': json['local_storage_state'] == null ? undefined : json['local_storage_state'],
|
||||
'remoteStorageState': json['remote_storage_state'] == null ? undefined : (mapValues(json['remote_storage_state'], ControllerApiResourcesWorkersV1RemoteStorageStateFromJSON)),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1WorkerToJSON(json: any): ControllerApiResourcesWorkersV1Worker {
|
||||
return ControllerApiResourcesWorkersV1WorkerToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiResourcesWorkersV1WorkerToJSONTyped(value?: Omit<ControllerApiResourcesWorkersV1Worker, 'id'|'created_time'|'updated_time'|'address'|'canonical_tags'|'config_tags'|'last_status_time'|'controller_generated_activation_token'|'active_connection_count'|'type'|'api_tags'|'release_version'|'directly_connected_downstream_workers'|'authorized_actions'|'local_storage_state'|'remote_storage_state'> | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope_id': value['scopeId'],
|
||||
'scope': ControllerApiResourcesScopesV1ScopeInfoToJSON(value['scope']),
|
||||
'name': value['name'],
|
||||
'description': value['description'],
|
||||
'version': value['version'],
|
||||
'worker_generated_auth_token': value['workerGeneratedAuthToken'],
|
||||
};
|
||||
}
|
||||
|
||||
+82
@@ -0,0 +1,82 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AccountServiceChangePasswordBody
|
||||
*/
|
||||
export interface ControllerApiServicesV1AccountServiceChangePasswordBody {
|
||||
/**
|
||||
* Version is used to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiServicesV1AccountServiceChangePasswordBody
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The current password for the account.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1AccountServiceChangePasswordBody
|
||||
*/
|
||||
currentPassword?: string;
|
||||
/**
|
||||
* The new password that should be set.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1AccountServiceChangePasswordBody
|
||||
*/
|
||||
newPassword?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AccountServiceChangePasswordBody interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AccountServiceChangePasswordBody(value: object): value is ControllerApiServicesV1AccountServiceChangePasswordBody {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AccountServiceChangePasswordBodyFromJSON(json: any): ControllerApiServicesV1AccountServiceChangePasswordBody {
|
||||
return ControllerApiServicesV1AccountServiceChangePasswordBodyFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AccountServiceChangePasswordBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AccountServiceChangePasswordBody {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'currentPassword': json['current_password'] == null ? undefined : json['current_password'],
|
||||
'newPassword': json['new_password'] == null ? undefined : json['new_password'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AccountServiceChangePasswordBodyToJSON(json: any): ControllerApiServicesV1AccountServiceChangePasswordBody {
|
||||
return ControllerApiServicesV1AccountServiceChangePasswordBodyToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AccountServiceChangePasswordBodyToJSONTyped(value?: ControllerApiServicesV1AccountServiceChangePasswordBody | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'version': value['version'],
|
||||
'current_password': value['currentPassword'],
|
||||
'new_password': value['newPassword'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,74 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AccountServiceSetPasswordBody
|
||||
*/
|
||||
export interface ControllerApiServicesV1AccountServiceSetPasswordBody {
|
||||
/**
|
||||
* Version is used to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiServicesV1AccountServiceSetPasswordBody
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The password that should be set.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1AccountServiceSetPasswordBody
|
||||
*/
|
||||
password?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AccountServiceSetPasswordBody interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AccountServiceSetPasswordBody(value: object): value is ControllerApiServicesV1AccountServiceSetPasswordBody {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AccountServiceSetPasswordBodyFromJSON(json: any): ControllerApiServicesV1AccountServiceSetPasswordBody {
|
||||
return ControllerApiServicesV1AccountServiceSetPasswordBodyFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AccountServiceSetPasswordBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AccountServiceSetPasswordBody {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'password': json['password'] == null ? undefined : json['password'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AccountServiceSetPasswordBodyToJSON(json: any): ControllerApiServicesV1AccountServiceSetPasswordBody {
|
||||
return ControllerApiServicesV1AccountServiceSetPasswordBodyToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AccountServiceSetPasswordBodyToJSONTyped(value?: ControllerApiServicesV1AccountServiceSetPasswordBody | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'version': value['version'],
|
||||
'password': value['password'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesGroupsV1Group } from './ControllerApiResourcesGroupsV1Group';
|
||||
import {
|
||||
ControllerApiResourcesGroupsV1GroupFromJSON,
|
||||
ControllerApiResourcesGroupsV1GroupFromJSONTyped,
|
||||
ControllerApiResourcesGroupsV1GroupToJSON,
|
||||
ControllerApiResourcesGroupsV1GroupToJSONTyped,
|
||||
} from './ControllerApiResourcesGroupsV1Group';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AddGroupMembersResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1AddGroupMembersResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesGroupsV1Group}
|
||||
* @memberof ControllerApiServicesV1AddGroupMembersResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesGroupsV1Group;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AddGroupMembersResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AddGroupMembersResponse(value: object): value is ControllerApiServicesV1AddGroupMembersResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddGroupMembersResponseFromJSON(json: any): ControllerApiServicesV1AddGroupMembersResponse {
|
||||
return ControllerApiServicesV1AddGroupMembersResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddGroupMembersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AddGroupMembersResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesGroupsV1GroupFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddGroupMembersResponseToJSON(json: any): ControllerApiServicesV1AddGroupMembersResponse {
|
||||
return ControllerApiServicesV1AddGroupMembersResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddGroupMembersResponseToJSONTyped(value?: ControllerApiServicesV1AddGroupMembersResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesGroupsV1GroupToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesHostsetsV1HostSet } from './ControllerApiResourcesHostsetsV1HostSet';
|
||||
import {
|
||||
ControllerApiResourcesHostsetsV1HostSetFromJSON,
|
||||
ControllerApiResourcesHostsetsV1HostSetFromJSONTyped,
|
||||
ControllerApiResourcesHostsetsV1HostSetToJSON,
|
||||
ControllerApiResourcesHostsetsV1HostSetToJSONTyped,
|
||||
} from './ControllerApiResourcesHostsetsV1HostSet';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AddHostSetHostsResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1AddHostSetHostsResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesHostsetsV1HostSet}
|
||||
* @memberof ControllerApiServicesV1AddHostSetHostsResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesHostsetsV1HostSet;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AddHostSetHostsResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AddHostSetHostsResponse(value: object): value is ControllerApiServicesV1AddHostSetHostsResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddHostSetHostsResponseFromJSON(json: any): ControllerApiServicesV1AddHostSetHostsResponse {
|
||||
return ControllerApiServicesV1AddHostSetHostsResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddHostSetHostsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AddHostSetHostsResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesHostsetsV1HostSetFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddHostSetHostsResponseToJSON(json: any): ControllerApiServicesV1AddHostSetHostsResponse {
|
||||
return ControllerApiServicesV1AddHostSetHostsResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddHostSetHostsResponseToJSONTyped(value?: ControllerApiServicesV1AddHostSetHostsResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesHostsetsV1HostSetToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesRolesV1Role } from './ControllerApiResourcesRolesV1Role';
|
||||
import {
|
||||
ControllerApiResourcesRolesV1RoleFromJSON,
|
||||
ControllerApiResourcesRolesV1RoleFromJSONTyped,
|
||||
ControllerApiResourcesRolesV1RoleToJSON,
|
||||
ControllerApiResourcesRolesV1RoleToJSONTyped,
|
||||
} from './ControllerApiResourcesRolesV1Role';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AddRoleGrantScopesResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1AddRoleGrantScopesResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesRolesV1Role}
|
||||
* @memberof ControllerApiServicesV1AddRoleGrantScopesResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesRolesV1Role;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AddRoleGrantScopesResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AddRoleGrantScopesResponse(value: object): value is ControllerApiServicesV1AddRoleGrantScopesResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddRoleGrantScopesResponseFromJSON(json: any): ControllerApiServicesV1AddRoleGrantScopesResponse {
|
||||
return ControllerApiServicesV1AddRoleGrantScopesResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddRoleGrantScopesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AddRoleGrantScopesResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesRolesV1RoleFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddRoleGrantScopesResponseToJSON(json: any): ControllerApiServicesV1AddRoleGrantScopesResponse {
|
||||
return ControllerApiServicesV1AddRoleGrantScopesResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddRoleGrantScopesResponseToJSONTyped(value?: ControllerApiServicesV1AddRoleGrantScopesResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesRolesV1RoleToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesRolesV1Role } from './ControllerApiResourcesRolesV1Role';
|
||||
import {
|
||||
ControllerApiResourcesRolesV1RoleFromJSON,
|
||||
ControllerApiResourcesRolesV1RoleFromJSONTyped,
|
||||
ControllerApiResourcesRolesV1RoleToJSON,
|
||||
ControllerApiResourcesRolesV1RoleToJSONTyped,
|
||||
} from './ControllerApiResourcesRolesV1Role';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AddRoleGrantsResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1AddRoleGrantsResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesRolesV1Role}
|
||||
* @memberof ControllerApiServicesV1AddRoleGrantsResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesRolesV1Role;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AddRoleGrantsResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AddRoleGrantsResponse(value: object): value is ControllerApiServicesV1AddRoleGrantsResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddRoleGrantsResponseFromJSON(json: any): ControllerApiServicesV1AddRoleGrantsResponse {
|
||||
return ControllerApiServicesV1AddRoleGrantsResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddRoleGrantsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AddRoleGrantsResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesRolesV1RoleFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddRoleGrantsResponseToJSON(json: any): ControllerApiServicesV1AddRoleGrantsResponse {
|
||||
return ControllerApiServicesV1AddRoleGrantsResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddRoleGrantsResponseToJSONTyped(value?: ControllerApiServicesV1AddRoleGrantsResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesRolesV1RoleToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesRolesV1Role } from './ControllerApiResourcesRolesV1Role';
|
||||
import {
|
||||
ControllerApiResourcesRolesV1RoleFromJSON,
|
||||
ControllerApiResourcesRolesV1RoleFromJSONTyped,
|
||||
ControllerApiResourcesRolesV1RoleToJSON,
|
||||
ControllerApiResourcesRolesV1RoleToJSONTyped,
|
||||
} from './ControllerApiResourcesRolesV1Role';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AddRolePrincipalsResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1AddRolePrincipalsResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesRolesV1Role}
|
||||
* @memberof ControllerApiServicesV1AddRolePrincipalsResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesRolesV1Role;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AddRolePrincipalsResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AddRolePrincipalsResponse(value: object): value is ControllerApiServicesV1AddRolePrincipalsResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddRolePrincipalsResponseFromJSON(json: any): ControllerApiServicesV1AddRolePrincipalsResponse {
|
||||
return ControllerApiServicesV1AddRolePrincipalsResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddRolePrincipalsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AddRolePrincipalsResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesRolesV1RoleFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddRolePrincipalsResponseToJSON(json: any): ControllerApiServicesV1AddRolePrincipalsResponse {
|
||||
return ControllerApiServicesV1AddRolePrincipalsResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddRolePrincipalsResponseToJSONTyped(value?: ControllerApiServicesV1AddRolePrincipalsResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesRolesV1RoleToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
+73
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesTargetsV1Target } from './ControllerApiResourcesTargetsV1Target';
|
||||
import {
|
||||
ControllerApiResourcesTargetsV1TargetFromJSON,
|
||||
ControllerApiResourcesTargetsV1TargetFromJSONTyped,
|
||||
ControllerApiResourcesTargetsV1TargetToJSON,
|
||||
ControllerApiResourcesTargetsV1TargetToJSONTyped,
|
||||
} from './ControllerApiResourcesTargetsV1Target';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AddTargetCredentialSourcesResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1AddTargetCredentialSourcesResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesTargetsV1Target}
|
||||
* @memberof ControllerApiServicesV1AddTargetCredentialSourcesResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesTargetsV1Target;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AddTargetCredentialSourcesResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AddTargetCredentialSourcesResponse(value: object): value is ControllerApiServicesV1AddTargetCredentialSourcesResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddTargetCredentialSourcesResponseFromJSON(json: any): ControllerApiServicesV1AddTargetCredentialSourcesResponse {
|
||||
return ControllerApiServicesV1AddTargetCredentialSourcesResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddTargetCredentialSourcesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AddTargetCredentialSourcesResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesTargetsV1TargetFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddTargetCredentialSourcesResponseToJSON(json: any): ControllerApiServicesV1AddTargetCredentialSourcesResponse {
|
||||
return ControllerApiServicesV1AddTargetCredentialSourcesResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddTargetCredentialSourcesResponseToJSONTyped(value?: ControllerApiServicesV1AddTargetCredentialSourcesResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesTargetsV1TargetToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesTargetsV1Target } from './ControllerApiResourcesTargetsV1Target';
|
||||
import {
|
||||
ControllerApiResourcesTargetsV1TargetFromJSON,
|
||||
ControllerApiResourcesTargetsV1TargetFromJSONTyped,
|
||||
ControllerApiResourcesTargetsV1TargetToJSON,
|
||||
ControllerApiResourcesTargetsV1TargetToJSONTyped,
|
||||
} from './ControllerApiResourcesTargetsV1Target';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AddTargetHostSourcesResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1AddTargetHostSourcesResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesTargetsV1Target}
|
||||
* @memberof ControllerApiServicesV1AddTargetHostSourcesResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesTargetsV1Target;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AddTargetHostSourcesResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AddTargetHostSourcesResponse(value: object): value is ControllerApiServicesV1AddTargetHostSourcesResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddTargetHostSourcesResponseFromJSON(json: any): ControllerApiServicesV1AddTargetHostSourcesResponse {
|
||||
return ControllerApiServicesV1AddTargetHostSourcesResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddTargetHostSourcesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AddTargetHostSourcesResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesTargetsV1TargetFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddTargetHostSourcesResponseToJSON(json: any): ControllerApiServicesV1AddTargetHostSourcesResponse {
|
||||
return ControllerApiServicesV1AddTargetHostSourcesResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddTargetHostSourcesResponseToJSONTyped(value?: ControllerApiServicesV1AddTargetHostSourcesResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesTargetsV1TargetToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesUsersV1User } from './ControllerApiResourcesUsersV1User';
|
||||
import {
|
||||
ControllerApiResourcesUsersV1UserFromJSON,
|
||||
ControllerApiResourcesUsersV1UserFromJSONTyped,
|
||||
ControllerApiResourcesUsersV1UserToJSON,
|
||||
ControllerApiResourcesUsersV1UserToJSONTyped,
|
||||
} from './ControllerApiResourcesUsersV1User';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AddUserAccountsResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1AddUserAccountsResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesUsersV1User}
|
||||
* @memberof ControllerApiServicesV1AddUserAccountsResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesUsersV1User;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AddUserAccountsResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AddUserAccountsResponse(value: object): value is ControllerApiServicesV1AddUserAccountsResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddUserAccountsResponseFromJSON(json: any): ControllerApiServicesV1AddUserAccountsResponse {
|
||||
return ControllerApiServicesV1AddUserAccountsResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddUserAccountsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AddUserAccountsResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesUsersV1UserFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddUserAccountsResponseToJSON(json: any): ControllerApiServicesV1AddUserAccountsResponse {
|
||||
return ControllerApiServicesV1AddUserAccountsResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddUserAccountsResponseToJSONTyped(value?: ControllerApiServicesV1AddUserAccountsResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesUsersV1UserToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesWorkersV1Worker } from './ControllerApiResourcesWorkersV1Worker';
|
||||
import {
|
||||
ControllerApiResourcesWorkersV1WorkerFromJSON,
|
||||
ControllerApiResourcesWorkersV1WorkerFromJSONTyped,
|
||||
ControllerApiResourcesWorkersV1WorkerToJSON,
|
||||
ControllerApiResourcesWorkersV1WorkerToJSONTyped,
|
||||
} from './ControllerApiResourcesWorkersV1Worker';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AddWorkerTagsResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1AddWorkerTagsResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesWorkersV1Worker}
|
||||
* @memberof ControllerApiServicesV1AddWorkerTagsResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesWorkersV1Worker;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AddWorkerTagsResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AddWorkerTagsResponse(value: object): value is ControllerApiServicesV1AddWorkerTagsResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddWorkerTagsResponseFromJSON(json: any): ControllerApiServicesV1AddWorkerTagsResponse {
|
||||
return ControllerApiServicesV1AddWorkerTagsResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddWorkerTagsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AddWorkerTagsResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesWorkersV1WorkerFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddWorkerTagsResponseToJSON(json: any): ControllerApiServicesV1AddWorkerTagsResponse {
|
||||
return ControllerApiServicesV1AddWorkerTagsResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AddWorkerTagsResponseToJSONTyped(value?: ControllerApiServicesV1AddWorkerTagsResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesWorkersV1WorkerToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1Scope } from './ControllerApiResourcesScopesV1Scope';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1Scope';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AttachStoragePolicyResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1AttachStoragePolicyResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1Scope}
|
||||
* @memberof ControllerApiServicesV1AttachStoragePolicyResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesScopesV1Scope;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AttachStoragePolicyResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AttachStoragePolicyResponse(value: object): value is ControllerApiServicesV1AttachStoragePolicyResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AttachStoragePolicyResponseFromJSON(json: any): ControllerApiServicesV1AttachStoragePolicyResponse {
|
||||
return ControllerApiServicesV1AttachStoragePolicyResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AttachStoragePolicyResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AttachStoragePolicyResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesScopesV1ScopeFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AttachStoragePolicyResponseToJSON(json: any): ControllerApiServicesV1AttachStoragePolicyResponse {
|
||||
return ControllerApiServicesV1AttachStoragePolicyResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AttachStoragePolicyResponseToJSONTyped(value?: ControllerApiServicesV1AttachStoragePolicyResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesScopesV1ScopeToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
+127
@@ -0,0 +1,127 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AuthMethodServiceAuthenticateBody
|
||||
*/
|
||||
export interface ControllerApiServicesV1AuthMethodServiceAuthenticateBody {
|
||||
/**
|
||||
* This can be "cookie" or "token". If not provided, "token" will be used. "cookie" activates a split-cookie method where the token is split partially between http-only and regular cookies in order
|
||||
* to keep it safe from rogue JS in the browser. Deprecated, use "type" instead.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1AuthMethodServiceAuthenticateBody
|
||||
*/
|
||||
tokenType?: string;
|
||||
/**
|
||||
* This can be "cookie" or "token". If not provided, "token" will be used. "cookie" activates a split-cookie method where the token is split partially between http-only and regular cookies in order
|
||||
* to keep it safe from rogue JS in the browser.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1AuthMethodServiceAuthenticateBody
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The attributes that are used to authenticate to the auth method. The schema of this field depends on the type of the auth method. For password auth methods, the parameters are:
|
||||
* ```json
|
||||
* {
|
||||
* "login_name": "login_name",
|
||||
* "password": "password"
|
||||
* }
|
||||
* ```
|
||||
* For LDAP auth methods, the parameters are:
|
||||
* ```json
|
||||
* {
|
||||
* "login_name": "login_name",
|
||||
* "password": "password"
|
||||
* }
|
||||
* ```
|
||||
* For OIDC auth methods, the parameters are:
|
||||
* ```json
|
||||
* {
|
||||
* "roundtrip_payload": {}
|
||||
* }
|
||||
* ```
|
||||
* OIDC authentication requires multiple calls to this endpoint. After the initial call and successful authentication, the OIDC provider must redirect the user to the `callback` command:
|
||||
* ```json
|
||||
* {
|
||||
* "code": "code",
|
||||
* "state": "state",
|
||||
* "error": "error",
|
||||
* "error_description": "error_description",
|
||||
* "error_uri": "error_uri"
|
||||
* }
|
||||
* ```
|
||||
* Once this has succeded, the issued auth token can be retrieved by using the `token` command:
|
||||
* ```json
|
||||
* {
|
||||
* "token_id": "token_id_from_initial_response"
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @type {object}
|
||||
* @memberof ControllerApiServicesV1AuthMethodServiceAuthenticateBody
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* The command to perform. One of "login", "callback", or "token".
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1AuthMethodServiceAuthenticateBody
|
||||
*/
|
||||
command?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AuthMethodServiceAuthenticateBody interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AuthMethodServiceAuthenticateBody(value: object): value is ControllerApiServicesV1AuthMethodServiceAuthenticateBody {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthMethodServiceAuthenticateBodyFromJSON(json: any): ControllerApiServicesV1AuthMethodServiceAuthenticateBody {
|
||||
return ControllerApiServicesV1AuthMethodServiceAuthenticateBodyFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthMethodServiceAuthenticateBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AuthMethodServiceAuthenticateBody {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'tokenType': json['token_type'] == null ? undefined : json['token_type'],
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'command': json['command'] == null ? undefined : json['command'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthMethodServiceAuthenticateBodyToJSON(json: any): ControllerApiServicesV1AuthMethodServiceAuthenticateBody {
|
||||
return ControllerApiServicesV1AuthMethodServiceAuthenticateBodyToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthMethodServiceAuthenticateBodyToJSONTyped(value?: ControllerApiServicesV1AuthMethodServiceAuthenticateBody | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'token_type': value['tokenType'],
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
'command': value['command'],
|
||||
};
|
||||
}
|
||||
|
||||
+82
@@ -0,0 +1,82 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AuthMethodServiceChangeStateBody
|
||||
*/
|
||||
export interface ControllerApiServicesV1AuthMethodServiceChangeStateBody {
|
||||
/**
|
||||
* Version is used to ensure this resource has not changed.
|
||||
* The mutation will fail if the version does not match the latest known good version.
|
||||
* @type {number}
|
||||
* @memberof ControllerApiServicesV1AuthMethodServiceChangeStateBody
|
||||
*/
|
||||
version?: number;
|
||||
/**
|
||||
* The attributes that are applicable for the specific auth method type. The schema of this field depends on the type of the auth method. The only supported auth method type is OIDC.
|
||||
* For OIDC auth methods, the parameters are:
|
||||
* ```json
|
||||
* {
|
||||
* "state": "active-public",
|
||||
* "disable_discovered_config_validation": false
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @type {object}
|
||||
* @memberof ControllerApiServicesV1AuthMethodServiceChangeStateBody
|
||||
*/
|
||||
attributes?: object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AuthMethodServiceChangeStateBody interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AuthMethodServiceChangeStateBody(value: object): value is ControllerApiServicesV1AuthMethodServiceChangeStateBody {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthMethodServiceChangeStateBodyFromJSON(json: any): ControllerApiServicesV1AuthMethodServiceChangeStateBody {
|
||||
return ControllerApiServicesV1AuthMethodServiceChangeStateBodyFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthMethodServiceChangeStateBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AuthMethodServiceChangeStateBody {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'version': json['version'] == null ? undefined : json['version'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthMethodServiceChangeStateBodyToJSON(json: any): ControllerApiServicesV1AuthMethodServiceChangeStateBody {
|
||||
return ControllerApiServicesV1AuthMethodServiceChangeStateBodyToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthMethodServiceChangeStateBodyToJSONTyped(value?: ControllerApiServicesV1AuthMethodServiceChangeStateBody | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'version': value['version'],
|
||||
'attributes': value['attributes'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,104 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AuthenticateResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1AuthenticateResponse {
|
||||
/**
|
||||
* The type of the token returned. Either "cookie" or "token".
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1AuthenticateResponse
|
||||
*/
|
||||
type?: string;
|
||||
/**
|
||||
* The response attributes that are used to authenticate to the auth method. The schema of this field depends on the type of the auth method. For password, OIDC and LDAP auth methods, the response is an auth token:
|
||||
* ```json
|
||||
* {
|
||||
* "id": "token_id",
|
||||
* "scope_id": "scope_id",
|
||||
* "token": "token_string",
|
||||
* "user_id": "user_id",
|
||||
* "auth_method_id": "auth_method_id",
|
||||
* "account_id": "account_id",
|
||||
* "created_time": "token_created_time",
|
||||
* "updated_time": "token_updated_time",
|
||||
* "approximate_last_used_time": "token_approximate_last_used_time",
|
||||
* "expiration_time": "token_expiration_time"
|
||||
* }
|
||||
* ```
|
||||
* For OIDC auth methods, the initial parameters are:
|
||||
* ```json
|
||||
* {
|
||||
* "auth_url": "OIDC_auth_url",
|
||||
* "token_id": "OIDC_token_id"
|
||||
* }
|
||||
* ```
|
||||
* The `auth_url` is the URL that authenticating user should open in the browser to authenticate with the OIDC provider. The `token_id` should be used in subsequent calls to the `authenticate` endpoint to retrieve the auth token.
|
||||
*
|
||||
* @type {object}
|
||||
* @memberof ControllerApiServicesV1AuthenticateResponse
|
||||
*/
|
||||
attributes?: object;
|
||||
/**
|
||||
* The command that was performed.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1AuthenticateResponse
|
||||
*/
|
||||
command?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AuthenticateResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AuthenticateResponse(value: object): value is ControllerApiServicesV1AuthenticateResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthenticateResponseFromJSON(json: any): ControllerApiServicesV1AuthenticateResponse {
|
||||
return ControllerApiServicesV1AuthenticateResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthenticateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AuthenticateResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'type': json['type'] == null ? undefined : json['type'],
|
||||
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
||||
'command': json['command'] == null ? undefined : json['command'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthenticateResponseToJSON(json: any): ControllerApiServicesV1AuthenticateResponse {
|
||||
return ControllerApiServicesV1AuthenticateResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthenticateResponseToJSONTyped(value?: ControllerApiServicesV1AuthenticateResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'type': value['type'],
|
||||
'attributes': value['attributes'],
|
||||
'command': value['command'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesTargetsV1SessionAuthorization } from './ControllerApiResourcesTargetsV1SessionAuthorization';
|
||||
import {
|
||||
ControllerApiResourcesTargetsV1SessionAuthorizationFromJSON,
|
||||
ControllerApiResourcesTargetsV1SessionAuthorizationFromJSONTyped,
|
||||
ControllerApiResourcesTargetsV1SessionAuthorizationToJSON,
|
||||
ControllerApiResourcesTargetsV1SessionAuthorizationToJSONTyped,
|
||||
} from './ControllerApiResourcesTargetsV1SessionAuthorization';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1AuthorizeSessionResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1AuthorizeSessionResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesTargetsV1SessionAuthorization}
|
||||
* @memberof ControllerApiServicesV1AuthorizeSessionResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesTargetsV1SessionAuthorization;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1AuthorizeSessionResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1AuthorizeSessionResponse(value: object): value is ControllerApiServicesV1AuthorizeSessionResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthorizeSessionResponseFromJSON(json: any): ControllerApiServicesV1AuthorizeSessionResponse {
|
||||
return ControllerApiServicesV1AuthorizeSessionResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthorizeSessionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1AuthorizeSessionResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesTargetsV1SessionAuthorizationFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthorizeSessionResponseToJSON(json: any): ControllerApiServicesV1AuthorizeSessionResponse {
|
||||
return ControllerApiServicesV1AuthorizeSessionResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1AuthorizeSessionResponseToJSONTyped(value?: ControllerApiServicesV1AuthorizeSessionResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesTargetsV1SessionAuthorizationToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesSessionsV1Session } from './ControllerApiResourcesSessionsV1Session';
|
||||
import {
|
||||
ControllerApiResourcesSessionsV1SessionFromJSON,
|
||||
ControllerApiResourcesSessionsV1SessionFromJSONTyped,
|
||||
ControllerApiResourcesSessionsV1SessionToJSON,
|
||||
ControllerApiResourcesSessionsV1SessionToJSONTyped,
|
||||
} from './ControllerApiResourcesSessionsV1Session';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CancelSessionResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CancelSessionResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesSessionsV1Session}
|
||||
* @memberof ControllerApiServicesV1CancelSessionResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesSessionsV1Session;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CancelSessionResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CancelSessionResponse(value: object): value is ControllerApiServicesV1CancelSessionResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CancelSessionResponseFromJSON(json: any): ControllerApiServicesV1CancelSessionResponse {
|
||||
return ControllerApiServicesV1CancelSessionResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CancelSessionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CancelSessionResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesSessionsV1SessionFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CancelSessionResponseToJSON(json: any): ControllerApiServicesV1CancelSessionResponse {
|
||||
return ControllerApiServicesV1CancelSessionResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CancelSessionResponseToJSONTyped(value?: ControllerApiServicesV1CancelSessionResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesSessionsV1SessionToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesAccountsV1Account } from './ControllerApiResourcesAccountsV1Account';
|
||||
import {
|
||||
ControllerApiResourcesAccountsV1AccountFromJSON,
|
||||
ControllerApiResourcesAccountsV1AccountFromJSONTyped,
|
||||
ControllerApiResourcesAccountsV1AccountToJSON,
|
||||
ControllerApiResourcesAccountsV1AccountToJSONTyped,
|
||||
} from './ControllerApiResourcesAccountsV1Account';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1ChangePasswordResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1ChangePasswordResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesAccountsV1Account}
|
||||
* @memberof ControllerApiServicesV1ChangePasswordResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesAccountsV1Account;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1ChangePasswordResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1ChangePasswordResponse(value: object): value is ControllerApiServicesV1ChangePasswordResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1ChangePasswordResponseFromJSON(json: any): ControllerApiServicesV1ChangePasswordResponse {
|
||||
return ControllerApiServicesV1ChangePasswordResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1ChangePasswordResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1ChangePasswordResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesAccountsV1AccountFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1ChangePasswordResponseToJSON(json: any): ControllerApiServicesV1ChangePasswordResponse {
|
||||
return ControllerApiServicesV1ChangePasswordResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1ChangePasswordResponseToJSONTyped(value?: ControllerApiServicesV1ChangePasswordResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesAccountsV1AccountToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesAuthmethodsV1AuthMethod } from './ControllerApiResourcesAuthmethodsV1AuthMethod';
|
||||
import {
|
||||
ControllerApiResourcesAuthmethodsV1AuthMethodFromJSON,
|
||||
ControllerApiResourcesAuthmethodsV1AuthMethodFromJSONTyped,
|
||||
ControllerApiResourcesAuthmethodsV1AuthMethodToJSON,
|
||||
ControllerApiResourcesAuthmethodsV1AuthMethodToJSONTyped,
|
||||
} from './ControllerApiResourcesAuthmethodsV1AuthMethod';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1ChangeStateResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1ChangeStateResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesAuthmethodsV1AuthMethod}
|
||||
* @memberof ControllerApiServicesV1ChangeStateResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesAuthmethodsV1AuthMethod;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1ChangeStateResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1ChangeStateResponse(value: object): value is ControllerApiServicesV1ChangeStateResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1ChangeStateResponseFromJSON(json: any): ControllerApiServicesV1ChangeStateResponse {
|
||||
return ControllerApiServicesV1ChangeStateResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1ChangeStateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1ChangeStateResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesAuthmethodsV1AuthMethodFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1ChangeStateResponseToJSON(json: any): ControllerApiServicesV1ChangeStateResponse {
|
||||
return ControllerApiServicesV1ChangeStateResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1ChangeStateResponseToJSONTyped(value?: ControllerApiServicesV1ChangeStateResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesAuthmethodsV1AuthMethodToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesAccountsV1Account } from './ControllerApiResourcesAccountsV1Account';
|
||||
import {
|
||||
ControllerApiResourcesAccountsV1AccountFromJSON,
|
||||
ControllerApiResourcesAccountsV1AccountFromJSONTyped,
|
||||
ControllerApiResourcesAccountsV1AccountToJSON,
|
||||
ControllerApiResourcesAccountsV1AccountToJSONTyped,
|
||||
} from './ControllerApiResourcesAccountsV1Account';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateAccountResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateAccountResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateAccountResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesAccountsV1Account}
|
||||
* @memberof ControllerApiServicesV1CreateAccountResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesAccountsV1Account;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateAccountResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateAccountResponse(value: object): value is ControllerApiServicesV1CreateAccountResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateAccountResponseFromJSON(json: any): ControllerApiServicesV1CreateAccountResponse {
|
||||
return ControllerApiServicesV1CreateAccountResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateAccountResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateAccountResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesAccountsV1AccountFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateAccountResponseToJSON(json: any): ControllerApiServicesV1CreateAccountResponse {
|
||||
return ControllerApiServicesV1CreateAccountResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateAccountResponseToJSONTyped(value?: ControllerApiServicesV1CreateAccountResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesAccountsV1AccountToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesAliasesV1Alias } from './ControllerApiResourcesAliasesV1Alias';
|
||||
import {
|
||||
ControllerApiResourcesAliasesV1AliasFromJSON,
|
||||
ControllerApiResourcesAliasesV1AliasFromJSONTyped,
|
||||
ControllerApiResourcesAliasesV1AliasToJSON,
|
||||
ControllerApiResourcesAliasesV1AliasToJSONTyped,
|
||||
} from './ControllerApiResourcesAliasesV1Alias';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateAliasResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateAliasResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateAliasResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesAliasesV1Alias}
|
||||
* @memberof ControllerApiServicesV1CreateAliasResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesAliasesV1Alias;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateAliasResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateAliasResponse(value: object): value is ControllerApiServicesV1CreateAliasResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateAliasResponseFromJSON(json: any): ControllerApiServicesV1CreateAliasResponse {
|
||||
return ControllerApiServicesV1CreateAliasResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateAliasResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateAliasResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesAliasesV1AliasFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateAliasResponseToJSON(json: any): ControllerApiServicesV1CreateAliasResponse {
|
||||
return ControllerApiServicesV1CreateAliasResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateAliasResponseToJSONTyped(value?: ControllerApiServicesV1CreateAliasResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesAliasesV1AliasToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesAuthmethodsV1AuthMethod } from './ControllerApiResourcesAuthmethodsV1AuthMethod';
|
||||
import {
|
||||
ControllerApiResourcesAuthmethodsV1AuthMethodFromJSON,
|
||||
ControllerApiResourcesAuthmethodsV1AuthMethodFromJSONTyped,
|
||||
ControllerApiResourcesAuthmethodsV1AuthMethodToJSON,
|
||||
ControllerApiResourcesAuthmethodsV1AuthMethodToJSONTyped,
|
||||
} from './ControllerApiResourcesAuthmethodsV1AuthMethod';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateAuthMethodResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateAuthMethodResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateAuthMethodResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesAuthmethodsV1AuthMethod}
|
||||
* @memberof ControllerApiServicesV1CreateAuthMethodResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesAuthmethodsV1AuthMethod;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateAuthMethodResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateAuthMethodResponse(value: object): value is ControllerApiServicesV1CreateAuthMethodResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateAuthMethodResponseFromJSON(json: any): ControllerApiServicesV1CreateAuthMethodResponse {
|
||||
return ControllerApiServicesV1CreateAuthMethodResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateAuthMethodResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateAuthMethodResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesAuthmethodsV1AuthMethodFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateAuthMethodResponseToJSON(json: any): ControllerApiServicesV1CreateAuthMethodResponse {
|
||||
return ControllerApiServicesV1CreateAuthMethodResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateAuthMethodResponseToJSONTyped(value?: ControllerApiServicesV1CreateAuthMethodResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesAuthmethodsV1AuthMethodToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesWorkersV1Worker } from './ControllerApiResourcesWorkersV1Worker';
|
||||
import {
|
||||
ControllerApiResourcesWorkersV1WorkerFromJSON,
|
||||
ControllerApiResourcesWorkersV1WorkerFromJSONTyped,
|
||||
ControllerApiResourcesWorkersV1WorkerToJSON,
|
||||
ControllerApiResourcesWorkersV1WorkerToJSONTyped,
|
||||
} from './ControllerApiResourcesWorkersV1Worker';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateControllerLedResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateControllerLedResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateControllerLedResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesWorkersV1Worker}
|
||||
* @memberof ControllerApiServicesV1CreateControllerLedResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesWorkersV1Worker;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateControllerLedResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateControllerLedResponse(value: object): value is ControllerApiServicesV1CreateControllerLedResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateControllerLedResponseFromJSON(json: any): ControllerApiServicesV1CreateControllerLedResponse {
|
||||
return ControllerApiServicesV1CreateControllerLedResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateControllerLedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateControllerLedResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesWorkersV1WorkerFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateControllerLedResponseToJSON(json: any): ControllerApiServicesV1CreateControllerLedResponse {
|
||||
return ControllerApiServicesV1CreateControllerLedResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateControllerLedResponseToJSONTyped(value?: ControllerApiServicesV1CreateControllerLedResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesWorkersV1WorkerToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesCredentiallibrariesV1CredentialLibrary } from './ControllerApiResourcesCredentiallibrariesV1CredentialLibrary';
|
||||
import {
|
||||
ControllerApiResourcesCredentiallibrariesV1CredentialLibraryFromJSON,
|
||||
ControllerApiResourcesCredentiallibrariesV1CredentialLibraryFromJSONTyped,
|
||||
ControllerApiResourcesCredentiallibrariesV1CredentialLibraryToJSON,
|
||||
ControllerApiResourcesCredentiallibrariesV1CredentialLibraryToJSONTyped,
|
||||
} from './ControllerApiResourcesCredentiallibrariesV1CredentialLibrary';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateCredentialLibraryResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateCredentialLibraryResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateCredentialLibraryResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesCredentiallibrariesV1CredentialLibrary}
|
||||
* @memberof ControllerApiServicesV1CreateCredentialLibraryResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesCredentiallibrariesV1CredentialLibrary;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateCredentialLibraryResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateCredentialLibraryResponse(value: object): value is ControllerApiServicesV1CreateCredentialLibraryResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateCredentialLibraryResponseFromJSON(json: any): ControllerApiServicesV1CreateCredentialLibraryResponse {
|
||||
return ControllerApiServicesV1CreateCredentialLibraryResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateCredentialLibraryResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateCredentialLibraryResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesCredentiallibrariesV1CredentialLibraryFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateCredentialLibraryResponseToJSON(json: any): ControllerApiServicesV1CreateCredentialLibraryResponse {
|
||||
return ControllerApiServicesV1CreateCredentialLibraryResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateCredentialLibraryResponseToJSONTyped(value?: ControllerApiServicesV1CreateCredentialLibraryResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesCredentiallibrariesV1CredentialLibraryToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesCredentialsV1Credential } from './ControllerApiResourcesCredentialsV1Credential';
|
||||
import {
|
||||
ControllerApiResourcesCredentialsV1CredentialFromJSON,
|
||||
ControllerApiResourcesCredentialsV1CredentialFromJSONTyped,
|
||||
ControllerApiResourcesCredentialsV1CredentialToJSON,
|
||||
ControllerApiResourcesCredentialsV1CredentialToJSONTyped,
|
||||
} from './ControllerApiResourcesCredentialsV1Credential';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateCredentialResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateCredentialResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateCredentialResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesCredentialsV1Credential}
|
||||
* @memberof ControllerApiServicesV1CreateCredentialResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesCredentialsV1Credential;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateCredentialResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateCredentialResponse(value: object): value is ControllerApiServicesV1CreateCredentialResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateCredentialResponseFromJSON(json: any): ControllerApiServicesV1CreateCredentialResponse {
|
||||
return ControllerApiServicesV1CreateCredentialResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateCredentialResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateCredentialResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesCredentialsV1CredentialFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateCredentialResponseToJSON(json: any): ControllerApiServicesV1CreateCredentialResponse {
|
||||
return ControllerApiServicesV1CreateCredentialResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateCredentialResponseToJSONTyped(value?: ControllerApiServicesV1CreateCredentialResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesCredentialsV1CredentialToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesCredentialstoresV1CredentialStore } from './ControllerApiResourcesCredentialstoresV1CredentialStore';
|
||||
import {
|
||||
ControllerApiResourcesCredentialstoresV1CredentialStoreFromJSON,
|
||||
ControllerApiResourcesCredentialstoresV1CredentialStoreFromJSONTyped,
|
||||
ControllerApiResourcesCredentialstoresV1CredentialStoreToJSON,
|
||||
ControllerApiResourcesCredentialstoresV1CredentialStoreToJSONTyped,
|
||||
} from './ControllerApiResourcesCredentialstoresV1CredentialStore';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateCredentialStoreResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateCredentialStoreResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateCredentialStoreResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesCredentialstoresV1CredentialStore}
|
||||
* @memberof ControllerApiServicesV1CreateCredentialStoreResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesCredentialstoresV1CredentialStore;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateCredentialStoreResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateCredentialStoreResponse(value: object): value is ControllerApiServicesV1CreateCredentialStoreResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateCredentialStoreResponseFromJSON(json: any): ControllerApiServicesV1CreateCredentialStoreResponse {
|
||||
return ControllerApiServicesV1CreateCredentialStoreResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateCredentialStoreResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateCredentialStoreResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesCredentialstoresV1CredentialStoreFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateCredentialStoreResponseToJSON(json: any): ControllerApiServicesV1CreateCredentialStoreResponse {
|
||||
return ControllerApiServicesV1CreateCredentialStoreResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateCredentialStoreResponseToJSONTyped(value?: ControllerApiServicesV1CreateCredentialStoreResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesCredentialstoresV1CredentialStoreToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesGroupsV1Group } from './ControllerApiResourcesGroupsV1Group';
|
||||
import {
|
||||
ControllerApiResourcesGroupsV1GroupFromJSON,
|
||||
ControllerApiResourcesGroupsV1GroupFromJSONTyped,
|
||||
ControllerApiResourcesGroupsV1GroupToJSON,
|
||||
ControllerApiResourcesGroupsV1GroupToJSONTyped,
|
||||
} from './ControllerApiResourcesGroupsV1Group';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateGroupResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateGroupResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateGroupResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesGroupsV1Group}
|
||||
* @memberof ControllerApiServicesV1CreateGroupResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesGroupsV1Group;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateGroupResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateGroupResponse(value: object): value is ControllerApiServicesV1CreateGroupResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateGroupResponseFromJSON(json: any): ControllerApiServicesV1CreateGroupResponse {
|
||||
return ControllerApiServicesV1CreateGroupResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateGroupResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateGroupResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesGroupsV1GroupFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateGroupResponseToJSON(json: any): ControllerApiServicesV1CreateGroupResponse {
|
||||
return ControllerApiServicesV1CreateGroupResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateGroupResponseToJSONTyped(value?: ControllerApiServicesV1CreateGroupResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesGroupsV1GroupToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesHostcatalogsV1HostCatalog } from './ControllerApiResourcesHostcatalogsV1HostCatalog';
|
||||
import {
|
||||
ControllerApiResourcesHostcatalogsV1HostCatalogFromJSON,
|
||||
ControllerApiResourcesHostcatalogsV1HostCatalogFromJSONTyped,
|
||||
ControllerApiResourcesHostcatalogsV1HostCatalogToJSON,
|
||||
ControllerApiResourcesHostcatalogsV1HostCatalogToJSONTyped,
|
||||
} from './ControllerApiResourcesHostcatalogsV1HostCatalog';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateHostCatalogResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateHostCatalogResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateHostCatalogResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesHostcatalogsV1HostCatalog}
|
||||
* @memberof ControllerApiServicesV1CreateHostCatalogResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesHostcatalogsV1HostCatalog;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateHostCatalogResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateHostCatalogResponse(value: object): value is ControllerApiServicesV1CreateHostCatalogResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateHostCatalogResponseFromJSON(json: any): ControllerApiServicesV1CreateHostCatalogResponse {
|
||||
return ControllerApiServicesV1CreateHostCatalogResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateHostCatalogResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateHostCatalogResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesHostcatalogsV1HostCatalogFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateHostCatalogResponseToJSON(json: any): ControllerApiServicesV1CreateHostCatalogResponse {
|
||||
return ControllerApiServicesV1CreateHostCatalogResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateHostCatalogResponseToJSONTyped(value?: ControllerApiServicesV1CreateHostCatalogResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesHostcatalogsV1HostCatalogToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesHostsV1Host } from './ControllerApiResourcesHostsV1Host';
|
||||
import {
|
||||
ControllerApiResourcesHostsV1HostFromJSON,
|
||||
ControllerApiResourcesHostsV1HostFromJSONTyped,
|
||||
ControllerApiResourcesHostsV1HostToJSON,
|
||||
ControllerApiResourcesHostsV1HostToJSONTyped,
|
||||
} from './ControllerApiResourcesHostsV1Host';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateHostResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateHostResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateHostResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesHostsV1Host}
|
||||
* @memberof ControllerApiServicesV1CreateHostResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesHostsV1Host;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateHostResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateHostResponse(value: object): value is ControllerApiServicesV1CreateHostResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateHostResponseFromJSON(json: any): ControllerApiServicesV1CreateHostResponse {
|
||||
return ControllerApiServicesV1CreateHostResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateHostResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateHostResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesHostsV1HostFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateHostResponseToJSON(json: any): ControllerApiServicesV1CreateHostResponse {
|
||||
return ControllerApiServicesV1CreateHostResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateHostResponseToJSONTyped(value?: ControllerApiServicesV1CreateHostResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesHostsV1HostToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesHostsetsV1HostSet } from './ControllerApiResourcesHostsetsV1HostSet';
|
||||
import {
|
||||
ControllerApiResourcesHostsetsV1HostSetFromJSON,
|
||||
ControllerApiResourcesHostsetsV1HostSetFromJSONTyped,
|
||||
ControllerApiResourcesHostsetsV1HostSetToJSON,
|
||||
ControllerApiResourcesHostsetsV1HostSetToJSONTyped,
|
||||
} from './ControllerApiResourcesHostsetsV1HostSet';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateHostSetResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateHostSetResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateHostSetResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesHostsetsV1HostSet}
|
||||
* @memberof ControllerApiServicesV1CreateHostSetResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesHostsetsV1HostSet;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateHostSetResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateHostSetResponse(value: object): value is ControllerApiServicesV1CreateHostSetResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateHostSetResponseFromJSON(json: any): ControllerApiServicesV1CreateHostSetResponse {
|
||||
return ControllerApiServicesV1CreateHostSetResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateHostSetResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateHostSetResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesHostsetsV1HostSetFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateHostSetResponseToJSON(json: any): ControllerApiServicesV1CreateHostSetResponse {
|
||||
return ControllerApiServicesV1CreateHostSetResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateHostSetResponseToJSONTyped(value?: ControllerApiServicesV1CreateHostSetResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesHostsetsV1HostSetToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesManagedgroupsV1ManagedGroup } from './ControllerApiResourcesManagedgroupsV1ManagedGroup';
|
||||
import {
|
||||
ControllerApiResourcesManagedgroupsV1ManagedGroupFromJSON,
|
||||
ControllerApiResourcesManagedgroupsV1ManagedGroupFromJSONTyped,
|
||||
ControllerApiResourcesManagedgroupsV1ManagedGroupToJSON,
|
||||
ControllerApiResourcesManagedgroupsV1ManagedGroupToJSONTyped,
|
||||
} from './ControllerApiResourcesManagedgroupsV1ManagedGroup';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateManagedGroupResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateManagedGroupResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateManagedGroupResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesManagedgroupsV1ManagedGroup}
|
||||
* @memberof ControllerApiServicesV1CreateManagedGroupResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesManagedgroupsV1ManagedGroup;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateManagedGroupResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateManagedGroupResponse(value: object): value is ControllerApiServicesV1CreateManagedGroupResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateManagedGroupResponseFromJSON(json: any): ControllerApiServicesV1CreateManagedGroupResponse {
|
||||
return ControllerApiServicesV1CreateManagedGroupResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateManagedGroupResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateManagedGroupResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesManagedgroupsV1ManagedGroupFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateManagedGroupResponseToJSON(json: any): ControllerApiServicesV1CreateManagedGroupResponse {
|
||||
return ControllerApiServicesV1CreateManagedGroupResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateManagedGroupResponseToJSONTyped(value?: ControllerApiServicesV1CreateManagedGroupResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesManagedgroupsV1ManagedGroupToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesPoliciesV1Policy } from './ControllerApiResourcesPoliciesV1Policy';
|
||||
import {
|
||||
ControllerApiResourcesPoliciesV1PolicyFromJSON,
|
||||
ControllerApiResourcesPoliciesV1PolicyFromJSONTyped,
|
||||
ControllerApiResourcesPoliciesV1PolicyToJSON,
|
||||
ControllerApiResourcesPoliciesV1PolicyToJSONTyped,
|
||||
} from './ControllerApiResourcesPoliciesV1Policy';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreatePolicyResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreatePolicyResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreatePolicyResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesPoliciesV1Policy}
|
||||
* @memberof ControllerApiServicesV1CreatePolicyResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesPoliciesV1Policy;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreatePolicyResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreatePolicyResponse(value: object): value is ControllerApiServicesV1CreatePolicyResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreatePolicyResponseFromJSON(json: any): ControllerApiServicesV1CreatePolicyResponse {
|
||||
return ControllerApiServicesV1CreatePolicyResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreatePolicyResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreatePolicyResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesPoliciesV1PolicyFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreatePolicyResponseToJSON(json: any): ControllerApiServicesV1CreatePolicyResponse {
|
||||
return ControllerApiServicesV1CreatePolicyResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreatePolicyResponseToJSONTyped(value?: ControllerApiServicesV1CreatePolicyResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesPoliciesV1PolicyToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesRolesV1Role } from './ControllerApiResourcesRolesV1Role';
|
||||
import {
|
||||
ControllerApiResourcesRolesV1RoleFromJSON,
|
||||
ControllerApiResourcesRolesV1RoleFromJSONTyped,
|
||||
ControllerApiResourcesRolesV1RoleToJSON,
|
||||
ControllerApiResourcesRolesV1RoleToJSONTyped,
|
||||
} from './ControllerApiResourcesRolesV1Role';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateRoleResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateRoleResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateRoleResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesRolesV1Role}
|
||||
* @memberof ControllerApiServicesV1CreateRoleResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesRolesV1Role;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateRoleResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateRoleResponse(value: object): value is ControllerApiServicesV1CreateRoleResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateRoleResponseFromJSON(json: any): ControllerApiServicesV1CreateRoleResponse {
|
||||
return ControllerApiServicesV1CreateRoleResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateRoleResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateRoleResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesRolesV1RoleFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateRoleResponseToJSON(json: any): ControllerApiServicesV1CreateRoleResponse {
|
||||
return ControllerApiServicesV1CreateRoleResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateRoleResponseToJSONTyped(value?: ControllerApiServicesV1CreateRoleResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesRolesV1RoleToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1Scope } from './ControllerApiResourcesScopesV1Scope';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1Scope';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateScopeResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateScopeResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateScopeResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1Scope}
|
||||
* @memberof ControllerApiServicesV1CreateScopeResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesScopesV1Scope;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateScopeResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateScopeResponse(value: object): value is ControllerApiServicesV1CreateScopeResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateScopeResponseFromJSON(json: any): ControllerApiServicesV1CreateScopeResponse {
|
||||
return ControllerApiServicesV1CreateScopeResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateScopeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateScopeResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesScopesV1ScopeFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateScopeResponseToJSON(json: any): ControllerApiServicesV1CreateScopeResponse {
|
||||
return ControllerApiServicesV1CreateScopeResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateScopeResponseToJSONTyped(value?: ControllerApiServicesV1CreateScopeResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesScopesV1ScopeToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesStoragebucketsV1StorageBucket } from './ControllerApiResourcesStoragebucketsV1StorageBucket';
|
||||
import {
|
||||
ControllerApiResourcesStoragebucketsV1StorageBucketFromJSON,
|
||||
ControllerApiResourcesStoragebucketsV1StorageBucketFromJSONTyped,
|
||||
ControllerApiResourcesStoragebucketsV1StorageBucketToJSON,
|
||||
ControllerApiResourcesStoragebucketsV1StorageBucketToJSONTyped,
|
||||
} from './ControllerApiResourcesStoragebucketsV1StorageBucket';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateStorageBucketResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateStorageBucketResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateStorageBucketResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesStoragebucketsV1StorageBucket}
|
||||
* @memberof ControllerApiServicesV1CreateStorageBucketResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesStoragebucketsV1StorageBucket;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateStorageBucketResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateStorageBucketResponse(value: object): value is ControllerApiServicesV1CreateStorageBucketResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateStorageBucketResponseFromJSON(json: any): ControllerApiServicesV1CreateStorageBucketResponse {
|
||||
return ControllerApiServicesV1CreateStorageBucketResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateStorageBucketResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateStorageBucketResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesStoragebucketsV1StorageBucketFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateStorageBucketResponseToJSON(json: any): ControllerApiServicesV1CreateStorageBucketResponse {
|
||||
return ControllerApiServicesV1CreateStorageBucketResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateStorageBucketResponseToJSONTyped(value?: ControllerApiServicesV1CreateStorageBucketResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesStoragebucketsV1StorageBucketToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesTargetsV1Target } from './ControllerApiResourcesTargetsV1Target';
|
||||
import {
|
||||
ControllerApiResourcesTargetsV1TargetFromJSON,
|
||||
ControllerApiResourcesTargetsV1TargetFromJSONTyped,
|
||||
ControllerApiResourcesTargetsV1TargetToJSON,
|
||||
ControllerApiResourcesTargetsV1TargetToJSONTyped,
|
||||
} from './ControllerApiResourcesTargetsV1Target';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateTargetResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateTargetResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateTargetResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesTargetsV1Target}
|
||||
* @memberof ControllerApiServicesV1CreateTargetResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesTargetsV1Target;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateTargetResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateTargetResponse(value: object): value is ControllerApiServicesV1CreateTargetResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateTargetResponseFromJSON(json: any): ControllerApiServicesV1CreateTargetResponse {
|
||||
return ControllerApiServicesV1CreateTargetResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateTargetResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateTargetResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesTargetsV1TargetFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateTargetResponseToJSON(json: any): ControllerApiServicesV1CreateTargetResponse {
|
||||
return ControllerApiServicesV1CreateTargetResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateTargetResponseToJSONTyped(value?: ControllerApiServicesV1CreateTargetResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesTargetsV1TargetToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesUsersV1User } from './ControllerApiResourcesUsersV1User';
|
||||
import {
|
||||
ControllerApiResourcesUsersV1UserFromJSON,
|
||||
ControllerApiResourcesUsersV1UserFromJSONTyped,
|
||||
ControllerApiResourcesUsersV1UserToJSON,
|
||||
ControllerApiResourcesUsersV1UserToJSONTyped,
|
||||
} from './ControllerApiResourcesUsersV1User';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateUserResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateUserResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateUserResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesUsersV1User}
|
||||
* @memberof ControllerApiServicesV1CreateUserResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesUsersV1User;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateUserResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateUserResponse(value: object): value is ControllerApiServicesV1CreateUserResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateUserResponseFromJSON(json: any): ControllerApiServicesV1CreateUserResponse {
|
||||
return ControllerApiServicesV1CreateUserResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateUserResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateUserResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesUsersV1UserFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateUserResponseToJSON(json: any): ControllerApiServicesV1CreateUserResponse {
|
||||
return ControllerApiServicesV1CreateUserResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateUserResponseToJSONTyped(value?: ControllerApiServicesV1CreateUserResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesUsersV1UserToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesWorkersV1Worker } from './ControllerApiResourcesWorkersV1Worker';
|
||||
import {
|
||||
ControllerApiResourcesWorkersV1WorkerFromJSON,
|
||||
ControllerApiResourcesWorkersV1WorkerFromJSONTyped,
|
||||
ControllerApiResourcesWorkersV1WorkerToJSON,
|
||||
ControllerApiResourcesWorkersV1WorkerToJSONTyped,
|
||||
} from './ControllerApiResourcesWorkersV1Worker';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1CreateWorkerLedResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1CreateWorkerLedResponse {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1CreateWorkerLedResponse
|
||||
*/
|
||||
uri?: string;
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesWorkersV1Worker}
|
||||
* @memberof ControllerApiServicesV1CreateWorkerLedResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesWorkersV1Worker;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1CreateWorkerLedResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1CreateWorkerLedResponse(value: object): value is ControllerApiServicesV1CreateWorkerLedResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateWorkerLedResponseFromJSON(json: any): ControllerApiServicesV1CreateWorkerLedResponse {
|
||||
return ControllerApiServicesV1CreateWorkerLedResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateWorkerLedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1CreateWorkerLedResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'uri': json['uri'] == null ? undefined : json['uri'],
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesWorkersV1WorkerFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateWorkerLedResponseToJSON(json: any): ControllerApiServicesV1CreateWorkerLedResponse {
|
||||
return ControllerApiServicesV1CreateWorkerLedResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1CreateWorkerLedResponseToJSONTyped(value?: ControllerApiServicesV1CreateWorkerLedResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'uri': value['uri'],
|
||||
'item': ControllerApiResourcesWorkersV1WorkerToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1DestroyKeyVersionRequest
|
||||
*/
|
||||
export interface ControllerApiServicesV1DestroyKeyVersionRequest {
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1DestroyKeyVersionRequest
|
||||
*/
|
||||
scopeId?: string;
|
||||
/**
|
||||
*
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1DestroyKeyVersionRequest
|
||||
*/
|
||||
keyVersionId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1DestroyKeyVersionRequest interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1DestroyKeyVersionRequest(value: object): value is ControllerApiServicesV1DestroyKeyVersionRequest {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1DestroyKeyVersionRequestFromJSON(json: any): ControllerApiServicesV1DestroyKeyVersionRequest {
|
||||
return ControllerApiServicesV1DestroyKeyVersionRequestFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1DestroyKeyVersionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1DestroyKeyVersionRequest {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'scopeId': json['scope_id'] == null ? undefined : json['scope_id'],
|
||||
'keyVersionId': json['key_version_id'] == null ? undefined : json['key_version_id'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1DestroyKeyVersionRequestToJSON(json: any): ControllerApiServicesV1DestroyKeyVersionRequest {
|
||||
return ControllerApiServicesV1DestroyKeyVersionRequestToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1DestroyKeyVersionRequestToJSONTyped(value?: ControllerApiServicesV1DestroyKeyVersionRequest | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'scope_id': value['scopeId'],
|
||||
'key_version_id': value['keyVersionId'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,67 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1DestroyKeyVersionResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1DestroyKeyVersionResponse {
|
||||
/**
|
||||
* Destruction state. One of "pending" or "completed".
|
||||
* Use GET /v1/scopes/{scope_id}:list-key-version-destruction-jobs
|
||||
* to monitor pending destruction jobs.
|
||||
* @type {string}
|
||||
* @memberof ControllerApiServicesV1DestroyKeyVersionResponse
|
||||
*/
|
||||
state?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1DestroyKeyVersionResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1DestroyKeyVersionResponse(value: object): value is ControllerApiServicesV1DestroyKeyVersionResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1DestroyKeyVersionResponseFromJSON(json: any): ControllerApiServicesV1DestroyKeyVersionResponse {
|
||||
return ControllerApiServicesV1DestroyKeyVersionResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1DestroyKeyVersionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1DestroyKeyVersionResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'state': json['state'] == null ? undefined : json['state'],
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1DestroyKeyVersionResponseToJSON(json: any): ControllerApiServicesV1DestroyKeyVersionResponse {
|
||||
return ControllerApiServicesV1DestroyKeyVersionResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1DestroyKeyVersionResponseToJSONTyped(value?: ControllerApiServicesV1DestroyKeyVersionResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'state': value['state'],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesScopesV1Scope } from './ControllerApiResourcesScopesV1Scope';
|
||||
import {
|
||||
ControllerApiResourcesScopesV1ScopeFromJSON,
|
||||
ControllerApiResourcesScopesV1ScopeFromJSONTyped,
|
||||
ControllerApiResourcesScopesV1ScopeToJSON,
|
||||
ControllerApiResourcesScopesV1ScopeToJSONTyped,
|
||||
} from './ControllerApiResourcesScopesV1Scope';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1DetachStoragePolicyResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1DetachStoragePolicyResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesScopesV1Scope}
|
||||
* @memberof ControllerApiServicesV1DetachStoragePolicyResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesScopesV1Scope;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1DetachStoragePolicyResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1DetachStoragePolicyResponse(value: object): value is ControllerApiServicesV1DetachStoragePolicyResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1DetachStoragePolicyResponseFromJSON(json: any): ControllerApiServicesV1DetachStoragePolicyResponse {
|
||||
return ControllerApiServicesV1DetachStoragePolicyResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1DetachStoragePolicyResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1DetachStoragePolicyResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesScopesV1ScopeFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1DetachStoragePolicyResponseToJSON(json: any): ControllerApiServicesV1DetachStoragePolicyResponse {
|
||||
return ControllerApiServicesV1DetachStoragePolicyResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1DetachStoragePolicyResponseToJSONTyped(value?: ControllerApiServicesV1DetachStoragePolicyResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesScopesV1ScopeToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesAccountsV1Account } from './ControllerApiResourcesAccountsV1Account';
|
||||
import {
|
||||
ControllerApiResourcesAccountsV1AccountFromJSON,
|
||||
ControllerApiResourcesAccountsV1AccountFromJSONTyped,
|
||||
ControllerApiResourcesAccountsV1AccountToJSON,
|
||||
ControllerApiResourcesAccountsV1AccountToJSONTyped,
|
||||
} from './ControllerApiResourcesAccountsV1Account';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1GetAccountResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1GetAccountResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesAccountsV1Account}
|
||||
* @memberof ControllerApiServicesV1GetAccountResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesAccountsV1Account;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1GetAccountResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1GetAccountResponse(value: object): value is ControllerApiServicesV1GetAccountResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1GetAccountResponseFromJSON(json: any): ControllerApiServicesV1GetAccountResponse {
|
||||
return ControllerApiServicesV1GetAccountResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1GetAccountResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1GetAccountResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesAccountsV1AccountFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1GetAccountResponseToJSON(json: any): ControllerApiServicesV1GetAccountResponse {
|
||||
return ControllerApiServicesV1GetAccountResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1GetAccountResponseToJSONTyped(value?: ControllerApiServicesV1GetAccountResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesAccountsV1AccountToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesAliasesV1Alias } from './ControllerApiResourcesAliasesV1Alias';
|
||||
import {
|
||||
ControllerApiResourcesAliasesV1AliasFromJSON,
|
||||
ControllerApiResourcesAliasesV1AliasFromJSONTyped,
|
||||
ControllerApiResourcesAliasesV1AliasToJSON,
|
||||
ControllerApiResourcesAliasesV1AliasToJSONTyped,
|
||||
} from './ControllerApiResourcesAliasesV1Alias';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1GetAliasResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1GetAliasResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesAliasesV1Alias}
|
||||
* @memberof ControllerApiServicesV1GetAliasResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesAliasesV1Alias;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1GetAliasResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1GetAliasResponse(value: object): value is ControllerApiServicesV1GetAliasResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1GetAliasResponseFromJSON(json: any): ControllerApiServicesV1GetAliasResponse {
|
||||
return ControllerApiServicesV1GetAliasResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1GetAliasResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1GetAliasResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesAliasesV1AliasFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1GetAliasResponseToJSON(json: any): ControllerApiServicesV1GetAliasResponse {
|
||||
return ControllerApiServicesV1GetAliasResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1GetAliasResponseToJSONTyped(value?: ControllerApiServicesV1GetAliasResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesAliasesV1AliasToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
/* 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.
|
||||
*/
|
||||
|
||||
import { mapValues } from '../runtime';
|
||||
import type { ControllerApiResourcesAuthmethodsV1AuthMethod } from './ControllerApiResourcesAuthmethodsV1AuthMethod';
|
||||
import {
|
||||
ControllerApiResourcesAuthmethodsV1AuthMethodFromJSON,
|
||||
ControllerApiResourcesAuthmethodsV1AuthMethodFromJSONTyped,
|
||||
ControllerApiResourcesAuthmethodsV1AuthMethodToJSON,
|
||||
ControllerApiResourcesAuthmethodsV1AuthMethodToJSONTyped,
|
||||
} from './ControllerApiResourcesAuthmethodsV1AuthMethod';
|
||||
|
||||
/**
|
||||
*
|
||||
* @export
|
||||
* @interface ControllerApiServicesV1GetAuthMethodResponse
|
||||
*/
|
||||
export interface ControllerApiServicesV1GetAuthMethodResponse {
|
||||
/**
|
||||
*
|
||||
* @type {ControllerApiResourcesAuthmethodsV1AuthMethod}
|
||||
* @memberof ControllerApiServicesV1GetAuthMethodResponse
|
||||
*/
|
||||
item?: ControllerApiResourcesAuthmethodsV1AuthMethod;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given object implements the ControllerApiServicesV1GetAuthMethodResponse interface.
|
||||
*/
|
||||
export function instanceOfControllerApiServicesV1GetAuthMethodResponse(value: object): value is ControllerApiServicesV1GetAuthMethodResponse {
|
||||
return true;
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1GetAuthMethodResponseFromJSON(json: any): ControllerApiServicesV1GetAuthMethodResponse {
|
||||
return ControllerApiServicesV1GetAuthMethodResponseFromJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1GetAuthMethodResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ControllerApiServicesV1GetAuthMethodResponse {
|
||||
if (json == null) {
|
||||
return json;
|
||||
}
|
||||
return {
|
||||
|
||||
'item': json['item'] == null ? undefined : ControllerApiResourcesAuthmethodsV1AuthMethodFromJSON(json['item']),
|
||||
};
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1GetAuthMethodResponseToJSON(json: any): ControllerApiServicesV1GetAuthMethodResponse {
|
||||
return ControllerApiServicesV1GetAuthMethodResponseToJSONTyped(json, false);
|
||||
}
|
||||
|
||||
export function ControllerApiServicesV1GetAuthMethodResponseToJSONTyped(value?: ControllerApiServicesV1GetAuthMethodResponse | null, ignoreDiscriminator: boolean = false): any {
|
||||
if (value == null) {
|
||||
return value;
|
||||
}
|
||||
|
||||
return {
|
||||
|
||||
'item': ControllerApiResourcesAuthmethodsV1AuthMethodToJSON(value['item']),
|
||||
};
|
||||
}
|
||||
|
||||
Loaded 100 of 262 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user