mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-06 14:47:01 +02:00
93 lines
4.4 KiB
TypeScript
93 lines
4.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 TransitSignRequest
|
|
*/
|
|
export interface TransitSignRequest {
|
|
/**
|
|
* Deprecated: use "hash_algorithm" instead.
|
|
* @type {string}
|
|
* @memberof TransitSignRequest
|
|
*/
|
|
algorithm?: string;
|
|
/**
|
|
* Specifies a list of items for processing. When this parameter is set, any supplied 'input' or 'context' parameters will be ignored. Responses are returned in the 'batch_results' array component of the 'data' element of the response. Any batch output will preserve the order of the batch input
|
|
* @type {Array<object>}
|
|
* @memberof TransitSignRequest
|
|
*/
|
|
batchInput?: Array<object>;
|
|
/**
|
|
* Base64 encoded context for key derivation. Required if key derivation is enabled; currently only available with ed25519 keys.
|
|
* @type {string}
|
|
* @memberof TransitSignRequest
|
|
*/
|
|
context?: string;
|
|
/**
|
|
* Hash algorithm to use (POST body parameter). Valid values are: * sha1 * sha2-224 * sha2-256 * sha2-384 * sha2-512 * sha3-224 * sha3-256 * sha3-384 * sha3-512 * none Defaults to "sha2-256". Not valid for all key types, including ed25519. Using none requires setting prehashed=true and signature_algorithm=pkcs1v15, yielding a PKCSv1_5_NoOID instead of the usual PKCSv1_5_DERnull signature.
|
|
* @type {string}
|
|
* @memberof TransitSignRequest
|
|
*/
|
|
hashAlgorithm?: string;
|
|
/**
|
|
* The base64-encoded input data
|
|
* @type {string}
|
|
* @memberof TransitSignRequest
|
|
*/
|
|
input?: string;
|
|
/**
|
|
* The version of the key to use for signing. Must be 0 (for latest) or a value greater than or equal to the min_encryption_version configured on the key.
|
|
* @type {number}
|
|
* @memberof TransitSignRequest
|
|
*/
|
|
keyVersion?: number;
|
|
/**
|
|
* The method by which to marshal the signature. The default is 'asn1' which is used by openssl and X.509. It can also be set to 'jws' which is used for JWT signatures; setting it to this will also cause the encoding of the signature to be url-safe base64 instead of using standard base64 encoding. Currently only valid for ECDSA P-256 key types".
|
|
* @type {string}
|
|
* @memberof TransitSignRequest
|
|
*/
|
|
marshalingAlgorithm?: string;
|
|
/**
|
|
* Set to 'true' when the input is already hashed. If the key type is 'rsa-2048', 'rsa-3072' or 'rsa-4096', then the algorithm used to hash the input should be indicated by the 'algorithm' parameter.
|
|
* @type {boolean}
|
|
* @memberof TransitSignRequest
|
|
*/
|
|
prehashed?: boolean;
|
|
/**
|
|
* The salt length used to sign. Currently only applies to the RSA PSS signature scheme. Options are 'auto' (the default used by Golang, causing the salt to be as large as possible when signing), 'hash' (causes the salt length to equal the length of the hash used in the signature), or an integer between the minimum and the maximum permissible salt lengths for the given RSA key size. Defaults to 'auto'.
|
|
* @type {string}
|
|
* @memberof TransitSignRequest
|
|
*/
|
|
saltLength?: string;
|
|
/**
|
|
* The signature algorithm to use for signing. Currently only applies to RSA key types. Options are 'pss' or 'pkcs1v15'. Defaults to 'pss'
|
|
* @type {string}
|
|
* @memberof TransitSignRequest
|
|
*/
|
|
signatureAlgorithm?: string;
|
|
/**
|
|
* Base64 encoded context for Ed25519ph and Ed25519ctx signatures. Currently only available with Ed25519 keys. (Enterprise Only)
|
|
* @type {string}
|
|
* @memberof TransitSignRequest
|
|
*/
|
|
signatureContext?: string;
|
|
}
|
|
/**
|
|
* Check if a given object implements the TransitSignRequest interface.
|
|
*/
|
|
export declare function instanceOfTransitSignRequest(value: object): value is TransitSignRequest;
|
|
export declare function TransitSignRequestFromJSON(json: any): TransitSignRequest;
|
|
export declare function TransitSignRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransitSignRequest;
|
|
export declare function TransitSignRequestToJSON(json: any): TransitSignRequest;
|
|
export declare function TransitSignRequestToJSONTyped(value?: TransitSignRequest | null, ignoreDiscriminator?: boolean): any;
|