@maccuaa/intellitrust-issuance-sdk/dist/index.d.ts

TypeScript SDK client for Entrust Adaptive Issuance Instant ID API

import * as Oazapfts from "@oazapfts/runtime";
declare const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders>;
declare const servers: {
	server1: string;
};
type AdminApiAuthentication = {
	/** Administration API application id */
	applicationId: string;
	/** If set to true, a session cookie named INTELLITRUST_SESSION_ID is returned with the authentication response. This cookie must be returned with all subsequent requests. */
	enableWebSession?: boolean;
	/** Shared Secret */
	sharedSecret: string;
};
type AdminApiAuthenticationResult = {
	/** Authorization token returned after a successful authentication. */
	authToken?: string;
	/** Creation time of the authentication token. */
	creationTime?: string;
	/** Expiry time of the authentication token. */
	expirationTime?: string;
};
type ErrorInfo = {
	/** Error Codes specific to cause of failure. */
	errorCode?: string;
	/** Additional Error Message describing the error. */
	errorMessage?: string;
	/** Optional additional error information. */
	parameters?: object[];
};
type ApplicationInfo = {
	/** The template the application was created from. */
	applicationTemplate?: string;
	/** The UUID of the template the application was created from. */
	applicationTemplateId?: string;
	/** The application authentication method. */
	authenticationMethod?: string;
	/** The UUID of the application. */
	id?: string;
	/** The name of the application. */
	name?: string;
};
type AdminApiApplication = {
	/** Determines if the application can use a long-lived token for authentication. */
	allowLongLivedToken?: boolean;
	/** The name of the application template specific to this application type. */
	applicationTemplate: string;
	/** Application template id specific to this application type. */
	applicationTemplateId?: string;
	/** Short description of application. */
	description?: string;
	/** Application ID. */
	id?: string;
	/** The UUID of the IP Addresses list. */
	ipListId?: string;
	/** Last successful authentication time to use administration api */
	lastAuthnDate?: string;
	/** Base64 encoded logo image. */
	logo?: string;
	/** Name of application.  */
	name: string;
	/** The UUID of the Site role to be associated with the API application. Pass an empty string value to unset the site role. */
	roleId?: string;
	/** Shared secret for application. */
	sharedSecret?: string;
	/** The UUID of the service provider role to be associated with the API application. Pass an empty string to unset the service provider role. */
	spRoleId?: string;
};
type AdminApiApplicationParms = {
	/** Determines if a long-lived token is allowed in this application. */
	allowLongLivedToken?: boolean;
	/** The UUID of the application template.  This value is only used when creating a new application. If not specified, the default admininstration API template is used. */
	applicationTemplateId?: string;
	/** Short description of application. */
	description?: string;
	/** The UUID of the IP Addresses list. */
	ipListId?: string;
	/** Base64 encoded logo image. */
	logo?: string;
	/** Name of application.  */
	name: string;
	/** The UUID of the Site role to be associated with the API application. Pass an empty string value to unset the site role. Either this value or spRoleId is required when creating the application. */
	roleId?: string;
	/** The UUID of the service provider role to be associated with the API application. Pass an empty string to unset the service provider role. Either this value or roleId is required when creating the application. */
	spRoleId?: string;
};
type ApplicationTemplate = {
	/** The type the application template. Possible values are SAML20, RADIUS, AAAS, IDG, OIDC, AUTHAPI, ADMINAPI, SIEMAPI. */
	authenticationMethod: string;
	/** The description of application template. */
	description?: string;
	/** The UUID of the application template. */
	id: string;
	/** The name of the application template. */
	name: string;
};
type EnrollmentApiPayload = {
	/** The Enrollment Data. Primary key field is mandatory in case of Update and Delete. */
	enrollmentData: object[];
	/** Name of the Enrollment Design. */
	enrollmentDesignName: string;
};
type Error = {
	/** The server error code */
	code: string;
	/** A human-readable representation of the error */
	message: string;
	/** The target of the error */
	target?: string;
};
type ReadEnrollmentApiPayload = {
	/** Name of the Enrollment Design. */
	enrollmentDesignName: string;
	/** Filter criteria based on which enrollments records should be fetched. If not provided, all records are fetched based on page size and number. */
	filterCriteria?: object[];
	/** Page number of Enrollment records to be fetched. Default is 1. */
	pageNumber?: string;
	/** Maximum number of Enrollment records to be fetched. Default is 50. */
	pageSize?: string;
};
type IssueMobileFlashPassBulkOperationDetails = {
	/** The error message describing the first error encountered processing the bulk operation. */
	errorMessage?: string;
	/** The row number of the first row that failed. */
	firstFailedRow?: number;
	/** The unique UUID of the bulk operation. */
	id?: string;
	/** The time this bulk operation was initialized. */
	initTime?: string;
	/** The name of this bulk operation. */
	name?: string;
	/** The time at which the bulk operation completed processing. */
	processingEndTime?: string;
	/** The time at which the bulk operation began processing. */
	processingStartTime?: string;
	/** How long the bulk operation took to complete processing. */
	processingTime?: number;
	/** The number of rows that have failed when processed. */
	rowsFailed?: number;
	/** The number of rows successfully processed. */
	rowsProcessed?: number;
	/** The state of the bulk operation. */
	state?: "FAILED" | "CANCELLED" | "COMPLETED" | "AWAITING_DATA" | "PROCESSING" | "SCHEDULED";
	/** The type of bulk operation. */
	"type"?: "IMPORT_USERS" | "IMPORT_GROUPS" | "IMPORT_USER_GROUPS" | "IMPORT_HARDWARE_TOKENS" | "IMPORT_ENROLLMENTS" | "PRINT_ENROLLMENTS" | "SEND_MFP" | "ASSIGN_ENTRUST_ST" | "ASSIGN_GOOGLE_ST" | "ASSIGN_PASSWORDS" | "RESET_PASSWORDS" | "DELETE_USERS" | "IMPORT_IDENTITYGUARD" | "IMPORT_GRIDS" | "EXPORT_ASSIGNEDGRIDS" | "EXPORT_ASSIGNEDTOKENS" | "EXPORT_AUDITEVENTS" | "EXPORT_SELFAUDITEVENTS" | "EXPORT_UNASSIGNEDGRIDS" | "EXPORT_UNASSIGNEDTOKENS" | "EXPORT_USERS" | "SET_REGISTRATION" | "SET_VERIFICATION" | "ASSIGN_GRIDS" | "EXPORT_USAGE" | "CREATE_UNASSIGNED_GRIDS" | "ASSIGN_HARDWARE_TOKENS" | "SET_GRIDS" | "EXPORT_ENROLLMENTS" | "DELETE_GROUPS" | "EXPORT_GROUPS" | "RESET_TOKENS" | "DELETE_ENROLLMENTS" | "PROVISION_SCIM" | "CREATE_TENANT" | "REVOKE_MFP" | "DELETE_GRIDS" | "DELETE_TOKENS";
};
type EnrollmentMultiFlashPassApiRequestV1 = {
	enrollmentDesignName?: string;
	primaryKeys?: string[];
};
type MobileFlashPassRequestDetails = {
	/** The error message describing the first error encountered processing the bulk operation. */
	errorMessage?: string;
	/** The row number of the first row that failed. */
	firstFailedRow?: number;
	/** The unique UUID of the request. */
	id?: string;
	/** The time this bulk operation was initialized. */
	initTime?: string;
	/** The name of this bulk operation. */
	name?: string;
	/** The time at which the bulk operation completed processing. */
	processingEndTime?: string;
	/** The time at which the bulk operation began processing. */
	processingStartTime?: string;
	/** How long the bulk operation took to complete processing. */
	processingTime?: number;
	/** The number of rows that have failed when processed. */
	rowsFailed?: number;
	/** The number of rows successfully processed. */
	rowsProcessed?: number;
	/** The state of the bulk operation. */
	state?: "FAILED" | "CANCELLED" | "COMPLETED" | "AWAITING_DATA" | "PROCESSING" | "SCHEDULED";
	/** The type of bulk operation. */
	"type"?: "IMPORT_USERS" | "IMPORT_GROUPS" | "IMPORT_USER_GROUPS" | "IMPORT_HARDWARE_TOKENS" | "IMPORT_ENROLLMENTS" | "PRINT_ENROLLMENTS" | "SEND_MFP" | "ASSIGN_ENTRUST_ST" | "ASSIGN_GOOGLE_ST" | "ASSIGN_PASSWORDS" | "RESET_PASSWORDS" | "DELETE_USERS" | "IMPORT_IDENTITYGUARD" | "IMPORT_GRIDS" | "EXPORT_ASSIGNEDGRIDS" | "EXPORT_ASSIGNEDTOKENS" | "EXPORT_AUDITEVENTS" | "EXPORT_SELFAUDITEVENTS" | "EXPORT_UNASSIGNEDGRIDS" | "EXPORT_UNASSIGNEDTOKENS" | "EXPORT_USERS" | "SET_REGISTRATION" | "SET_VERIFICATION" | "ASSIGN_GRIDS" | "EXPORT_USAGE" | "CREATE_UNASSIGNED_GRIDS" | "ASSIGN_HARDWARE_TOKENS" | "SET_GRIDS" | "EXPORT_ENROLLMENTS" | "DELETE_GROUPS" | "EXPORT_GROUPS" | "RESET_TOKENS" | "DELETE_ENROLLMENTS" | "PROVISION_SCIM" | "CREATE_TENANT" | "REVOKE_MFP" | "DELETE_GRIDS" | "DELETE_TOKENS";
};
type BulkPrintOperationDetails = {
	/** The error message describing the first error encountered processing the bulk operation. */
	errorMessage?: string;
	/** The row number of the first row that failed. */
	firstFailedRow?: number;
	/** The unique UUID of the bulk operation. */
	id?: string;
	/** The time this bulk operation was initialized. */
	initTime?: string;
	/** The name of this bulk operation. */
	name?: string;
	/** The time at which the bulk operation completed processing. */
	processingEndTime?: string;
	/** The time at which the bulk operation began processing. */
	processingStartTime?: string;
	/** How long the bulk operation took to complete processing. */
	processingTime?: number;
	/** The number of rows that have failed when processed. */
	rowsFailed?: number;
	/** The number of rows successfully processed. */
	rowsProcessed?: number;
	/** The state of the bulk operation. */
	state?: "FAILED" | "CANCELLED" | "COMPLETED" | "AWAITING_DATA" | "PROCESSING" | "SCHEDULED";
	/** The type of bulk operation. */
	"type"?: "IMPORT_USERS" | "IMPORT_GROUPS" | "IMPORT_USER_GROUPS" | "IMPORT_HARDWARE_TOKENS" | "IMPORT_ENROLLMENTS" | "PRINT_ENROLLMENTS" | "SEND_MFP" | "ASSIGN_ENTRUST_ST" | "ASSIGN_GOOGLE_ST" | "ASSIGN_PASSWORDS" | "RESET_PASSWORDS" | "DELETE_USERS" | "IMPORT_IDENTITYGUARD" | "IMPORT_GRIDS" | "EXPORT_ASSIGNEDGRIDS" | "EXPORT_ASSIGNEDTOKENS" | "EXPORT_AUDITEVENTS" | "EXPORT_SELFAUDITEVENTS" | "EXPORT_UNASSIGNEDGRIDS" | "EXPORT_UNASSIGNEDTOKENS" | "EXPORT_USERS" | "SET_REGISTRATION" | "SET_VERIFICATION" | "ASSIGN_GRIDS" | "EXPORT_USAGE" | "CREATE_UNASSIGNED_GRIDS" | "ASSIGN_HARDWARE_TOKENS" | "SET_GRIDS" | "EXPORT_ENROLLMENTS" | "DELETE_GROUPS" | "EXPORT_GROUPS" | "RESET_TOKENS" | "DELETE_ENROLLMENTS" | "PROVISION_SCIM" | "CREATE_TENANT" | "REVOKE_MFP" | "DELETE_GRIDS" | "DELETE_TOKENS";
};
type CredentialDesignPrintRequestPrinter = {
	/** The message to display on the printer LCD screen when the exception slot is selected. Maximum 45 character limit for Sigma printers, and 32 character limit for older printers. */
	exceptionSlotMessage?: string;
	/** The printer hopper to use. Value of 0 will use the printer exception slot. */
	hopper?: number;
	printerId?: string;
};
type EnrollmentMultiPrintApiRequestV1 = {
	credentialDesignName?: string;
	enrollmentDesignName?: string;
	primaryKeys?: string[];
	printerDetails?: CredentialDesignPrintRequestPrinter;
};
type ResumePrintJobApiRequest = {
	/** The print job id obtained through the pre print webhook payload.  */
	printJobId: string;
};
type ResumePrintJobApiResponse = {
	/** The job id of the requested print job to resume */
	printJobId?: string;
};
type EnrollmentPrintApiRequestV1 = {
	/** The design name of the enrollment. <b>Note:</b> primaryKey parameter is required when this parameter is present. */
	enrollmentDesignName?: string;
	/** The unique enrollment ID obtained from Read Enrollments request. <b>Note:</b> primaryKey and enrollmentDesignName parameters are not required when this parameter is present. */
	enrollmentId?: string;
	/** The primary key of the enrollment */
	primaryKey?: string;
	printerDetails: CredentialDesignPrintRequestPrinter;
};
type EnrollmentPrintApiResponse = {
	/** The job id of the requested enrollment print */
	printJobId?: string;
};
type PrintRequestDetails = {
	/** The error message describing the first error encountered processing the bulk operation. */
	errorMessage?: string;
	/** The row number of the first row that failed. */
	firstFailedRow?: number;
	/** The unique UUID of the request. */
	id?: string;
	/** The time this bulk operation was initialized. */
	initTime?: string;
	/** The name of this bulk operation. */
	name?: string;
	/** The time at which the bulk operation completed processing. */
	processingEndTime?: string;
	/** The time at which the bulk operation began processing. */
	processingStartTime?: string;
	/** How long the bulk operation took to complete processing. */
	processingTime?: number;
	/** The number of rows that have failed when processed. */
	rowsFailed?: number;
	/** The number of rows successfully processed. */
	rowsProcessed?: number;
	/** The state of the bulk operation. */
	state?: "FAILED" | "CANCELLED" | "COMPLETED" | "AWAITING_DATA" | "PROCESSING" | "SCHEDULED";
	/** The type of bulk operation. */
	"type"?: "IMPORT_USERS" | "IMPORT_GROUPS" | "IMPORT_USER_GROUPS" | "IMPORT_HARDWARE_TOKENS" | "IMPORT_ENROLLMENTS" | "PRINT_ENROLLMENTS" | "SEND_MFP" | "ASSIGN_ENTRUST_ST" | "ASSIGN_GOOGLE_ST" | "ASSIGN_PASSWORDS" | "RESET_PASSWORDS" | "DELETE_USERS" | "IMPORT_IDENTITYGUARD" | "IMPORT_GRIDS" | "EXPORT_ASSIGNEDGRIDS" | "EXPORT_ASSIGNEDTOKENS" | "EXPORT_AUDITEVENTS" | "EXPORT_SELFAUDITEVENTS" | "EXPORT_UNASSIGNEDGRIDS" | "EXPORT_UNASSIGNEDTOKENS" | "EXPORT_USERS" | "SET_REGISTRATION" | "SET_VERIFICATION" | "ASSIGN_GRIDS" | "EXPORT_USAGE" | "CREATE_UNASSIGNED_GRIDS" | "ASSIGN_HARDWARE_TOKENS" | "SET_GRIDS" | "EXPORT_ENROLLMENTS" | "DELETE_GROUPS" | "EXPORT_GROUPS" | "RESET_TOKENS" | "DELETE_ENROLLMENTS" | "PROVISION_SCIM" | "CREATE_TENANT" | "REVOKE_MFP" | "DELETE_GRIDS" | "DELETE_TOKENS";
};
type PrintCount = {
	/** The count. */
	count?: number;
	/** The name of the count. */
	name?: string;
};
type PrintCountResponse = {
	counts?: PrintCount[];
};
type Printer = {
	/** Total cards successfully printed by printer. */
	cardsPrinted?: number;
	/** number of cards remaining before cleaning */
	cardsRemaining?: number;
	/** Self signed certs for legacy printers */
	certificate?: string;
	/** Printers unique device ID obtained from the printer LCD. */
	deviceId?: string;
	/** Optional physical location of the printer. */
	location?: string;
	/** The printer name */
	name?: string;
	/** The printer platform */
	printerPlatform?: string;
	/** A flag used to determine if the printer has PTP ribbon or not (Ignore this field in the API request or response) */
	ptpReady?: boolean;
	/** The part number of the retransfer ribbon installed on printer */
	retransferPartNumber?: string;
	/** percentage of retransfer roll remaining in printer */
	retransferRollRemaining?: number;
	/** ID of the cloud enabled ribbon installed in the printer (Ignore this field in the API request or response) */
	ribbonId?: string;
	/** The part number of the print ribbon installed on printer */
	ribbonPartNumber?: string;
	/** The region of the ribbon installed */
	ribbonRegion?: string;
	/** percentage of ribbon remaining in printer */
	ribbonRemaining?: number;
	/** A flag used to determine if the smart card simulator needs to be invoked */
	scSimulator?: boolean;
	/** The unique serial number of the printer */
	serialNumber?: string;
	status?: "BUSY" | "IDLE" | "TIMEOUT" | "INVALID";
};
type PrinterRead = {
	/** Total cards successfully printed by printer. */
	cardsPrinted?: number;
	/** number of cards remaining before cleaning */
	cardsRemaining?: number;
	/** Self signed certs for legacy printers */
	certificate?: string;
	/** Printers unique device ID obtained from the printer LCD. */
	deviceId?: string;
	/** The date when the firmware version was last checked */
	firmwareCheckedOn?: string;
	/** The request id for an active firmware update */
	firmwareUpdateRequestId?: string;
	/** The date when the firmware version was last updated */
	firmwareUpdatedOn?: string;
	/** The firmware version */
	firmwareVersion?: string;
	/** The number of hoppers */
	hoppers?: number;
	id?: string;
	/** Optional physical location of the printer. */
	location?: string;
	/** The printer model */
	model?: string;
	/** The printer name */
	name?: string;
	/** A newer firmware version */
	newFirmwareVersion?: string;
	/** The printer platform */
	printerPlatform?: string;
	/** The printer type */
	printerType?: string;
	/** A flag used to determine if the printer has PTP ribbon or not (Ignore this field in the API request or response) */
	ptpReady?: boolean;
	/** The part number of the retransfer ribbon installed on printer */
	retransferPartNumber?: string;
	/** percentage of retransfer roll remaining in printer */
	retransferRollRemaining?: number;
	/** ID of the cloud enabled ribbon installed in the printer (Ignore this field in the API request or response) */
	ribbonId?: string;
	/** The part number of the print ribbon installed on printer */
	ribbonPartNumber?: string;
	/** The region of the ribbon installed */
	ribbonRegion?: string;
	/** percentage of ribbon remaining in printer */
	ribbonRemaining?: number;
	/** A flag used to determine if the smart card simulator needs to be invoked */
	scSimulator?: boolean;
	/** The unique serial number of the printer */
	serialNumber?: string;
	status?: "BUSY" | "IDLE" | "TIMEOUT" | "INVALID";
};
type ResourceIdResponse = {
	link?: string;
};
type ResourceIdResponseRead = {
	id?: string;
	link?: string;
};
type SmartCardCommandResponse = {
	response?: string;
};
type BasicPrintResponseData = {
	copiesRemaining?: number;
	smartcardResponses?: SmartCardCommandResponse[];
};
type BasicPrintResponse = {
	createdOn?: string;
	data?: BasicPrintResponseData;
	status?: "QUEUED" | "WAITING_SMARTCARD" | "IN_PROGRESS" | "COMPLETED" | "FAILED" | "CANCELLED" | "UNKNOWN" | "AWAITING_PRINT";
	/** Print status details returned from the printer. */
	statusDetails?: string;
	updatedOn?: string;
};
type SmartCardCommand = {
	command: string;
	resultMatcher?: string;
	"type": "APDU" | "COUPLER";
};
type BasicPrintUpdateRequestSmartcard = {
	commands?: SmartCardCommand[];
};
type BasicPrintUpdateRequest = {
	smartcard?: BasicPrintUpdateRequestSmartcard;
};
type PrintOperationResponse = {
	printStatus?: ResourceIdResponse;
};
type PrintOperationResponseRead = {
	printStatus?: ResourceIdResponseRead;
};
type PrinterSummaryResponse = {
	/** The total number of printers */
	printerCount?: number;
};
type Laminators = {
	Laminator1?: "DO_NOT_APPLY" | "APPLY_ONCE" | "APPLY_TWICE";
	Laminator2?: "DO_NOT_APPLY" | "APPLY_ONCE" | "APPLY_TWICE";
};
type Lamination = {
	back?: Laminators;
	front?: Laminators;
};
type PrinterPreferences = {
	backOrientation?: "PORTRAIT" | "LANDSCAPE";
	/** Rotate back side card image 180 degrees? */
	backRotate180?: boolean;
	/** Print bar codes using monochrome? */
	barCodesMonochrome?: boolean;
	/** Print black image pixels using monochrome? */
	blackPixelsMonochrome?: boolean;
	/** The number of copies to print */
	copies?: number;
	/** Debow card? */
	debow?: boolean;
	disablePrinting?: "false" | "ALL" | "FRONT" | "BACK";
	frontOrientation?: "PORTRAIT" | "LANDSCAPE";
	/** Rotate front side card image 180 degrees? */
	frontRotate180?: boolean;
	/** The input hopper from which to select a card */
	inputHopper?: number;
	lamination?: Lamination;
	/** The resolution at which printer will print. This will be NA if printer supports only 1 resolution. */
	printResolution?: "NA" | "BEST" | "STANDARD";
	/** Rewrite card? */
	rewrite?: boolean;
	splitRibbon?: "false" | "YMCT_FRONT_K_BACK" | "YMC_FRONT_KT_BACK" | "K_FRONT_YMCT_BACK" | "YMC_FRONT_K_BACK" | "K_FRONT_YMC_BACK" | "K_FRONT_YMCKT_BACK" | "KT_FRONT_YMCKT_BACK" | "YMCKTT_FRONT_K_BACK" | "YMCKFT_FRONT_K_BACK" | "MTT_FRONT_K_BACK";
	tactileBack?: "true" | "false" | "1" | "2" | "3";
	tactileFront?: "true" | "false" | "1" | "2" | "3";
	/** Applies topcoat to both front and back sides when front/back values are not provided. */
	topcoat?: boolean;
	/** Applies topcoat to the back side of the card. When both topcoatFront and topcoatBack are null or undefined,topcoat value is used. */
	topcoatBack?: boolean;
	/** Applies topcoat to the front side of the card. When both topcoatFront and topcoatBack are null or undefined,topcoat value is used. */
	topcoatFront?: boolean;
};
type Billing = {
	segmentId?: string;
};
type MagStripe = {
	/** Coercivity */
	coercivity?: "HIGH" | "LOW";
	/** Track 1 data */
	track1?: string;
	/** Track 2 data */
	track2?: string;
	/** Track 3 data */
	track3?: string;
	/** Track type */
	trackType?: "IAT" | "AAMVA" | "NTT" | "PRINTER";
};
type MagStripeEncodeCommands = {
	back?: MagStripe;
	front?: MagStripe;
};
type PrintImageLayer = {
	/** A base64 url encoded image (JPEG or PNG). For BLACK layer, it is advised to use black and white image with 1bit per pixel and 1013 * 638. Example choose black and white option and set the properties via MS paint. */
	data: string;
	/** The enhanceBlackLayer value defaults as FALSE. To enhance the quality of a black and white or grayscale image that is not 1 bit per pixel, set the enhanceBlackLayer value as TRUE. */
	enhanceBlackLayer?: boolean;
	layer?: "COLOR" | "UV" | "BLACK" | "PEEL_OFF" | "NON_PRINTABLE_GENERIC" | "NON_PRINTABLE_CHIP" | "NON_PRINTABLE_MAGSTRIPE" | "NON_PRINTABLE_SIGNATURE";
};
type Print = {
	/** A set of base64 url encoded image (JPEG or PNG) that represents the back side of the card. One image per print layer (e.g. UV, Color, Black) may be provided. */
	back?: PrintImageLayer[];
	/** A set of base64 url encoded image (JPEG or PNG) that represents the front side of the card. One image per print layer (e.g. UV, Color, Black) may be provided. */
	front?: PrintImageLayer[];
};
type BasicPrintRequestSmartcard = {
	commands?: SmartCardCommand[];
	/** Perform smart cards operations over multiple print requests. This feature is NOT supported with Instant ID as a Service. */
	multistep?: boolean;
};
type BasicPrintRequest = {
	billing?: Billing;
	/** The message to display on the printer LCD screen when the exception slot is selected. Maximum 45 character limit for Sigma printers, and 32 character limit for older printers. */
	exceptionSlotMessage?: string;
	/** The printer hopper to use. Value of 0 will use the printer exception slot. */
	hopper?: number;
	magstripe?: MagStripeEncodeCommands;
	print?: Print;
	printerPreferences?: PrinterPreferences;
	smartcard?: BasicPrintRequestSmartcard;
};
type PrintJob = {
	/** The time this print job was created. */
	createdOn?: string;
	/** The unique Id of the creator of this print job. */
	creatorId?: string;
	/** The name of the creator of this print job. */
	creatorName?: string;
	/** The type of the creator of this print job. */
	creatorType?: "USER" | "API";
	/** The unique id of this print job. */
	id?: string;
	/** The name of this print job. */
	name?: string;
	/** The unique Id of the printer. */
	printerId?: string;
	/** The name of the printer. */
	printerName?: string;
	queueState?: "UNKNOWN" | "QUEUED" | "WAIT_FOR_PRINTER" | "STARTED" | "COMPLETED" | "CANCELLED" | "FAILED" | "AWAITING_PRINT";
	/** Details about the queue state of this print job. */
	queueStateDetails?: string;
	status?: "QUEUED" | "WAITING_SMARTCARD" | "IN_PROGRESS" | "COMPLETED" | "FAILED" | "CANCELLED" | "UNKNOWN" | "AWAITING_PRINT";
	/** Print status details returned from the printer. */
	statusDetails?: string;
	/** The time this print job was last updated. */
	updatedOn?: string;
};
type OrderByAttribute = {
	/** Identifies whether to order results in ascending order. */
	ascending: boolean;
	/** Identifies the attribute. */
	name: string;
};
type SearchByAttribute = {
	/** Identifies the attribute we are searching for. */
	name: string;
	/** Identifies the operator. */
	operator: "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "STARTS_WITH" | "ENDS_WITH" | "GREATER_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN" | "LESS_THAN_OR_EQUAL" | "IN" | "EXISTS" | "NOT_EXISTS";
	/** Identifies the value of the attribute we are searching for. */
	value?: string;
};
type SearchParms = {
	/** Users search only: additional, non-core attributes to include in the returned object. Attribute names are specific to the returned object. */
	attributes?: string[];
	/** Identifies the page to return when paging over a result set--if present, search by / order by attributes are ignored. */
	cursor?: string;
	/** Identifies the maximum number of items to include in a page (1-100). */
	limit?: number;
	orderByAttribute?: OrderByAttribute;
	/** Identifies attributes for searching purposes. Some end-points have pre-defined values and ignore this attribute. */
	searchByAttributes?: SearchByAttribute[];
};
type Paging = {
	/** The page limit used (1-100) */
	limit: number;
	/** The cursor pointing to the next page. */
	nextCursor?: string;
	/** The cursor pointing to the previous page. */
	prevCursor?: string;
};
type PrintJobRecord = {
	/** Name of associated Bulk Print Operation */
	bulkOperationName?: string;
	/** job creation time */
	createdOn?: string;
	/** The unique Id of the creator of this print job. */
	creatorId?: string;
	/** The name of the creator of this print job. */
	creatorName?: string;
	/** The type of the creator of this print job. */
	creatorType?: "USER" | "API";
	/** job id */
	id?: number;
	identifierField?: string;
	identifierValue?: string;
	/** The unique id of this print job in print queue. */
	jobId?: string;
	/** job name */
	name?: string;
	/** The unique Id of the printer. */
	printerId?: string;
	/** printer name */
	printerName?: string;
	queueState?: "UNKNOWN" | "QUEUED" | "WAIT_FOR_PRINTER" | "STARTED" | "COMPLETED" | "CANCELLED" | "FAILED" | "AWAITING_PRINT";
	/** Details about the queue state of this print job. */
	queueStateDetails?: string;
	status?: "QUEUED" | "WAITING_SMARTCARD" | "IN_PROGRESS" | "COMPLETED" | "FAILED" | "CANCELLED" | "UNKNOWN" | "AWAITING_PRINT";
	/** job status */
	statusDetails?: string;
	/** The time this print job was last updated. */
	updatedOn?: string;
};
type PrintQueuePaging = {
	paging?: Paging;
	printJobs?: PrintJobRecord[];
};
type RoleUser = {
	/** A flag indicating if this role is one of the default roles. */
	defaultRole?: boolean;
	/** The UUID of the role. */
	id?: string;
	/** The description of the role. */
	roleDescription?: string;
	/** The name of the role */
	roleName: string;
	/** The number of users in this role. */
	usersInRole?: number;
};
type Permission = {
	/** The action to which this permission applies. */
	actionType: "VIEW" | "ADD" | "EDIT" | "REMOVE" | "ALL";
	/** The entity to which this permission applies. */
	entityType: "ALL" | "SUBSCRIBERS" | "USERS" | "APPLICATIONS" | "TOKENS" | "ROLES" | "SPROLES" | "CONTEXTRULES" | "AUTHORIZATIONGROUPS" | "USERATTRIBUTES" | "USERATTRIBUTEVALUES" | "AGENTS" | "GROUPS" | "SETTINGS" | "DIRECTORIES" | "DIRECTORYSYNC" | "DIRECTORYCONNECTIONS" | "TEMPLATES" | "USERSITEROLES" | "REPORTS" | "BULKUSERS" | "BULKGROUPS" | "USERPASSWORDS" | "SERVICEPROVIDERS" | "SERVICEPROVIDERACCOUNTS" | "USERMACHINES" | "CAS" | "BULKHARDWARETOKENS" | "BULKSMARTCARDS" | "DIGITALIDCONFIGS" | "DIGITALIDCONFIGVARIABLES" | "DIGITALIDCONFIGCERTTEMPS" | "DIGITALIDCONFIGSANS" | "SCDEFNS" | "SCDEFNPIVAPPLETCONFIGS" | "SCDEFNVARIABLES" | "SMARTCREDENTIALS" | "SMARTCREDENTIALSSIGNATURE" | "USERSPROLES" | "EXPECTEDLOCATIONS" | "USERLOCATIONS" | "USERRBASETTINGS" | "SPCLIENTCREDENTIALS" | "SPMANAGEMENTPLATFORM" | "ENTITLEMENTS" | "QUESTIONS" | "USERQUESTIONS" | "USERQUESTIONANSWERS" | "USERKBACHALLENGES" | "WORDSYNONYMS" | "GATEWAYS" | "GATEWAYCSRS" | "SPUSERMGMT" | "BULKIDENTITYGUARD" | "TEMPACCESSCODES" | "TEMPACCESSCODECONTENTS" | "GRIDS" | "GRIDCONTENTS" | "FIDOTOKENS" | "EXPORTREPORTS" | "CUSTOMIZATIONVARIABLES" | "BLACKLISTEDPASSWORDS" | "SPENTITLEMENTS" | "CREATETENANT" | "TENANTS" | "ARCHIVES" | "CERTIFICATES" | "INTELLITRUSTDESKTOPS" | "ACTIVESYNC" | "PRINTERS" | "ISSUANCE" | "OTPS" | "AD_CONNECTOR_DIRECTORIES" | "AZURE_DIRECTORIES" | "SCHEDULEDTASKS" | "CREDENTIALDESIGNS" | "ENROLLMENTS" | "BULKENROLLMENTS" | "EMAILTEMPLATES" | "EMAILVARIABLES" | "SENDEMAIL" | "SENDSCIM" | "SENDAZUREAD" | "DIRECTORYPASSWORD" | "TRANSACTIONITEMS" | "TRANSACTIONRULES" | "ENROLLMENTDESIGNS" | "HIGH_AVAILABILITY_GROUPS" | "PKIAASCREDENTIALS" | "DIGITALIDCERTIFICATES" | "PIVCONTENTSIGNER" | "RESOURCESERVERAPIS" | "RESOURCESERVERSCOPES" | "USEROAUTHTOKENS" | "GROUPPOLICIES" | "OAUTHROLES" | "IDENTITYPROVIDERS" | "SMARTCARDS" | "IPLISTS" | "DOMAINCONTROLLERCERTS" | "OTPPROVIDERS" | "PREFERREDOTPPROVIDERS" | "SPIDENTITYPROVIDERS" | "PUSHCREDENTIALS" | "DIRECTORYSEARCHATTRIBUTES" | "DIRECTORYATTRIBUTES" | "RISKENGINES" | "SCIMPROVISIONINGS" | "RATELIMITING" | "CLAIMS" | "CONTACTVERIFICATION" | "HOSTNAMESETTINGS" | "MAGICLINKS" | "MAGICLINKCONTENTS" | "AUTHENTICATIONFLOWS" | "FACE" | "TOKENACTIVATIONCONTENTS" | "PASSTHROUGH" | "POLICYOVERRIDE" | "ORGANIZATIONS" | "WEBHOOKS" | "WEBHOOK_NOTIFICATION" | "VCDEFNS" | "VCS" | "PLAYINTEGRITYCREDENTIALS" | "VPDEFNS" | "ACRS" | "FLEET_MANAGEMENT_ALERT" | "VERIFYUSER" | "USER_PRINTER_PREFERENCE" | "NAMEDPASSWORDS";
	/** The UUID of this permission. */
	id: string;
	/** The role type to which this permission applies. */
	roleType: "SITE_ADMINISTRATOR" | "ACCOUNT_MANAGER";
};
type Role = {
	/** A flag indicating if administrators with this role can manage all roles and all users. */
	allRoles?: boolean;
	/** A flag indicating if this role is one of the default roles. */
	defaultRole?: boolean;
	/** The description of the role. */
	description?: string;
	/** The UUIDs of groups associated with this role when Group Management is DEFINED. This attribute is ignored if Group Management is ALL or OWN. */
	groupIds?: string[];
	/** The type of the group management. Defaults to ALL if not provided. */
	groupManagement?: "ALL" | "DEFINED" | "OWN";
	/** The UUID of the role. */
	id?: string;
	/** If allRoles is false, this attribute lists the roles and administrators in these roles that can be administered by administrators with this role.  Administrators will also be able to manage end users. */
	managedRoles?: Role[];
	/** The name of the role. */
	name: string;
	/** A list of the permissions assigned to this role. */
	permissions?: Permission[];
	/** The type of the role. */
	roleType: "SITE_ADMINISTRATOR" | "ACCOUNT_MANAGER";
	/** A flag indicating if this role is a super administrator. */
	superAdministrator?: boolean;
};
type SpIdentityProvider = {
	/** The client id of this tenant management. */
	clientId?: string;
	/** The default max age of this tenant management. */
	defaultMaxAge?: number;
	/** Whether this tenant management should display consent. */
	displayConsent?: boolean;
	/** Whether tenant management is enabled. */
	enabled: boolean;
	/** The initiate login URI of this tenant management. */
	initiateLoginUri?: string;
	/** The name of this tenant management. */
	name: string;
	/** The signing key of this tenant management. */
	signingKeyId?: string;
};
type SpIdentityProviderParms = {
	/** Whether an initial default resource rule accessible to all users should be created for this tenant management. This is only used if tenant management was previously disabled. If not set, it defaults to false. */
	createDefaultResourceRule?: boolean;
	/** The default max age of this tenant management. If not set, it is not used. */
	defaultMaxAge?: number;
	/** If an initial default resource rule is enabled, whether to disable SSO. This is only used if an initial default resource rule is being enabled. If not set, it defaults to false. */
	disableSSODefaultResourceRule?: boolean;
	/** Whether this tenant management should display consent. If not set, it defaults to false. */
	displayConsent?: boolean;
	/** Whether tenant management is enabled. */
	enabled: boolean;
	/** The signing key of this tenant management. */
	signingKeyId?: string;
};
type WebhookEvent = {
	/** Subset of resource, or group IDs of the webhook event. All resources are selected by default if this parameter is not specified. */
	filter?: string;
	/** The ID of the webhook event. This value is not needed when creating/updating a webhook. */
	id?: string;
	/** The event type set to trigger the webhook. */
	"type": "user.created" | "user.updated" | "user.deleted" | "user.registration.completed" | "authentication.succeeded" | "authentication.failed" | "password.updated" | "magiclink.email.sent" | "grid.created" | "grid.email.sent" | "grid.password.email.sent" | "passkey.created" | "passkey.updated" | "passkey.deleted" | "kba.question.created" | "token.created" | "token.activated" | "token.activated.online" | "token.seed.rotated" | "hardware.token.assigned" | "face.biometric.created" | "credential.create" | "credential.update" | "credential.delete" | "credential.print";
};
type Webhook = {
	/** HTTPS endpoint URL where webhook event notifications will be sent. Must be a valid HTTPS URL. */
	callbackUrl: string;
	/** Indicates whether the webhook is active and will receive event notifications. Disabled webhooks will not receive any events. */
	enabled: boolean;
	/** List of event types that will trigger this webhook. If not specified, all available events will be sent. */
	events?: WebhookEvent[];
	/** Indicates whether the webhook has passed its expiry date and is no longer active. */
	expired?: boolean;
	/** Timestamp indicating when the webhook will automatically expire and stop receiving events. Null indicates no expiration. */
	expiryDate?: string;
	/** Unique identifier for the webhook. This value is automatically generated upon webhook creation and cannot be modified. */
	id: string;
	/** Descriptive name for the webhook to help identify its purpose. */
	name?: string;
	/** Secure authentication token used to verify webhook request authenticity. Use this token to validate incoming webhook requests. */
	token?: string;
};
type WebhookParms = {
	/** HTTPS endpoint URL where webhook event notifications will be sent. Must be a valid HTTPS URL. */
	callbackUrl: string;
	/** Indicates whether the webhook is active and will receive event notifications. Disabled webhooks will not receive any events. */
	enabled?: boolean;
	/** List of event types that will trigger this webhook. If not specified, all available events will be sent. */
	events: WebhookEvent[];
	/** How long to keep the webhook alive for <b>(in days)</b>. Value of 0 means no expiration. Once a webhook has reached expiry, it will be marked as <b>disabled</b>. This parameter is optional and is not set by default. */
	expiry?: number;
	/** Descriptive name for the webhook to help identify its purpose. */
	name: string;
};
type WebhookTestParms = {
	/** Optional callback URL to use for this test request instead of the webhook's configured callback URL. Must be a valid URL. */
	callbackUrl?: string;
};
type Field = {
	/** A descriptive name of the enrollment field to filter results by. Must exactly match the Enrollment Field Name. */
	name?: string;
	/** Value of the enrollment field to match records. Comparison is case-insensitive and matches the whole word. Searching on Date type fields is not supported. */
	value?: string;
};
type EnrollmentRequest = {
	/** List of enrollment fields having field name and field value. Instant ID as a Service automatically optimizes images for best print quality and performance. Images in photograph, signature, and background fields are limited to 2100 x 1344 pixels or 3 MB in size. Images exceeding these limits will be automatically resized while preserving quality and aspect ratio. */
	fields: Field[];
	/** Id of the enrollment (Value is required only in the update enrollment request, should be ignored in create enrollment request). Id should be in Base64 string format. */
	id?: string;
};
type EnrollmentResponse = {
	/** Error message for the failed enrollment record (For create/update/delete enrollments request) */
	error?: string;
	/** List of enrollment fields having field name and field value (For search enrollments request only) */
	fields?: Field[];
	/** Id of the enrollment (In Base64 string format) */
	id?: string;
	/** Status (Success/Failure) of the enrollment record (To check if the requested enrollment is successfully created/updated/deleted or not) */
	status?: string;
};
type EnrollmentDelete = {
	/** List of Enrollment Ids to be deleted (Id should be in Base64 string format) */
	ids: string[];
};
type EnrollmentDesignName = {
	/** Id of the Enrollment Design */
	id?: string;
	/** Name of the Enrollment Design */
	name?: string;
};
type EnrollmentMultiFlashPassApiRequestV2 = {
	/** List of Enrollment Ids (Id should be in Base64 string format) */
	ids: string[];
};
type EnrollmentApiRequestPrinter = {
	/** Optional message to be displayed on printer's LCD screen when the exception slot is selected. */
	exceptionSlotMessage?: string;
	/** Hopper to be used (Optional), default value is 1 */
	hopper?: number;
	/** Name of the printer. Value is printer's name given while adding the printer using create printer API. Refer readPrinter/readPrinters API to get the value of 'name' field. */
	name: string;
};
type EnrollmentMultiPrintApiRequestV2 = {
	/** List of Enrollment Ids (Id should be in Base64 string format) */
	ids: string[];
	printer: EnrollmentApiRequestPrinter;
};
type SingleEnrollmentPrintRequest = {
	/** 16 character unique Auth key of the printer. This is required if printerId is not provided. */
	deviceId?: string;
	/** The design name of the enrollment. <b>Note:</b> primaryKey parameter is required when this parameter is present. */
	enrollmentDesignName?: string;
	/** The unique enrollment ID obtained from Read Enrollments request. <b>Note:</b> primaryKey and enrollmentDesignName parameters are not required when this parameter is present. */
	enrollmentId?: string;
	/** The message to display on the printer LCD screen when the exception slot is selected. Maximum 45 character limit for Sigma printers, and 32 character limit for older printers. */
	exceptionSlotMessage?: string;
	/** The printer hopper to use. Value of 0 will use the printer exception slot. */
	hopper: number;
	/** The primary key of the enrollment. <b>Note:</b> enrollmentDesignName parameter is required when this parameter is present. */
	primaryKey?: string;
	/** 32 or 36 character unique ID of the printer. This takes preference over deviceId if both are provided. */
	printerId?: string;
};
type UpdatePrinterV2Request = {
	/** The physical location of the printer. */
	location?: string;
	/** The printer's name. */
	name?: string;
};
type OrderAttribute = {
	/** Identifies whether to order result in ascending order. */
	ascending?: boolean;
	/** Identifies the attribute. */
	name?: string;
};
type SearchAttribute = {
	/** Identifies the attribute we are searching for. */
	name?: string;
	operator?: "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "STARTS_WITH" | "ENDS_WITH" | "GREATER_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN" | "LESS_THAN_OR_EQUAL" | "IN" | "IS" | "EXISTS" | "NOT_EXISTS";
	/** value of the field to search on. */
	value?: string;
};
type SearchParams = {
	/** The value of cursor. Provide null for 1st page. For next page, provide the value of nextCursor from last API response. For previous page, provide the vaue of prevCursor from last API response. */
	cursor?: string;
	/** Identifies the maximum number of items to include in a page (1-100). */
	limit?: number;
	orderByAttribute?: OrderAttribute;
	searchByAttributes?: SearchAttribute[];
};
type UserAlternateEmails = {
	/** Name of the email attribute. */
	name?: string;
	/** Value of the email attribute. */
	value?: string;
};
type UserAuthenticatorLockoutStatus = {
	/** Determines if this authenticator is currently locked out. */
	locked?: boolean;
	/** The date the user was locked. Null means the user is not locked. */
	lockoutDate?: string;
	/** if remainingAuthenticationAttempts is 0 then a lockoutExpiryDate of null means the lockout never expires. Otherwise a value of null means the user isn't locked out. */
	lockoutExpiryDate?: string;
	/** The users named password authentication that is locked out. */
	name?: string;
	/** The number of authentication attempts remaining before the user is locked out. */
	remainingAuthenticationAttempts?: number;
	/** The type of the authenticator. */
	"type"?: "MACHINE" | "PASSWORD" | "EXTERNAL" | "KBA" | "TEMP_ACCESS_CODE" | "OTP" | "GRID" | "TOKEN" | "TOKENCR" | "TOKENPUSH" | "FIDO" | "SMARTCREDENTIALPUSH" | "PASSWORD_AND_SECONDFACTOR" | "SMART_LOGIN" | "IDP" | "PASSKEY" | "IDP_AND_SECONDFACTOR" | "USER_CERTIFICATE" | "FACE" | "PASSTHROUGH" | "MAGICLINK";
};
type FidoToken = {
	/** The AAGUID of the authenticator that created this FIDO token. */
	aaguid?: string;
	/** Indicates whether the AAGUID reported by the authenticator was cryptographically verified via a full certificate chain against the FIDO MDS trust anchors. True only for DIRECT attestation; false for INDIRECT (cert chain not verified); null for NONE (no attestation collected). */
	aaguidVerified?: boolean;
	/** The signature algorithm of the authenticator that created this FIDO token. */
	algorithm?: string;
	/** Administration actions that can be performed on this FIDO token. */
	allowedActions?: ("DELETE" | "ENABLE" | "DISABLE" | "RENAME")[];
	/** Attestation format of the authenticator that created this FIDO token. */
	attestationFormat?: string;
	/** Indicates if this FIDO token contains attested data. */
	attestedData?: boolean;
	/** The authenticator model of the authenticator that created this FIDO token. */
	authenticatorModel?: string;
	/** Indicates if this FIDO token is eligible for backup. */
	backupEligible?: boolean;
	/** Indicates if this FIDO token is currently backed up. */
	backupStatus?: boolean;
	/** The date on which the FIDO token was created. */
	createDate?: string;
	/** The icon of the authenticator that created this FIDO token. */
	icon?: string;
	/** The unique UUID assigned to the fido token when it is registered. */
	id?: string;
	/** The date on which this FIDO token was last used for authentication. This value will be null if the FIDO token has never been used. */
	lastUsedDate?: string;
	/** The name of this FIDO token. */
	name?: string;
	/** The origin of where the FIDO token was generated. */
	origin?: string;
	/** The relying party ID of where the FIDO token was generated. */
	relyingPartyId?: string;
	/** The state of this FIDO token.  Only FIDO tokens in the ACTIVE state can be used for authentication. */
	state?: "ACTIVE" | "INACTIVE";
	/** The user Id of the user who owns this FIDO token. */
	userId?: string;
	/** Indicates if the userId was stored on the FIDO token. */
	userIdStored?: boolean;
	/** Indicates if the user was present during the registration or authentication ceremony that created or last used this FIDO token. */
	userPresent?: boolean;
	/** The UUID of the user who owns this FIDO token. */
	userUUID?: string;
	/** Indicates if the user was verified during the registration or authentication ceremony that created or last used this FIDO token. */
	userVerified?: boolean;
};
type Grid = {
	/** A list of what actions are currently allowed for this grid. */
	allowedActions?: ("CANCEL" | "DELETE" | "ENABLE" | "DISABLE" | "ASSIGN" | "UNASSIGN")[];
	/** For unassigned grids which were assigned to the user, the date on which the grid was assigned. */
	assignDate?: string;
	/** The date on which the grid was created. */
	createDate?: string;
	/** A flag indicating if this grid is currently expired. */
	expired?: boolean;
	/** If the grid policy defines an expiry date, the date on which this grid will expire. Expired grids cannot be used for authentication. */
	expiryDate?: string;
	/** The grid contents of this grid.  Only administrators with the GRIDCONTENTS:VIEW permission will receive this value. */
	gridContents?: string[][];
	/** The UUIDs of groups to which this grid belongs.  This value is only used for unassigned grids. Only groups to which the current administrator has access will be returned. */
	groups?: string[];
	/** The unique UUID assigned to the grid when it is created. */
	id?: string;
	/** The date on which this grid was last used for authentication. This value will be null if the grid has never been used. */
	lastUsedDate?: string;
	/** The unique numeric serial number assigned to the grid when it is created. */
	serialNumber?: number;
	/** The state of this grid.  Only grids in the ACTIVE or PENDING state can be used for authentication. */
	state?: "ACTIVE" | "INACTIVE" | "UNASSIGNED" | "PENDING" | "CANCELED";
	/** The UUID of the user who owns this grid.  If the grid is not assigned, this value will be null. */
	userId?: string;
	/** The user Id for this user.  If the grid is not assigned, this value will be null. */
	userName?: string;
};
type Group = {
	/** The attribute of this group. */
	attribute?: string;
	/** When the group was created. */
	created?: string;
	/** Whether the directory group is desynced. Desynced groups can be deleted. */
	directoryDesynced?: boolean;
	/** The externalId of this group. */
	externalId?: string;
	/** The UUID of this group.  This value is generated when the group is created. */
	id?: string;
	/** When the group was last modified. */
	lastModified?: string;
	/** The name of this group. */
	name: string;
	/** The type of group indicating if this group was synchronized from a directory (LDAP_AD) or was created in Identity as a Service (MGMT_UI). */
	"type"?: "LDAP_AD" | "MGMT_UI";
};
type OAuthRole = {
	/** The set of ancestor oauth role ids. */
	ancestorIds: string[];
	/** The set of descendant oauth role ids. */
	descendantIds: string[];
	/** The description of this oauth role. */
	description?: string;
	/** The UUID of this oauth role. This value is generated when the oauth role is created. */
	id: string;
	/** The set of resource server scopes ids associated with this oauth role based on inheritance from its ancestors. */
	inheritedResourceServerScopeIds: string[];
	/** The name of this oauth role. */
	name: string;
	/** The UUID of the parent of this oauth role, if one exists. */
	parentId?: string;
	/** The set of resource server scopes ids associated with this oauth role. */
	resourceServerScopeIds: string[];
};
type Organization = {
	/** The description of the organization. */
	description?: string;
	/** The display name of the organization. */
	displayName: string;
	/** The unique UUID assigned to the organization when it is created. */
	id: string;
	/** The URI of the logo to display when showing organizations. */
	logoUri?: string;
	/** The name of the organization. */
	name: string;
};
type DigitalIdConfigCertTemplate = {
	/** The UUID of the Digital Id Config that owns this Digital Id Config Cert Template. */
	digitalIdConfigId?: string;
	/** The UUID of the Digital Id Config Cert Template. */
	id?: string;
	/** The key type of the Digital Id Config Cert Template. */
	keyType?: "RSA_2048" | "EC_P_256";
	/** The lifetime (in months) of the certificate created with this Digital Id Config Cert Template. */
	lifetime?: number;
	/** The name of the Digital Id Config Cert Template. */
	name?: string;
	/** The PIV container of the Digital Id Config Cert Template. */
	pivContainer?: "PivAuth" | "CardAuth" | "DigSig" | "KeyMgmt" | "None";
	/** A flag indicating whether to use the CA's default certificate lifetime. */
	useCaDefaultCertLifetime?: boolean;
};
type DigitalIdConfigSubjectAltName = {
	/** The UUID of the digital id config that owns this subjectAltName. */
	digitalIdConfigId?: string;
	/** The UUID of this Digital Id Config SubjectAltName. */
	id?: string;
	/** The type of subjectAltName. */
	"type"?: "EMAIL" | "UPN" | "IP" | "DNS" | "OTHER" | "X400" | "DN" | "EDI" | "URI" | "REGISTERED_ID";
	/** The value for the subjectAltName. */
	value?: string;
};
type DigitalIdConfigVariable = {
	/** The UUID of the Digital Id Config that owns this Digital Id Config Variable. */
	digitalIdConfigId?: string;
	/** The UUID of the Digital Id Config Variable. */
	id?: string;
	/** A flag indicating if values for this variable are included in the Digital Id's DN when it is generated by the CA. */
	includedInDN?: boolean;
	/** The name of the Digital Id Config Variable. */
	name?: string;
	/** The type of the Digital Id Config Variable. */
	"type"?: "CERTIFICATE" | "USER" | "VARIABLE" | "CUSTOM";
	/** The value of the Digital Id Config Variable. */
	value?: string;
};
type DigitalIdConfig = {
	/** If true, digital ids using this config will be set to have all CA groups. */
	allCAGroups?: boolean;
	/** If allCAGroups is set to false then digital ids using this config will use this specified list of CA groups. */
	caGroups?: string[];
	/** The UUID of the CA for this digital id config. */
	caId?: string;
	/** The name of the CA for this digital id config. */
	caName?: string;
	/** The CA type of this Digital Id Config. */
	caType?: "EDC" | "MS" | "PKIAAS";
	/** A list of cert templates associated with this digital id config. */
	certTemplates?: DigitalIdConfigCertTemplate[];
	/** The CA certificate type which digital ids using this config will use. */
	certificateType?: string;
	/** When creating a digital id config, default values can be provided from this specified digital id config template. */
	digitalIdConfigTemplateId?: string;
	/** A flag indicating if digital ids using this config will create directory entries in the CA. */
	directoryEntry?: boolean;
	/** The format which digital ids using this config will use for their DN. */
	dnFormat?: string;
	/** Whether digital ids using this config should include the searchbase in their DN. */
	dnFormatSearchbaseIncluded?: boolean;
	/** The UUID of this Digital Id Config. */
	id?: string;
	/** The name of this Digital Id Config. */
	name?: string;
	/** The CA role which digital ids using this config will use. */
	role?: string;
	/** The searchbase within the CA in which digital ids using this config will be created. */
	searchbase?: string;
	/** A list of subject