vault/ui/api-client/dist/esm/models/PkiGenerateKmsKeyRequest.d.ts

66 lines
2.4 KiB
TypeScript

/**
* HashiCorp Vault API
* HTTP API that gives you full access to Vault. All API routes are prefixed with `/v1/`.
*
* The version of the OpenAPI document: 1.21.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface PkiGenerateKmsKeyRequest
*/
export interface PkiGenerateKmsKeyRequest {
/**
* The number of bits to use. Allowed values are 0 (universal default); with rsa key_type: 2048 (default), 3072, 4096 or 8192; with ec key_type: 224, 256 (default), 384, or 521; ignored with ed25519.
* @type {number}
* @memberof PkiGenerateKmsKeyRequest
*/
keyBits?: number;
/**
* Optional name to be used for this key
* @type {string}
* @memberof PkiGenerateKmsKeyRequest
*/
keyName?: string;
/**
* The type of key to use; defaults to RSA. "rsa" "ec" and "ed25519" are the only valid values.
* @type {string}
* @memberof PkiGenerateKmsKeyRequest
*/
keyType?: PkiGenerateKmsKeyRequestKeyTypeEnum;
/**
* The name of the managed key to use when the exported type is kms. When kms type is the key type, this field or managed_key_name is required. Ignored for other types.
* @type {string}
* @memberof PkiGenerateKmsKeyRequest
*/
managedKeyId?: string;
/**
* The name of the managed key to use when the exported type is kms. When kms type is the key type, this field or managed_key_id is required. Ignored for other types.
* @type {string}
* @memberof PkiGenerateKmsKeyRequest
*/
managedKeyName?: string;
}
/**
* @export
* @enum {string}
*/
export declare enum PkiGenerateKmsKeyRequestKeyTypeEnum {
RSA = "rsa",
EC = "ec",
ED25519 = "ed25519"
}
/**
* Check if a given object implements the PkiGenerateKmsKeyRequest interface.
*/
export declare function instanceOfPkiGenerateKmsKeyRequest(value: object): value is PkiGenerateKmsKeyRequest;
export declare function PkiGenerateKmsKeyRequestFromJSON(json: any): PkiGenerateKmsKeyRequest;
export declare function PkiGenerateKmsKeyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PkiGenerateKmsKeyRequest;
export declare function PkiGenerateKmsKeyRequestToJSON(json: any): PkiGenerateKmsKeyRequest;
export declare function PkiGenerateKmsKeyRequestToJSONTyped(value?: PkiGenerateKmsKeyRequest | null, ignoreDiscriminator?: boolean): any;