@maccuaa/intellitrust-issuance-sdk
Version:
JavaScript client for @maccuaa/intellitrust-issuance-sdk
1,737 lines • 204 kB
TypeScript
import { AxiosRequestConfig } from 'axios';
import { BaseAPI } from './base';
/**
* Additional feature
* @export
* @interface AdditionalFeature
*/
export interface AdditionalFeature {
/**
* Enhanced geo location additional feature.
* @type {boolean}
* @memberof AdditionalFeature
*/
'enhancedGeoLocation'?: boolean;
}
/**
* Information returned when an Admin API application is fetched from Identity as a Service.
* @export
* @interface AdminApiApplication
*/
export interface AdminApiApplication {
/**
* Determines if the application can use a long-lived token for authentication.
* @type {boolean}
* @memberof AdminApiApplication
*/
'allowLongLivedToken'?: boolean;
/**
* The name of the application template specific to this application type.
* @type {string}
* @memberof AdminApiApplication
*/
'applicationTemplate': string;
/**
* Application template id specific to this application type.
* @type {string}
* @memberof AdminApiApplication
*/
'applicationTemplateId'?: string;
/**
* Short description of application.
* @type {string}
* @memberof AdminApiApplication
*/
'description'?: string;
/**
* Application ID.
* @type {string}
* @memberof AdminApiApplication
*/
'id'?: string;
/**
* The UUID of the IP Addresses list.
* @type {string}
* @memberof AdminApiApplication
*/
'ipListId'?: string;
/**
* Last successful authentication time to use administration api
* @type {string}
* @memberof AdminApiApplication
*/
'lastAuthnDate'?: string;
/**
* Base64 encoded logo image.
* @type {string}
* @memberof AdminApiApplication
*/
'logo'?: string;
/**
* Name of application.
* @type {string}
* @memberof AdminApiApplication
*/
'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.
* @type {string}
* @memberof AdminApiApplication
*/
'roleId'?: string;
/**
* Shared secret for application.
* @type {string}
* @memberof AdminApiApplication
*/
'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.
* @type {string}
* @memberof AdminApiApplication
*/
'spRoleId'?: string;
}
/**
* Parameters for the new application.
* @export
* @interface AdminApiApplicationParms
*/
export interface AdminApiApplicationParms {
/**
* Determines if a long-lived token is allowed in this application.
* @type {boolean}
* @memberof AdminApiApplicationParms
*/
'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.
* @type {string}
* @memberof AdminApiApplicationParms
*/
'applicationTemplateId'?: string;
/**
* Short description of application.
* @type {string}
* @memberof AdminApiApplicationParms
*/
'description'?: string;
/**
* The UUID of the IP Addresses list.
* @type {string}
* @memberof AdminApiApplicationParms
*/
'ipListId'?: string;
/**
* Base64 encoded logo image.
* @type {string}
* @memberof AdminApiApplicationParms
*/
'logo'?: string;
/**
* Name of application.
* @type {string}
* @memberof AdminApiApplicationParms
*/
'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.
* @type {string}
* @memberof AdminApiApplicationParms
*/
'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.
* @type {string}
* @memberof AdminApiApplicationParms
*/
'spRoleId'?: string;
}
/**
* Parameters passed to authenticate to an Admin API application.
* @export
* @interface AdminApiAuthentication
*/
export interface AdminApiAuthentication {
/**
* Administration API application id
* @type {string}
* @memberof AdminApiAuthentication
*/
'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.
* @type {boolean}
* @memberof AdminApiAuthentication
*/
'enableWebSession'?: boolean;
/**
* Shared Secret
* @type {string}
* @memberof AdminApiAuthentication
*/
'sharedSecret': string;
}
/**
*
* @export
* @interface AdminApiAuthenticationResult
*/
export interface AdminApiAuthenticationResult {
/**
* Authorization token returned after a successful authentication.
* @type {string}
* @memberof AdminApiAuthenticationResult
*/
'authToken'?: string;
/**
* Creation time of the authentication token.
* @type {string}
* @memberof AdminApiAuthenticationResult
*/
'creationTime'?: string;
/**
* Expiry time of the authentication token.
* @type {string}
* @memberof AdminApiAuthenticationResult
*/
'expirationTime'?: string;
}
/**
*
* @export
* @interface ApplicationInfo
*/
export interface ApplicationInfo {
/**
* The template the application was created from.
* @type {string}
* @memberof ApplicationInfo
*/
'applicationTemplate'?: string;
/**
* The UUID of the template the application was created from.
* @type {string}
* @memberof ApplicationInfo
*/
'applicationTemplateId'?: string;
/**
* The application authentication method.
* @type {string}
* @memberof ApplicationInfo
*/
'authenticationMethod'?: string;
/**
* The UUID of the application.
* @type {string}
* @memberof ApplicationInfo
*/
'id'?: string;
/**
* The name of the application.
* @type {string}
* @memberof ApplicationInfo
*/
'name'?: string;
}
/**
* Information returned about an Identity as a Service application template.
* @export
* @interface ApplicationTemplate
*/
export interface ApplicationTemplate {
/**
* The type the application template. Possible values are SAML20, RADIUS, AAAS, IDG, OIDC, AUTHAPI, ADMINAPI, SIEMAPI.
* @type {string}
* @memberof ApplicationTemplate
*/
'authenticationMethod': string;
/**
* The description of application template.
* @type {string}
* @memberof ApplicationTemplate
*/
'description'?: string;
/**
* The UUID of the application template.
* @type {string}
* @memberof ApplicationTemplate
*/
'id': string;
/**
* The name of the application template.
* @type {string}
* @memberof ApplicationTemplate
*/
'name': string;
}
/**
*
* @export
* @interface BasicPrintRequest
*/
export interface BasicPrintRequest {
/**
*
* @type {Billing}
* @memberof 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.
* @type {string}
* @memberof BasicPrintRequest
*/
'exceptionSlotMessage'?: string;
/**
* The printer hopper to use. Value of 0 will use the printer exception slot.
* @type {number}
* @memberof BasicPrintRequest
*/
'hopper'?: number;
/**
*
* @type {MagStripeEncodeCommands}
* @memberof BasicPrintRequest
*/
'magstripe'?: MagStripeEncodeCommands;
/**
*
* @type {Print}
* @memberof BasicPrintRequest
*/
'print'?: Print;
/**
*
* @type {PrinterPreferences}
* @memberof BasicPrintRequest
*/
'printerPreferences'?: PrinterPreferences;
/**
*
* @type {BasicPrintRequestSmartcard}
* @memberof BasicPrintRequest
*/
'smartcard'?: BasicPrintRequestSmartcard;
}
/**
*
* @export
* @interface BasicPrintRequestSmartcard
*/
export interface BasicPrintRequestSmartcard {
/**
*
* @type {Array<SmartCardCommand>}
* @memberof BasicPrintRequestSmartcard
*/
'commands'?: Array<SmartCardCommand>;
/**
*
* @type {boolean}
* @memberof BasicPrintRequestSmartcard
*/
'multistep'?: boolean;
}
/**
*
* @export
* @interface BasicPrintResponse
*/
export interface BasicPrintResponse {
/**
*
* @type {string}
* @memberof BasicPrintResponse
*/
'createdOn'?: string;
/**
*
* @type {BasicPrintResponseData}
* @memberof BasicPrintResponse
*/
'data'?: BasicPrintResponseData;
/**
*
* @type {string}
* @memberof BasicPrintResponse
*/
'status'?: BasicPrintResponseStatusEnum;
/**
*
* @type {string}
* @memberof BasicPrintResponse
*/
'updatedOn'?: string;
}
export declare const BasicPrintResponseStatusEnum: {
readonly Queued: "QUEUED";
readonly WaitingSmartcard: "WAITING_SMARTCARD";
readonly InProgress: "IN_PROGRESS";
readonly Completed: "COMPLETED";
readonly Failed: "FAILED";
readonly Cancelled: "CANCELLED";
readonly Unknown: "UNKNOWN";
readonly AwaitingPrint: "AWAITING_PRINT";
};
export type BasicPrintResponseStatusEnum = typeof BasicPrintResponseStatusEnum[keyof typeof BasicPrintResponseStatusEnum];
/**
*
* @export
* @interface BasicPrintResponseData
*/
export interface BasicPrintResponseData {
/**
*
* @type {number}
* @memberof BasicPrintResponseData
*/
'copiesRemaining'?: number;
/**
*
* @type {Array<SmartCardCommandResponse>}
* @memberof BasicPrintResponseData
*/
'smartcardResponses'?: Array<SmartCardCommandResponse>;
}
/**
*
* @export
* @interface BasicPrintUpdateRequest
*/
export interface BasicPrintUpdateRequest {
/**
*
* @type {BasicPrintUpdateRequestSmartcard}
* @memberof BasicPrintUpdateRequest
*/
'smartcard'?: BasicPrintUpdateRequestSmartcard;
}
/**
*
* @export
* @interface BasicPrintUpdateRequestSmartcard
*/
export interface BasicPrintUpdateRequestSmartcard {
/**
*
* @type {Array<SmartCardCommand>}
* @memberof BasicPrintUpdateRequestSmartcard
*/
'commands'?: Array<SmartCardCommand>;
}
/**
*
* @export
* @interface Billing
*/
export interface Billing {
/**
*
* @type {string}
* @memberof Billing
*/
'segmentId'?: string;
}
/**
*
* @export
* @interface BulkPrintOperationDetails
*/
export interface BulkPrintOperationDetails {
/**
* The error message describing the first error encountered processing the bulk operation.
* @type {string}
* @memberof BulkPrintOperationDetails
*/
'errorMessage'?: string;
/**
* The row number of the first row that failed.
* @type {number}
* @memberof BulkPrintOperationDetails
*/
'firstFailedRow'?: number;
/**
* The unique UUID of the bulk operation.
* @type {string}
* @memberof BulkPrintOperationDetails
*/
'id'?: string;
/**
* The time this bulk operation was initialized.
* @type {string}
* @memberof BulkPrintOperationDetails
*/
'initTime'?: string;
/**
* The name of this bulk operation.
* @type {string}
* @memberof BulkPrintOperationDetails
*/
'name'?: string;
/**
* The time at which the bulk operation completed processing.
* @type {string}
* @memberof BulkPrintOperationDetails
*/
'processingEndTime'?: string;
/**
* The time at which the bulk operation began processing.
* @type {string}
* @memberof BulkPrintOperationDetails
*/
'processingStartTime'?: string;
/**
* How long the bulk operation took to complete processing.
* @type {number}
* @memberof BulkPrintOperationDetails
*/
'processingTime'?: number;
/**
* The number of rows that have failed when processed.
* @type {number}
* @memberof BulkPrintOperationDetails
*/
'rowsFailed'?: number;
/**
* The number of rows successfully processed.
* @type {number}
* @memberof BulkPrintOperationDetails
*/
'rowsProcessed'?: number;
/**
* The state of the bulk operation.
* @type {string}
* @memberof BulkPrintOperationDetails
*/
'state'?: BulkPrintOperationDetailsStateEnum;
/**
* The type of bulk operation.
* @type {string}
* @memberof BulkPrintOperationDetails
*/
'type'?: BulkPrintOperationDetailsTypeEnum;
}
export declare const BulkPrintOperationDetailsStateEnum: {
readonly Failed: "FAILED";
readonly Cancelled: "CANCELLED";
readonly Completed: "COMPLETED";
readonly AwaitingData: "AWAITING_DATA";
readonly Processing: "PROCESSING";
readonly Scheduled: "SCHEDULED";
};
export type BulkPrintOperationDetailsStateEnum = typeof BulkPrintOperationDetailsStateEnum[keyof typeof BulkPrintOperationDetailsStateEnum];
export declare const BulkPrintOperationDetailsTypeEnum: {
readonly ImportUsers: "IMPORT_USERS";
readonly ImportGroups: "IMPORT_GROUPS";
readonly ImportUserGroups: "IMPORT_USER_GROUPS";
readonly ImportHardwareTokens: "IMPORT_HARDWARE_TOKENS";
readonly ImportSmartCards: "IMPORT_SMART_CARDS";
readonly ImportEnrollments: "IMPORT_ENROLLMENTS";
readonly PrintEnrollments: "PRINT_ENROLLMENTS";
readonly SendMfp: "SEND_MFP";
readonly AssignEntrustSt: "ASSIGN_ENTRUST_ST";
readonly AssignGoogleSt: "ASSIGN_GOOGLE_ST";
readonly AssignPasswords: "ASSIGN_PASSWORDS";
readonly ResetPasswords: "RESET_PASSWORDS";
readonly DeleteUsers: "DELETE_USERS";
readonly ImportIdentityguard: "IMPORT_IDENTITYGUARD";
readonly ImportGrids: "IMPORT_GRIDS";
readonly ExportAssignedgrids: "EXPORT_ASSIGNEDGRIDS";
readonly ExportAssignedtokens: "EXPORT_ASSIGNEDTOKENS";
readonly ExportAuditevents: "EXPORT_AUDITEVENTS";
readonly ExportSelfauditevents: "EXPORT_SELFAUDITEVENTS";
readonly ExportUnassignedgrids: "EXPORT_UNASSIGNEDGRIDS";
readonly ExportUnassignedtokens: "EXPORT_UNASSIGNEDTOKENS";
readonly ExportUsers: "EXPORT_USERS";
readonly SetRegistration: "SET_REGISTRATION";
readonly SetVerification: "SET_VERIFICATION";
readonly AssignGrids: "ASSIGN_GRIDS";
readonly ExportUsage: "EXPORT_USAGE";
readonly CreateUnassignedGrids: "CREATE_UNASSIGNED_GRIDS";
readonly AssignHardwareTokens: "ASSIGN_HARDWARE_TOKENS";
readonly SetGrids: "SET_GRIDS";
readonly ExportEnrollments: "EXPORT_ENROLLMENTS";
readonly DeleteGroups: "DELETE_GROUPS";
readonly ExportGroups: "EXPORT_GROUPS";
readonly ResetTokens: "RESET_TOKENS";
readonly DeleteEnrollments: "DELETE_ENROLLMENTS";
readonly ProvisionScim: "PROVISION_SCIM";
readonly CreateTenant: "CREATE_TENANT";
readonly RevokeMfp: "REVOKE_MFP";
readonly DeleteGrids: "DELETE_GRIDS";
readonly DeleteTokens: "DELETE_TOKENS";
};
export type BulkPrintOperationDetailsTypeEnum = typeof BulkPrintOperationDetailsTypeEnum[keyof typeof BulkPrintOperationDetailsTypeEnum];
/**
* Information about the status of an asynchronous create tenant request.
* @export
* @interface CreateTenantAsyncStatus
*/
export interface CreateTenantAsyncStatus {
/**
* The error message describing the first error encountered processing the operation.
* @type {string}
* @memberof CreateTenantAsyncStatus
*/
'errorMessage'?: string;
/**
* The unique UUID of the operation. Used to get status and results of operation
* @type {string}
* @memberof CreateTenantAsyncStatus
*/
'id': string;
/**
* The time this operation was initialized.
* @type {string}
* @memberof CreateTenantAsyncStatus
*/
'initTime'?: string;
/**
* The time at which the operation completed processing.
* @type {string}
* @memberof CreateTenantAsyncStatus
*/
'processingEndTime'?: string;
/**
* The time at which the operation began processing.
* @type {string}
* @memberof CreateTenantAsyncStatus
*/
'processingStartTime'?: string;
/**
* How long the operation took to complete processing in milliseconds.
* @type {number}
* @memberof CreateTenantAsyncStatus
*/
'processingTime'?: number;
/**
* The state of the operation.
* @type {string}
* @memberof CreateTenantAsyncStatus
*/
'state': CreateTenantAsyncStatusStateEnum;
/**
* The subject of this operation.
* @type {string}
* @memberof CreateTenantAsyncStatus
*/
'subject'?: string;
}
export declare const CreateTenantAsyncStatusStateEnum: {
readonly Failed: "FAILED";
readonly Cancelled: "CANCELLED";
readonly Completed: "COMPLETED";
readonly AwaitingData: "AWAITING_DATA";
readonly Processing: "PROCESSING";
readonly Scheduled: "SCHEDULED";
};
export type CreateTenantAsyncStatusStateEnum = typeof CreateTenantAsyncStatusStateEnum[keyof typeof CreateTenantAsyncStatusStateEnum];
/**
* Parameters used to create the new tenant.
* @export
* @interface CreateTenantParms
*/
export interface CreateTenantParms {
/**
*
* @type {AdminApiApplicationParms}
* @memberof CreateTenantParms
*/
'adminApiApplication'?: AdminApiApplicationParms;
/**
*
* @type {UserParms}
* @memberof CreateTenantParms
*/
'adminUser': UserParms;
/**
* A flag indicating if a welcome email should be delivered. If not set, it defaults to false.
* @type {boolean}
* @memberof CreateTenantParms
*/
'deliverWelcomeEmail'?: boolean;
/**
*
* @type {EntitlementParms}
* @memberof CreateTenantParms
*/
'entitlements'?: EntitlementParms;
/**
*
* @type {TenantParms}
* @memberof CreateTenantParms
*/
'tenant': TenantParms;
}
/**
* Information returned from a create tenant request.
* @export
* @interface CreateTenantResult
*/
export interface CreateTenantResult {
/**
*
* @type {AdminApiApplication}
* @memberof CreateTenantResult
*/
'adminApiApplication'?: AdminApiApplication;
/**
*
* @type {User}
* @memberof CreateTenantResult
*/
'adminUser': User;
/**
*
* @type {Tenant}
* @memberof CreateTenantResult
*/
'tenant': Tenant;
}
/**
*
* @export
* @interface CredentialDesignPrintRequestPrinter
*/
export interface 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.
* @type {string}
* @memberof CredentialDesignPrintRequestPrinter
*/
'exceptionSlotMessage'?: string;
/**
* The printer hopper to use. Value of 0 will use the printer exception slot.
* @type {number}
* @memberof CredentialDesignPrintRequestPrinter
*/
'hopper'?: number;
/**
*
* @type {string}
* @memberof CredentialDesignPrintRequestPrinter
*/
'printerId'?: string;
}
/**
* Information stored about a digital id.
* @export
* @interface DigitalId
*/
export interface DigitalId {
/**
* The certificates associated with this digital id.
* @type {Array<DigitalIdCert>}
* @memberof DigitalId
*/
'certificates'?: Array<DigitalIdCert>;
/**
* The UUID of the digital Id config that defines this digital Id.
* @type {string}
* @memberof DigitalId
*/
'digitalIdConfigId'?: string;
/**
* The name of the digital id Config that defines this digital Id.
* @type {string}
* @memberof DigitalId
*/
'digitalIdConfigName'?: string;
/**
* The type of this digital Id.
* @type {string}
* @memberof DigitalId
*/
'digitalIdConfigType'?: DigitalIdDigitalIdConfigTypeEnum;
/**
* The current DN of the digital id.
* @type {string}
* @memberof DigitalId
*/
'dn'?: string;
/**
* The UUID of this DigitalId.
* @type {string}
* @memberof DigitalId
*/
'id'?: string;
}
export declare const DigitalIdDigitalIdConfigTypeEnum: {
readonly PivCardholder: "PIV_CARDHOLDER";
readonly PivCard: "PIV_CARD";
};
export type DigitalIdDigitalIdConfigTypeEnum = typeof DigitalIdDigitalIdConfigTypeEnum[keyof typeof DigitalIdDigitalIdConfigTypeEnum];
/**
* Information stored about a certificate associated with a digital id.
* @export
* @interface DigitalIdCert
*/
export interface DigitalIdCert {
/**
* The description providing the purpose of this certificate.
* @type {string}
* @memberof DigitalIdCert
*/
'description'?: string;
/**
* The UUID of the digital id to which this certificate belongs
* @type {string}
* @memberof DigitalIdCert
*/
'digitalIdId'?: string;
/**
* The type of the digital Id to which this certificate belongs.
* @type {string}
* @memberof DigitalIdCert
*/
'digitalIdType'?: DigitalIdCertDigitalIdTypeEnum;
/**
* The UUID of this Digital Id Certificate.
* @type {string}
* @memberof DigitalIdCert
*/
'id'?: string;
/**
* The issuer DN of this certificate.
* @type {string}
* @memberof DigitalIdCert
*/
'issuerDN'?: string;
/**
* The expiry date of this certificate.
* @type {string}
* @memberof DigitalIdCert
*/
'notAfter'?: string;
/**
* The issue date of this certificate.
* @type {string}
* @memberof DigitalIdCert
*/
'notBefore'?: string;
/**
* The name of the PIV container that stores this certificate on the smart card.
* @type {string}
* @memberof DigitalIdCert
*/
'pivContainer'?: string;
/**
* The serial number of this certificate.
* @type {string}
* @memberof DigitalIdCert
*/
'serialNumber'?: string;
/**
* The status of this certificate. If not set, the revocation status has not been retrieved from the CA.
* @type {string}
* @memberof DigitalIdCert
*/
'status'?: DigitalIdCertStatusEnum;
/**
* The subject DN of this certificate.
* @type {string}
* @memberof DigitalIdCert
*/
'subjectDN'?: string;
}
export declare const DigitalIdCertDigitalIdTypeEnum: {
readonly PivCardholder: "PIV_CARDHOLDER";
readonly PivCard: "PIV_CARD";
};
export type DigitalIdCertDigitalIdTypeEnum = typeof DigitalIdCertDigitalIdTypeEnum[keyof typeof DigitalIdCertDigitalIdTypeEnum];
export declare const DigitalIdCertStatusEnum: {
readonly Active: "ACTIVE";
readonly Revoked: "REVOKED";
readonly Hold: "HOLD";
readonly Expired: "EXPIRED";
readonly NotAvailable: "NOT_AVAILABLE";
};
export type DigitalIdCertStatusEnum = typeof DigitalIdCertStatusEnum[keyof typeof DigitalIdCertStatusEnum];
/**
* Information that defines how digital ids are created in the CA.
* @export
* @interface DigitalIdConfig
*/
export interface DigitalIdConfig {
/**
* If true, digital ids using this config will be set to have all CA groups.
* @type {boolean}
* @memberof DigitalIdConfig
*/
'allCAGroups'?: boolean;
/**
* If allCAGroups is set to false then digital ids using this config will use this specified list of CA groups.
* @type {Array<string>}
* @memberof DigitalIdConfig
*/
'caGroups'?: Array<string>;
/**
* The UUID of the CA for this digital id config.
* @type {string}
* @memberof DigitalIdConfig
*/
'caId'?: string;
/**
* The name of the CA for this digital id config.
* @type {string}
* @memberof DigitalIdConfig
*/
'caName'?: string;
/**
* The CA type of this Digital Id Config.
* @type {string}
* @memberof DigitalIdConfig
*/
'caType'?: DigitalIdConfigCaTypeEnum;
/**
* A list of cert templates associated with this digital id config.
* @type {Array<DigitalIdConfigCertTemplate>}
* @memberof DigitalIdConfig
*/
'certTemplates'?: Array<DigitalIdConfigCertTemplate>;
/**
* The CA certificate type which digital ids using this config will use.
* @type {string}
* @memberof DigitalIdConfig
*/
'certificateType'?: string;
/**
* When creating a digital id config, default values can be provided from this specified digital id config template.
* @type {string}
* @memberof DigitalIdConfig
*/
'digitalIdConfigTemplateId'?: string;
/**
* A flag indicating if digital ids using this config will create directory entries in the CA.
* @type {boolean}
* @memberof DigitalIdConfig
*/
'directoryEntry'?: boolean;
/**
* The format which digital ids using this config will use for their DN.
* @type {string}
* @memberof DigitalIdConfig
*/
'dnFormat'?: string;
/**
* Whether digital ids using this config should include the searchbase in their DN.
* @type {boolean}
* @memberof DigitalIdConfig
*/
'dnFormatSearchbaseIncluded'?: boolean;
/**
* The UUID of this Digital Id Config.
* @type {string}
* @memberof DigitalIdConfig
*/
'id'?: string;
/**
* The name of this Digital Id Config.
* @type {string}
* @memberof DigitalIdConfig
*/
'name'?: string;
/**
* The CA role which digital ids using this config will use.
* @type {string}
* @memberof DigitalIdConfig
*/
'role'?: string;
/**
* The searchbase within the CA in which digital ids using this config will be created.
* @type {string}
* @memberof DigitalIdConfig
*/
'searchbase'?: string;
/**
* A list of subjectAltNames associated with this digital id config.
* @type {Array<DigitalIdConfigSubjectAltName>}
* @memberof DigitalIdConfig
*/
'subjectAltNames'?: Array<DigitalIdConfigSubjectAltName>;
/**
* The type of digital id.
* @type {string}
* @memberof DigitalIdConfig
*/
'type'?: DigitalIdConfigTypeEnum;
/**
* The CA user type which digital ids using this config will use.
* @type {string}
* @memberof DigitalIdConfig
*/
'userType'?: string;
/**
* A list of variables associated with this digital id config.
* @type {Array<DigitalIdConfigVariable>}
* @memberof DigitalIdConfig
*/
'variables'?: Array<DigitalIdConfigVariable>;
}
export declare const DigitalIdConfigCaTypeEnum: {
readonly Edc: "EDC";
readonly Ms: "MS";
readonly Pkiaas: "PKIAAS";
};
export type DigitalIdConfigCaTypeEnum = typeof DigitalIdConfigCaTypeEnum[keyof typeof DigitalIdConfigCaTypeEnum];
export declare const DigitalIdConfigTypeEnum: {
readonly PivCardholder: "PIV_CARDHOLDER";
readonly PivCard: "PIV_CARD";
};
export type DigitalIdConfigTypeEnum = typeof DigitalIdConfigTypeEnum[keyof typeof DigitalIdConfigTypeEnum];
/**
* Information that describes a Digital Id Config Cert Template.
* @export
* @interface DigitalIdConfigCertTemplate
*/
export interface DigitalIdConfigCertTemplate {
/**
* The UUID of the Digital Id Config that owns this Digital Id Config Cert Template.
* @type {string}
* @memberof DigitalIdConfigCertTemplate
*/
'digitalIdConfigId'?: string;
/**
* The UUID of the Digital Id Config Cert Template.
* @type {string}
* @memberof DigitalIdConfigCertTemplate
*/
'id'?: string;
/**
* The key type of the Digital Id Config Cert Template.
* @type {string}
* @memberof DigitalIdConfigCertTemplate
*/
'keyType'?: DigitalIdConfigCertTemplateKeyTypeEnum;
/**
* The lifetime (in months) of the certificate created with this Digital Id Config Cert Template.
* @type {number}
* @memberof DigitalIdConfigCertTemplate
*/
'lifetime'?: number;
/**
* The name of the Digital Id Config Cert Template.
* @type {string}
* @memberof DigitalIdConfigCertTemplate
*/
'name'?: string;
/**
* The PIV container of the Digital Id Config Cert Template.
* @type {string}
* @memberof DigitalIdConfigCertTemplate
*/
'pivContainer'?: DigitalIdConfigCertTemplatePivContainerEnum;
/**
* A flag indicating whether to use the CA\'s default certificate lifetime.
* @type {boolean}
* @memberof DigitalIdConfigCertTemplate
*/
'useCaDefaultCertLifetime'?: boolean;
}
export declare const DigitalIdConfigCertTemplateKeyTypeEnum: {
readonly Rsa2048: "RSA_2048";
readonly EcP256: "EC_P_256";
};
export type DigitalIdConfigCertTemplateKeyTypeEnum = typeof DigitalIdConfigCertTemplateKeyTypeEnum[keyof typeof DigitalIdConfigCertTemplateKeyTypeEnum];
export declare const DigitalIdConfigCertTemplatePivContainerEnum: {
readonly PivAuth: "PivAuth";
readonly CardAuth: "CardAuth";
readonly DigSig: "DigSig";
readonly KeyMgmt: "KeyMgmt";
readonly None: "None";
};
export type DigitalIdConfigCertTemplatePivContainerEnum = typeof DigitalIdConfigCertTemplatePivContainerEnum[keyof typeof DigitalIdConfigCertTemplatePivContainerEnum];
/**
* Information that describes a Digital Id Config SubjectAltName.
* @export
* @interface DigitalIdConfigSubjectAltName
*/
export interface DigitalIdConfigSubjectAltName {
/**
* The UUID of the digital id config that owns this subjectAltName.
* @type {string}
* @memberof DigitalIdConfigSubjectAltName
*/
'digitalIdConfigId'?: string;
/**
* The UUID of this Digital Id Config SubjectAltName.
* @type {string}
* @memberof DigitalIdConfigSubjectAltName
*/
'id'?: string;
/**
* The type of subjectAltName.
* @type {string}
* @memberof DigitalIdConfigSubjectAltName
*/
'type'?: DigitalIdConfigSubjectAltNameTypeEnum;
/**
* The value for the subjectAltName.
* @type {string}
* @memberof DigitalIdConfigSubjectAltName
*/
'value'?: string;
}
export declare const DigitalIdConfigSubjectAltNameTypeEnum: {
readonly Email: "EMAIL";
readonly Upn: "UPN";
readonly Ip: "IP";
readonly Dns: "DNS";
readonly Other: "OTHER";
readonly X400: "X400";
readonly Dn: "DN";
readonly Edi: "EDI";
readonly Uri: "URI";
readonly RegisteredId: "REGISTERED_ID";
};
export type DigitalIdConfigSubjectAltNameTypeEnum = typeof DigitalIdConfigSubjectAltNameTypeEnum[keyof typeof DigitalIdConfigSubjectAltNameTypeEnum];
/**
* Information that describes a Digital Id Config Variable.
* @export
* @interface DigitalIdConfigVariable
*/
export interface DigitalIdConfigVariable {
/**
* The UUID of the Digital Id Config that owns this Digital Id Config Variable.
* @type {string}
* @memberof DigitalIdConfigVariable
*/
'digitalIdConfigId'?: string;
/**
* The UUID of the Digital Id Config Variable.
* @type {string}
* @memberof DigitalIdConfigVariable
*/
'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.
* @type {boolean}
* @memberof DigitalIdConfigVariable
*/
'includedInDN'?: boolean;
/**
* The name of the Digital Id Config Variable.
* @type {string}
* @memberof DigitalIdConfigVariable
*/
'name'?: string;
/**
* The type of the Digital Id Config Variable.
* @type {string}
* @memberof DigitalIdConfigVariable
*/
'type'?: DigitalIdConfigVariableTypeEnum;
/**
* The value of the Digital Id Config Variable.
* @type {string}
* @memberof DigitalIdConfigVariable
*/
'value'?: string;
}
export declare const DigitalIdConfigVariableTypeEnum: {
readonly Certificate: "CERTIFICATE";
readonly User: "USER";
readonly Variable: "VARIABLE";
readonly Custom: "CUSTOM";
};
export type DigitalIdConfigVariableTypeEnum = typeof DigitalIdConfigVariableTypeEnum[keyof typeof DigitalIdConfigVariableTypeEnum];
/**
* Parameters to delete enrollments
* @export
* @interface EnrollmentApiPayload
*/
export interface EnrollmentApiPayload {
/**
* The Enrollment Data. Primary key field is mandatory in case of Update and Delete.
* @type {Array<object>}
* @memberof EnrollmentApiPayload
*/
'enrollmentData': Array<object>;
/**
* Name of the Enrollment Design.
* @type {string}
* @memberof EnrollmentApiPayload
*/
'enrollmentDesignName': string;
}
/**
* Details of printer to be used in bulk operation. It includes name and hopper values. For the name field, value is required but for hopper, value is optional. If value of the hopper is not provided, it will be set to 1 by default
* @export
* @interface EnrollmentApiRequestPrinter
*/
export interface EnrollmentApiRequestPrinter {
/**
* Optional message to be displayed on printer\'s LCD screen when the exception slot is selected.
* @type {string}
* @memberof EnrollmentApiRequestPrinter
*/
'exceptionSlotMessage'?: string;
/**
* Hopper to be used (Optional), default value is 1
* @type {number}
* @memberof EnrollmentApiRequestPrinter
*/
'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.
* @type {string}
* @memberof EnrollmentApiRequestPrinter
*/
'name': string;
}
/**
* Ids of the enrollments to be deleted (In Base64 string format)
* @export
* @interface EnrollmentDelete
*/
export interface EnrollmentDelete {
/**
* List of Enrollment Ids to be deleted (Id should be in Base64 string format)
* @type {Array<string>}
* @memberof EnrollmentDelete
*/
'ids': Array<string>;
}
/**
*
* @export
* @interface EnrollmentDesignName
*/
export interface EnrollmentDesignName {
/**
* Id of the Enrollment Design
* @type {string}
* @memberof EnrollmentDesignName
*/
'id'?: string;
/**
* Name of the Enrollment Design
* @type {string}
* @memberof EnrollmentDesignName
*/
'name'?: string;
}
/**
* Parameters to issue mobile flash pass.
* @export
* @interface EnrollmentMultiFlashPassApiRequestV1
*/
export interface EnrollmentMultiFlashPassApiRequestV1 {
/**
*
* @type {string}
* @memberof EnrollmentMultiFlashPassApiRequestV1
*/
'enrollmentDesignName'?: string;
/**
*
* @type {Array<string>}
* @memberof EnrollmentMultiFlashPassApiRequestV1
*/
'primaryKeys'?: Array<string>;
}
/**
* Parameters to issue mobile flash pass.
* @export
* @interface EnrollmentMultiFlashPassApiRequestV2
*/
export interface EnrollmentMultiFlashPassApiRequestV2 {
/**
* List of Enrollment Ids (Id should be in Base64 string format)
* @type {Array<string>}
* @memberof EnrollmentMultiFlashPassApiRequestV2
*/
'ids': Array<string>;
}
/**
* Parameters for printing bulk enrollments.
* @export
* @interface EnrollmentMultiPrintApiRequestV1
*/
export interface EnrollmentMultiPrintApiRequestV1 {
/**
*
* @type {string}
* @memberof EnrollmentMultiPrintApiRequestV1
*/
'credentialDesignName'?: string;
/**
*
* @type {string}
* @memberof EnrollmentMultiPrintApiRequestV1
*/
'enrollmentDesignName'?: string;
/**
*
* @type {Array<string>}
* @memberof EnrollmentMultiPrintApiRequestV1
*/
'primaryKeys'?: Array<string>;
/**
*
* @type {CredentialDesignPrintRequestPrinter}
* @memberof EnrollmentMultiPrintApiRequestV1
*/
'printerDetails'?: CredentialDesignPrintRequestPrinter;
}
/**
* Parameters for printing bulk enrollments.
* @export
* @interface EnrollmentMultiPrintApiRequestV2
*/
export interface EnrollmentMultiPrintApiRequestV2 {
/**
* List of Enrollment Ids (Id should be in Base64 string format)
* @type {Array<string>}
* @memberof EnrollmentMultiPrintApiRequestV2
*/
'ids': Array<string>;
/**
*
* @type {EnrollmentApiRequestPrinter}
* @memberof EnrollmentMultiPrintApiRequestV2
*/
'printer': EnrollmentApiRequestPrinter;
}
/**
* Parameters for printing single enrollment.
* @export
* @interface EnrollmentPrintApiRequestV1
*/
export interface EnrollmentPrintApiRequestV1 {
/**
* The design name of the enrollment. <b>Note:</b> primaryKey parameter is required when this parameter is present.
* @type {string}
* @memberof EnrollmentPrintApiRequestV1
*/
'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.
* @type {string}
* @memberof EnrollmentPrintApiRequestV1
*/
'enrollmentId'?: string;
/**
* The primary key of the enrollment
* @type {string}
* @memberof EnrollmentPrintApiRequestV1
*/
'primaryKey'?: string;
/**
*
* @type {CredentialDesignPrintRequestPrinter}
* @memberof EnrollmentPrintApiRequestV1
*/
'printerDetails': CredentialDesignPrintRequestPrinter;
}
/**
*
* @export
* @interface EnrollmentPrintApiResponse
*/
export interface EnrollmentPrintApiResponse {
/**
* The job id of the requested enrollment print
* @type {string}
* @memberof EnrollmentPrintApiResponse
*/
'printJobId': string;
}
/**
*
* @export
* @interface EnrollmentRequest
*/
export interface EnrollmentRequest {
/**
* List of enrollment fields having field name and field value
* @type {Array<Field>}
* @memberof EnrollmentRequest
*/
'fields': Array<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.
* @type {string}
* @memberof EnrollmentRequest
*/
'id'?: string;
}
/**
*
* @export
* @interface EnrollmentResponse
*/
export interface EnrollmentResponse {
/**
* Error message for the failed enrollment record (For create/update/delete enrollments request)
* @type {string}
* @memberof EnrollmentResponse
*/
'error'?: string;
/**
* List of enrollment fields having field name and field value (For search enrollments request only)
* @type {Array<Field>}
* @memberof EnrollmentResponse
*/
'fields'?: Array<Field>;
/**
* Id of the enrollment (In Base64 string format)
* @type {string}
* @memberof EnrollmentResponse
*/
'id'?: string;
/**
* Status (Success/Failure) of the enrollment record (To check if the requested enrollment is successfully created/updated/deleted or not)
* @type {string}
* @memberof EnrollmentResponse
*/
'status'?: string;
}
/**
*
* @export
* @interface Entitlement
*/
export interface Entitlement {
/**
*
* @type {AdditionalFeature}
* @memberof Entitlement
*/
'additionalFeatures'?: AdditionalFeature;
/**
* The contract mode of a tenant, allowable values = \'PRODUCTION\', \'TRIAL\', example=\'TRIAL\'.
* @type {string}
* @memberof Entitlement
*/
'contractMode'?: EntitlementContractModeEnum;
/**
* The contract number of this entitlement.
* @type {string}
* @memberof Entitlement
*/
'contractNumber'?: string;
/**
* The customer ID.
* @type {string}
* @memberof Entitlement
*/
'customerId'?: string;
/**
* The end date of this entitlement in UTC time.
* @type {string}
* @memberof Entitlement
*/
'endDate': string;
/**
* The entitlement ID.
* @type {string}
* @memberof Entitlement
*/
'entitlementId'?: string;
/**
*
* @type {MobileFlashPass}
* @memberof Entitlement
*/
'flashPass'?: MobileFlashPass;
/**
*
* @type {FleetManagement}
* @memberof Entitlement
*/
'fleetManagement'?: FleetManagement;
/**
* The unique UUID of this entitlement.
* @type {string}
* @memberof Entitlement
*/
'id': string;
/**
*
* @type {Issuance}
* @memberof Entitlement
*/
'issuance'?: Issuance;
/**
*
* @type {PayToPrint}
* @memberof Entitlement
*/
'payToPrint'?: PayToPrint;
/**
*
* @type {PrinterEntitlement}
* @memberof Entitlement
*/
'printer'?: PrinterEntitlement;
/**
* The quantity of this entitlement.
* @type {number}
* @memberof Entitlement
*/
'quantity': number;
/**
* The unused quantity of this entitlement (USERS type only).
* @type {number}
* @memberof Entitlement
*/
'remaining'?: number;
/**
* Whether Smart Card Smart Login is enabled or not.
* @type {boolean}
* @memberof Entitlement
*/
'smartLoginEnabled'?: boolean;
/**
*
* @type {SmsVoice}
* @memberof Entitlement
*/
'smsVoice'?: SmsVoice;
/**
* The start date of this entitlement in UTC time.
* @type {string}
* @memberof Entitlement
*/
'startDate': string;
/**
* The status of this entitlement.
* @type {string}
* @memberof Entitlement
*/
'status': EntitlementStatusEnum;
/**
* The subscription line ID.
* @type {string}
* @memberof Entitlement
*/
'subscriptionLineId'?: string;
/**
* The type of this entitlement.
* @type {string}
* @memberof Entitlement
*/
'type': EntitlementTypeEnum;
/**
* The entitlement bundles that defines the set of features available for authentication accounts.
* @type {Array<ServiceBundle>}
* @memberof Entitlement
*/
'userBundles'?: Array<ServiceBundle>;
/**
* The billing type for user entitlements. Defaults to PRE_PAID if not provided.
* @type {string}
* @memberof Entitlement
*/
'usersBillingType'?: EntitlementUsersBillingTypeEnum;
}
export declare const EntitlementContractModeEnum: {
readonly Production: "PRODUCTION";
readonly Trial: "TRIAL";
readonly Unknown: "UNKNOWN";
};
export type EntitlementContractModeEnum = typeof EntitlementContractModeEnum[keyof typeof EntitlementContractModeEnum];
export declare const EntitlementStatusEnum: {
readonly Active: "ACTIVE";
readonly Inactive: "INACTIVE";
readonly Terminated: "TERMINATED";
};
export type EntitlementStatusEnum = typeof EntitlementStatusEnum[keyof typeof EntitlementStatusEnum];
export declare const EntitlementTypeEnum: {
readonly Users: "USERS";
readonly Transactions: "TRANSACTIONS";
};
export type EntitlementTypeEnum = typeof EntitlementTypeEnum[keyof typeof EntitlementTypeEnum];
export declare const EntitlementUsersBillingTypeEnum: {
readonly PrePaid: "PRE_PAID";
readonly PayPerUse: "PAY_PER_USE";
};
export type EntitlementUsersBillingTypeEnum = typeof EntitlementUsersBillingTypeEnum[keyof typeof EntitlementUsersBillingTypeEnum];
/**
* Parameters passed when setting the entitlements of a tenant. Entitlements are required.
* @export
* @interface EntitlementParms
*/
export interface EntitlementParms {
/**
*
* @type {AdditionalFeature}
* @memberof EntitlementParms
*/
'additionalFeatures'?: AdditionalFeature;
/**
* The contract mode of a tenant (required during creation), allowable values = \'PRODUCTION\', \'TRIAL\'.
* @type {string}
* @memberof EntitlementParms
*/
'contractMode'?: EntitlementParmsContractModeEnum;
/**
* The contract number.
* @type {string}
* @memberof EntitlementParms
*/
'contractNumber'?: string;
/**
* The customer ID.
* @type {string}
* @memberof EntitlementParms
*/
'customerId'?: string;
/**
* The date this entitlement will end. The value must be after the start date. If not specified, this value defaults to the end date of the service provider\'s entitlement.
* @type {string}
* @memberof EntitlementParms
*/
'endDate'?: string;
/**
* The entitlement ID.
* @type {string}
* @memberof EntitlementParms
*/
'entitlementId'?: string;
/**
*
* @type {FlashPassParms}
* @memberof EntitlementParms
*/
'flashPass'?: FlashPassParms;
/**
* Parameters passed when setting the fleet management entitlements of a tenant.
* @type {object}
* @memberof EntitlementParms
*/
'fleetManagement'?: object;
/**
*
* @type {IssuanceParms}
* @memberof EntitlementParms
*/
'issuance'?: IssuanceParms;
/**
* Parameters passed when setting the Printer entitlements of a tenant.
* @type {object}
* @memberof EntitlementParms
*/
'printer'?: object;
/**
* The number of entitlements assigned to the tenant (required during creation). The service provider must have enough available entitlements to meet this request.
* @type {number}
* @memberof EntitlementParms
*/
'quantity'?: number;
/**
* Whether Smart Card Smart Login is enabled or not.
* @type {boolean}
* @memberof EntitlementParms
*/
'smartLoginEnabled'?: boolean;
/**
*
* @type {SmsVoiceParms}
* @memberof EntitlementParms
*/
'smsVoice'?: SmsVoiceParms;
/**
* The date this entitlement will start. If not specified, it defaults to the current date. This value cannot be in the future.
* @type {string}
* @memberof EntitlementParms
*/
'startDate'?: string;
/**
* The status of this entitlement.
* @type {string}
* @memberof EntitlementParms
*/
'status'?: EntitlementParmsStatusEnum;
/**
* The subscription line ID.
* @type {string}
* @memberof EntitlementParms
*/
'subscriptionLineId'?: string;
/**
* The type of entitlement. Currently this value must be USERS. If not specified, this value defaults to USERS.
* @type {string}
* @memberof EntitlementParms
*/
'type'?: EntitlementParmsTypeEnum;
/**
* [DEPRECATED] The type of entitlement (ignored if type is provided). Currently this value must be USERS. If not specified, this value defaults to USERS.
* @type {string}
* @memberof EntitlementParms
* @deprecated
*/
'usageType'?: EntitlementParmsUsageTypeEnum;
/**
* The entitlement bundles that defines the set of features available for authentication accounts.
* @type {Array<ServiceBundle>}
* @memberof EntitlementParms
*/
'userBundles'?: Array<ServiceBundle>;
/**
* The billing type for user entitlements. Defaults to PRE_PAID if not provided.
* @type {string}
* @memberof EntitlementParms
*/
'usersBillingType'?: EntitlementParmsUsersBillingTypeEnum;
}
export declare const EntitlementParmsContractModeEnum: {
readonly Production: "PRODUCTION";
readonly Trial: "TRIAL";
readonly Unknown: "UNKNOWN";
};
export type EntitlementParmsContractModeEnum = typeof EntitlementParmsContractModeEnum[keyof typeof EntitlementParmsContractModeEnum];
export declare const EntitlementParmsStatusEnum: {
readonly Active: "ACTIVE";
readonly Inactive: "INACTIVE";
readonly Terminated: "TERMINATED";
};
export type EntitlementParmsStatusEnum = typeof EntitlementParmsStatusEnum[keyof typeof EntitlementParmsStatusEnum];
export declare const EntitlementParmsTypeEnum: {
readonly Users: "USERS";
readonly Transactions: "TRANSACTIONS";
};
export type EntitlementParmsTypeEnum = typeof EntitlementParmsTypeEnum[keyof typeof EntitlementParmsTypeEnum];
export declare const EntitlementParmsUsageTypeEnum: {
readonly Users: "USERS";
readonly Transactions: "TRANSACTIONS";
};
export type EntitlementParmsUsageTypeEnum = typeof EntitlementParmsUsageTypeEnum[keyof typeof EntitlementParmsUsageTypeEnum];
export declare const EntitlementParmsUsersBillingTypeEnum: {
readonly PrePaid: "PRE_PAID";
readonly PayPerUse: "PAY_PER_USE";
};
export type EntitlementParmsUsersBillingTypeEnum = typeof EntitlementParmsUsersBillingTypeEnum[keyof typeof EntitlementParmsUsersBillingTypeEnum];
/**
* Object containing information about errors reported by services.
* @export
* @interface ErrorInfo
*/
export interface ErrorInfo {
/**
* Error Codes specific to cause of failure.
* @type {string}
* @memberof ErrorInfo
*/
'errorCode'?: string;
/**
* Additional Error Message describing the error.
* @type {string}
* @memberof ErrorInfo
*/
'errorMessage'?: string;
/**
* Optional additional error information.
* @type {Array<object>}
* @memberof ErrorInfo
*/
'parameters'?: Array<object>;
}
/**
* A FIDOToken defines the information returned about a FIDO Token.
* @export
* @interface FIDOToken
*/
export interface