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

69 lines
2.8 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 SystemWriteMfaMethodOktaNameRequest
*/
export interface SystemWriteMfaMethodOktaNameRequest {
/**
* Okta API key.
* @type {string}
* @memberof SystemWriteMfaMethodOktaNameRequest
*/
apiToken?: string;
/**
* The base domain to use for the Okta API. When not specified in the configuration, "okta.com" is used.
* @type {string}
* @memberof SystemWriteMfaMethodOktaNameRequest
*/
baseUrl?: string;
/**
* The mount to tie this method to for use in automatic mappings. The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.
* @type {string}
* @memberof SystemWriteMfaMethodOktaNameRequest
*/
mountAccessor?: string;
/**
* Name of the organization to be used in the Okta API.
* @type {string}
* @memberof SystemWriteMfaMethodOktaNameRequest
*/
orgName?: string;
/**
* If true, the username will only match the primary email for the account. Defaults to false.
* @type {boolean}
* @memberof SystemWriteMfaMethodOktaNameRequest
*/
primaryEmail?: boolean;
/**
* (DEPRECATED) Use base_url instead.
* @type {boolean}
* @memberof SystemWriteMfaMethodOktaNameRequest
*/
production?: boolean;
/**
* A format string for mapping Identity names to MFA method names. Values to subtitute should be placed in {{}}. For example, "{{alias.name}}@example.com". Currently-supported mappings: alias.name: The name returned by the mount configured via the mount_accessor parameter If blank, the Alias's name field will be used as-is.
* @type {string}
* @memberof SystemWriteMfaMethodOktaNameRequest
*/
usernameFormat?: string;
}
/**
* Check if a given object implements the SystemWriteMfaMethodOktaNameRequest interface.
*/
export declare function instanceOfSystemWriteMfaMethodOktaNameRequest(value: object): value is SystemWriteMfaMethodOktaNameRequest;
export declare function SystemWriteMfaMethodOktaNameRequestFromJSON(json: any): SystemWriteMfaMethodOktaNameRequest;
export declare function SystemWriteMfaMethodOktaNameRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemWriteMfaMethodOktaNameRequest;
export declare function SystemWriteMfaMethodOktaNameRequestToJSON(json: any): SystemWriteMfaMethodOktaNameRequest;
export declare function SystemWriteMfaMethodOktaNameRequestToJSONTyped(value?: SystemWriteMfaMethodOktaNameRequest | null, ignoreDiscriminator?: boolean): any;