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

107 lines
3.7 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 ScepWriteRoleRoleRequest
*/
export interface ScepWriteRoleRoleRequest {
/**
* The authentication type to use
* @type {string}
* @memberof ScepWriteRoleRoleRequest
*/
authType?: ScepWriteRoleRoleRequestAuthTypeEnum;
/**
* The static challenge to use if auth_type is static-challenge, not used for other auth types
* @type {string}
* @memberof ScepWriteRoleRoleRequest
*/
challenge?: string;
/**
* The display name to use for clients using this scep role
* @type {string}
* @memberof ScepWriteRoleRoleRequest
*/
displayName?: string;
/**
* Comma separated string or JSON list of CIDR blocks. If set, specifies the blocks of IP addresses which are allowed to use the generated token.
* @type {Array<string>}
* @memberof ScepWriteRoleRoleRequest
*/
tokenBoundCidrs?: Array<string>;
/**
* If set, tokens created via this role carry an explicit maximum TTL. During renewal, the current maximum TTL values of the role and the mount are not checked for changes, and any updates to these values will have no effect on the token being renewed.
* @type {string}
* @memberof ScepWriteRoleRoleRequest
*/
tokenExplicitMaxTtl?: string;
/**
* The maximum lifetime of the generated token
* @type {string}
* @memberof ScepWriteRoleRoleRequest
*/
tokenMaxTtl?: string;
/**
* If true, the 'default' policy will not automatically be added to generated tokens
* @type {boolean}
* @memberof ScepWriteRoleRoleRequest
*/
tokenNoDefaultPolicy?: boolean;
/**
* The maximum number of times a token may be used, a value of zero means unlimited
* @type {number}
* @memberof ScepWriteRoleRoleRequest
*/
tokenNumUses?: number;
/**
* If set, tokens created via this role will have no max lifetime; instead, their renewal period will be fixed to this value. This takes an integer number of seconds, or a string duration (e.g. "24h").
* @type {string}
* @memberof ScepWriteRoleRoleRequest
*/
tokenPeriod?: string;
/**
* Comma-separated list of policies
* @type {Array<string>}
* @memberof ScepWriteRoleRoleRequest
*/
tokenPolicies?: Array<string>;
/**
* The initial ttl of the token to generate
* @type {string}
* @memberof ScepWriteRoleRoleRequest
*/
tokenTtl?: string;
/**
* The type of token to generate, service or batch
* @type {string}
* @memberof ScepWriteRoleRoleRequest
*/
tokenType?: string;
}
/**
* @export
* @enum {string}
*/
export declare enum ScepWriteRoleRoleRequestAuthTypeEnum {
STATIC_CHALLENGE = "static-challenge",
INTUNE = "intune"
}
/**
* Check if a given object implements the ScepWriteRoleRoleRequest interface.
*/
export declare function instanceOfScepWriteRoleRoleRequest(value: object): value is ScepWriteRoleRoleRequest;
export declare function ScepWriteRoleRoleRequestFromJSON(json: any): ScepWriteRoleRoleRequest;
export declare function ScepWriteRoleRoleRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScepWriteRoleRoleRequest;
export declare function ScepWriteRoleRoleRequestToJSON(json: any): ScepWriteRoleRoleRequest;
export declare function ScepWriteRoleRoleRequestToJSONTyped(value?: ScepWriteRoleRoleRequest | null, ignoreDiscriminator?: boolean): any;