intellitrust-admin-Administration

Entrust Identity as a Service Administration API

Documentation for API Endpoints

Class	Method	HTTP request	Description
AccountInfoApi	getAccoutInfoUsingGET	GET /api/web/v1/accountinfo	Get account info
AccountInfoApi	getServiceIPAddressesUsingGET	GET /api/web/v1/serviceipaddresses	Get service IP addresses
AccountInfoApi	updateAccountInfoUsingPUT	PUT /api/web/v1/accountinfo	Update account info
AdminAuthApi	authenticateAdminApiUsingPOST	POST /api/web/v1/adminapi/authenticate	Authenticate to an Admin API application.
ApplicationsApi	createAdminApiApplicationUsingPOST	POST /api/web/v1/applications/adminapi	Create Admin API application
ApplicationsApi	createAuthApiApplicationUsingPOST	POST /api/web/v1/applications/authapi	Create Auth API application
ApplicationsApi	getAdminApiApplicationUsingGET	GET /api/web/v1/applications/adminapi/{id}	Get Admin API application
ApplicationsApi	getAuthApiApplicationUsingGET	GET /api/web/v1/applications/authapi/{id}	Get Auth API application
ApplicationsApi	listAdminApiApplicationsUsingGET	GET /api/web/v1/applications/adminapi	List Admin API application
ApplicationsApi	listApplicationInfoUsingGET	GET /api/web/v1/applicationinfo	List application information
ApplicationsApi	listApplicationTemplatesUsingGET	GET /api/web/v1/applications/templates	List application templates
ApplicationsApi	listAuthApiApplicationsUsingGET	GET /api/web/v1/applications/authapi	List Auth API applications
ApplicationsApi	removeAdminApiApplicationUsingDELETE	DELETE /api/web/v1/applications/adminapi/{id}	Remove Admin API application
ApplicationsApi	removeAuthApiApplicationUsingDELETE	DELETE /api/web/v1/applications/authapi/{id}	Remove Auth API application
ApplicationsApi	updateAdminApiApplicationUsingPUT	PUT /api/web/v1/applications/adminapi/{id}	Update Admin API application
ApplicationsApi	updateAdminApiSharedSecretUsingPUT	PUT /api/web/v1/applications/adminapi/regenerate/{id}	Regenerate Admin API application shared secret
ApplicationsApi	updateAuthApiApplicationUsingPUT	PUT /api/web/v1/applications/authapi/{id}	Update Auth API application
DevicesApi	getActiveSyncDevicesUsingPOST	POST /api/web/v1/users/{userid}/activesyncdevices	Get ActiveSync devices from Office 365.
DevicesApi	getCachedActiveSyncDevicesUsingGET	GET /api/web/v1/users/{userid}/activesyncdevices	Get ActiveSync devices.
DevicesApi	removeActiveSyncDeviceUsingDELETE	DELETE /api/web/v1/users/{userid}/activesyncdevices/{deviceid}	Remove ActiveSync devices.
DevicesApi	updateActiveSyncDevicesUsingPUT	PUT /api/web/v1/users/{userid}/activesyncdevices	Update ActiveSync devices.
DirectoriesApi	getDirectoryAttrMappingUsingGET	GET /api/web/v1/attributemappings/{id}	Get a directory attribute mapping
DirectoriesApi	getDirectoryAttrMappingsUsingGET	GET /api/web/v1/directories/{id}/attributemappings	List directory attribute mappings
DirectoriesApi	getDirectorySyncStatusInfoUsingGET	GET /api/web/v1/directorysyncinfo/{id}	Get directory synchronization status
DirectoriesApi	getDirectorySyncUsingGET	GET /api/web/v1/directorysyncs/{id}	Get directory synchronization settings
DirectoriesApi	getDirectorySyncsUsingGET	GET /api/web/v1/directories/{id}/directorysyncs	List directory sync settings
DirectoriesApi	getDirectoryUsingGET	GET /api/web/v1/directories/{id}	Get a directory
DirectoriesApi	getGroupFilterUsingGET	GET /api/web/v1/groupfilters/{id}	Get directory group filter
DirectoriesApi	getGroupFiltersUsingGET	GET /api/web/v1/directories/{id}/groupfilters	List directory group filters
DirectoriesApi	getSearchBaseUsingGET	GET /api/web/v1/searchbases/{searchbaseid}	Get a searchbase
DirectoriesApi	getSearchBasesUsingGET	GET /api/web/v1/directories/{id}/searchbases	List directory searchbases
DirectoriesApi	listDirectoriesUsingGET	GET /api/web/v1/directories	List directories
EntitlementsApi	getSubscriberAccountActiveEntitlementsUsingGET	GET /api/web/v1/entitlements/info	Get entitlement info
FaceApi	createFaceUsingPOST	POST /api/web/v1/users/{userid}/face	Create a Face Biometric for a user
FaceApi	deleteFaceUsingDELETE	DELETE /api/web/v1/face/{faceid}	Delete a Face Biometric
FaceApi	getFacesUsingGET	GET /api/web/v1/users/{userid}/faces	Get the Face Biometrics for a given user
FaceApi	getUserFaceSettingsUsingGET	GET /api/web/v1/users/{userid}/settings/face	Gets a users Face Biometric settings
FaceApi	sendFaceActivationEmailUsingPUT	PUT /api/web/v1/face/{faceid}/activation	Send an activation email for the Face Biometric
FaceApi	updateFaceUsingPUT	PUT /api/web/v1/users/{userid}/face	Update the Face Biometric for a given user
FidoTokensApi	completeCreateFIDOTokenUsingPOST	POST /api/web/v1/fidotokens/complete/{id}	Complete FIDO token registration
FidoTokensApi	deleteFIDOTokenUsingDELETE	DELETE /api/web/v1/fidotokens/{fidoid}	Delete a FIDO token
FidoTokensApi	getFIDOTokenUsingGET	GET /api/web/v1/fidotokens/{fidoid}	Get a FIDO token
FidoTokensApi	startCreateFIDOTokenUsingGET	GET /api/web/v1/fidotokens/challenge/{id}	Start FIDO token registration
FidoTokensApi	updateFIDOTokenUsingPUT	PUT /api/web/v1/fidotokens/{fidoid}	Update a FIDO token
GridsApi	assignGridByIdUsingPUT	PUT /api/web/v1/grids/{gridserialnumber}/assign	Assign a grid to a user by serial number
GridsApi	assignGridBySerialNumberUsingPUT	PUT /api/web/v1/users/{id}/grids/assign	Assign a user to a grid
GridsApi	assignedGridsPageUsingPOST	POST /api/web/v2/gridspaged/assigned	Lists a page of assigned grids
GridsApi	changeGridStateUsingPUT	PUT /api/web/v2/grids/{gridid}/changestate	Change state of grid
GridsApi	createGridUsingPOST	POST /api/web/v2/users/{userid}/grids	Create a grid
GridsApi	createUnassignedGridsUsingPOST	POST /api/web/v1/grids	Create unassigned grids
GridsApi	deleteGridUsingDELETE	DELETE /api/web/v2/grids/{gridid}	Delete a grid
GridsApi	deliverAssignedGridByEmailUsingPOST	POST /api/web/v1/grids/{gridid}/email	Email a grid card to the card owner
GridsApi	getGridBySerialNumberUsingGET	GET /api/web/v2/grids/sernum/{sernum}	Get a grid by serial number
GridsApi	getGridPropertiesUsingGET	GET /api/web/v1/grids/properties	Get grid properties
GridsApi	getGridUsingGET	GET /api/web/v2/grids/{gridid}	Get a grid
GridsApi	getSingleGridExportUsingGET	GET /api/web/v1/grids/{gridid}/export	Export a grid to PDF format
GridsApi	modifyUnassignedGridUsingPUT	PUT /api/web/v2/grids/{gridid}	Modify unassigned grid
GridsApi	unassignGridUsingPUT	PUT /api/web/v1/grids/{id}/unassign	Unassign a grid
GridsApi	unassignedGridsPageUsingPOST	POST /api/web/v1/gridspaged/unassigned	Lists a page of unassigned grids
GroupsApi	createGroupUsingPOST	POST /api/web/v1/groups	Create a group
GroupsApi	deleteGroupUsingDELETE	DELETE /api/web/v1/groups/{id}	Remove a group
GroupsApi	groupByExternalIdUsingPOST	POST /api/web/v1/groups/externalid	Get a group by externalId
GroupsApi	groupUsingGET	GET /api/web/v1/groups/{id}	Get a group
GroupsApi	groupsPagedUsingPOST	POST /api/web/v1/groupspaged	List a page of groups
GroupsApi	groupsUsingGET	GET /api/web/v1/groups	List groups
GroupsApi	modifyUserAuthorizationGroupAssociationsUsingPUT	PUT /api/web/v1/userauthorizationgroup/{userid}/groups	Modify user group membership
GroupsApi	updateGroupUsingPUT	PUT /api/web/v1/groups/{id}	Update a group
IdentityProvidersApi	createOidcIdentityProviderUsingPOST	POST /api/web/v1/identityproviders/oidc	Create an OIDC identity provider
IdentityProvidersApi	createSamlIdentityProviderUsingPOST	POST /api/web/v1/identityproviders/saml	Create a SAML identity provider
IdentityProvidersApi	deleteOidcIdentityProviderUsingDELETE	DELETE /api/web/v1/identityproviders/oidc/{id}	Delete an OIDC identity provider
IdentityProvidersApi	deleteSamlIdentityProviderUsingDELETE	DELETE /api/web/v1/identityproviders/saml/{id}	Delete a SAML identity provider
IdentityProvidersApi	fetchOidcConfigurationUsingPOST	POST /api/web/v1/identityproviders/oidc/configuration	Fetch OIDC Configuration for an OIDC identity provider
IdentityProvidersApi	getOidcIdentityProviderUsingGET	GET /api/web/v1/identityproviders/oidc/{id}	Get an OIDC identity provider
IdentityProvidersApi	getSamlIdentityProviderUsingGET	GET /api/web/v1/identityproviders/saml/{id}	Get a SAML identity provider
IdentityProvidersApi	listIdentityProvidersUsingGET	GET /api/web/v1/identityproviders	Lists identity providers
IdentityProvidersApi	listOidcIdentityProvidersUsingGET	GET /api/web/v1/identityproviders/oidc	Lists OIDC identity providers
IdentityProvidersApi	listSamlIdentityProvidersUsingGET	GET /api/web/v1/identityproviders/saml	Lists SAML identity providers
IdentityProvidersApi	updateOidcIdentityProviderUsingPUT	PUT /api/web/v1/identityproviders/oidc/{id}	Update an OIDC identity provider
IdentityProvidersApi	updateSamlIdentityProviderUsingPUT	PUT /api/web/v1/identityproviders/saml/{id}	Update a SAML identity provider
KbaApi	addKnowledgeBasedAuthenticatorUsingPOST	POST /api/web/v1/users/{userid}/userquestions	Add a knowledge-based authenticator
KbaApi	deleteUserKbaChallengesUsingDELETE	DELETE /api/web/v1/users/{userid}/kbachallenges	Delete retained knowledge-based authenticator challenges
KbaApi	deleteUserKbaQuestionUsingDELETE	DELETE /api/web/v1/users/{userid}/userquestions/{id}	Delete a question from the knowledge-based authenticator
KbaApi	deleteUserKbaUsingDELETE	DELETE /api/web/v1/users/{userid}/userquestions	Delete the knowledge-based authenticator
KbaApi	getKbaQuestionsUsingGET	GET /api/web/v1/users/userquestions/{locale}	Get a list of Knowledge-based questions that a user can answer
KbaApi	getUserKbaUsingGET	GET /api/web/v1/users/{userid}/userquestions	Get the knowledge-based authenticator
KbaApi	updateKnowledgeBasedAuthenticatorUsingPUT	PUT /api/web/v1/users/{userid}/userquestions	Modify a knowledge-based authenticator
MachineAuthApi	createMachineAuthenticatorUsingPOST	POST /api/web/v1/users/{userid}/machines	Create a Machine Authenticator
MachineAuthApi	deleteMachineAuthenticatorUsingDELETE	DELETE /api/web/v1/users/{userid}/machines/{id}	Delete a Machine Authenticator
MachineAuthApi	listMachineAuthenticatorsUsingGET	GET /api/web/v1/users/{userid}/machines	List machine authenticators for a user
OAuthRolesApi	listOAuthRolesUsingGET	GET /api/web/v1/oauthroles	List oauth roles
OAuthRolesApi	modifyUserOAuthRoleAssociationsUsingPUT	PUT /api/web/v1/useroauthrole/{userid}/oauthroles	Modify user oauth role membership
OrganizationsApi	createOrganizationUsingPOST	POST /api/web/v1/organizations	Create an organization
OrganizationsApi	createUserOrganizationAssociationUsingPOST	POST /api/web/v1/organizations/{orgid}/users/{userid}	Add user to organization
OrganizationsApi	deleteUserOrganizationAssociationUsingDELETE	DELETE /api/web/v1/organizations/{orgid}/users/{userid}	Remove user from organization
OrganizationsApi	getOrganizationUsingGET	GET /api/web/v1/organizations/{id}	Get an organization
OrganizationsApi	organizationsPagedUsingPOST	POST /api/web/v1/organizationspaged	List a page of organizations
OrganizationsApi	removeOrganizationUsingDELETE	DELETE /api/web/v1/organizations/{id}	Delete an organization
OrganizationsApi	updateOrganizationUsingPUT	PUT /api/web/v1/organizations/{id}	Update an organization
OtpsApi	contactVerificationAuthenticateUsingPOST	POST /api/web/v1/contact/verification/authenticate	Authenticate Contact Verification Challenge
OtpsApi	contactVerificationChallengeUsingPOST	POST /api/web/v1/contact/verification/challenge	Get Contact Verification Challenge
OtpsApi	createOTPUsingPOST	POST /api/web/v1/otps	Creates and returns an OTP
PasswordsApi	deleteUserPasswordUsingDELETE	DELETE /api/web/v1/users/{userid}/passwords	Delete a user password
PasswordsApi	getUserPasswordSettingsUsingGET	GET /api/web/v1/users/{userid}/settings/password	Gets a user password settings
PasswordsApi	getUserPasswordUsingGET	GET /api/web/v1/users/{userid}/passwords	Gets a user password
PasswordsApi	sendPasswordExpiryNotificationUsingPUT	PUT /api/web/v1/users/{userid}/password/notify	Update and send a password expiry notification
PasswordsApi	setUserPasswordUsingPUT	PUT /api/web/v1/users/{userid}/passwords	Set a user password
PasswordsApi	validateUserPasswordUsingPOST	POST /api/web/v1/users/{userid}/password/validate	Validate user password
ReportsApi	auditEventPageUsingPOST	POST /api/web/v2/reports/auditeventspaged	Lists a page of audit events
ReportsApi	siemAuditEventPageUsingPOST	POST /api/web/v2/reports/auditeventspaged/siem	Lists a page of audit events (SIEM)
ResourceRulesApi	createAuthenticationFlowUsingPOST	POST /api/web/v2/authenticationflows	Create an authentication flow
ResourceRulesApi	createResourceRuleUsingPOST	POST /api/web/v2/resourcerules	Create a resource rule
ResourceRulesApi	getAuthenticationFlowUsingGET	GET /api/web/v2/authenticationflows/{id}	Get an authentication flow
ResourceRulesApi	getAuthenticationFlowsUsingGET	GET /api/web/v2/authenticationflows	Get all authentication flows
ResourceRulesApi	getResourceRuleUsingGET	GET /api/web/v2/resourcerules/{id}	Get a resource rule
ResourceRulesApi	getResourceRulesForResourceUsingGET	GET /api/web/v2/resourcerules/resource/{id}	Get all resource rules for a resource
ResourceRulesApi	getResourceRulesUsingGET	GET /api/web/v2/resourcerules	Get all resource rules
ResourceRulesApi	getTransactionRulesUsingGET	GET /api/web/v1/transactionrules	List all transaction rules
ResourceRulesApi	removeAuthenticationFlowUsingDELETE	DELETE /api/web/v2/authenticationflows/{id}	Delete an authentication flow
ResourceRulesApi	removeResourceRuleUsingDELETE	DELETE /api/web/v2/resourcerules/{id}	Delete a resource rule
ResourceRulesApi	updateAuthenticationFlowUsingPUT	PUT /api/web/v2/authenticationflows/{id}	Update an authentication flow
ResourceRulesApi	updateResourceRuleUsingPUT	PUT /api/web/v2/resourcerules/{id}	Update a resource rule
RolesApi	deleteUserSiteRoleAssociationUsingDELETE	DELETE /api/web/v1/users/{userid}/roles/{roleid}	Delete a site role from a user
RolesApi	getSiteRoleUsingGET	GET /api/web/v1/roles/{id}	Get a role
RolesApi	getUserRolesUsingGET	GET /api/web/v1/users/{userid}/roles	List all site roles assigned to user
RolesApi	getUserSiteRoleAssociationUsingGET	GET /api/web/v1/users/{userid}/roles/{roleid}	Get site role assigned to user
RolesApi	listSiteRolesUsingGET	GET /api/web/v1/roles	List roles
RolesApi	modifyUserSiteRoleAssociationUsingPUT	PUT /api/web/v1/users/{userid}/roles/{roleid}	Set user role
SettingsApi	getEntrustSTAuthenticatorSettingsUsingGET	GET /api/web/v1/settings/entrustst	Get Entrust ST Authenticator settings
SettingsApi	getFaceAccountSettingsUsingGET	GET /api/web/v1/settings/face/account	Get Onfido account settings
SettingsApi	getGeneralSettingsUsingGET	GET /api/web/v1/settings/general	Get general settings
SettingsApi	getGoogleAuthenticatorSettingsUsingGET	GET /api/web/v1/settings/google	Get Google Authenticator settings
SettingsApi	getOTPAuthenticatorSettingsUsingGET	GET /api/web/v3/settings/otp	Get OTP authenticator settings
SettingsApi	getPasswordResetSettingsUsingGET	GET /api/web/v1/settings/passwordreset	Get Password Reset settings
SettingsApi	setFaceAccountSettingsUsingPUT	PUT /api/web/v1/settings/face/account	Set Onfido account settings
SettingsApi	updateEntrustSTAuthenticatorSettingsUsingPUT	PUT /api/web/v1/settings/entrustst	Update Entrust ST Authenticator settings
SettingsApi	updateGeneralSettingsUsingPUT	PUT /api/web/v1/settings/general	Update general settings
SettingsApi	updateGoogleAuthenticatorSettingsUsingPUT	PUT /api/web/v1/settings/google	Update Google Authenticator settings
SettingsApi	updateOTPAuthenticatorSettingsUsingPUT	PUT /api/web/v3/settings/otp	Update OTP authenticator settings
SettingsApi	updatePasswordResetSettingsUsingPUT	PUT /api/web/v1/settings/passwordreset	Update Password Reset settings
SmartCredentialsApi	activateSmartCredentialUsingPUT	PUT /api/web/v1/smartcredentials/{id}/activate	Activate a smart credential
SmartCredentialsApi	changeSmartCredentialStateUsingPUT	PUT /api/web/v1/smartcredentials/{id}/changestate	Change smart credential state
SmartCredentialsApi	completeSignSmartCredentialUsingPUT	PUT /api/web/v1/smartcredentials/{id}/completesign	Smart credential complete signature
SmartCredentialsApi	createSmartCredentialUsingPOST	POST /api/web/v1/smartcredentials	Create a smart credential
SmartCredentialsApi	deleteSmartCredentialUsingDELETE	DELETE /api/web/v1/smartcredentials/{id}	Delete a smart credential
SmartCredentialsApi	exportCertificateUsingGET	GET /api/web/v1/smartcredentials/certificate/{id}/export/{format}	Export a certificate from a smart credential
SmartCredentialsApi	getSCDefnByNameUsingPOST	POST /api/web/v1/scdefns/name	Get a smart credential definition by name
SmartCredentialsApi	getSCDefnUsingGET	GET /api/web/v1/scdefns/{id}	Get a smart credential definition
SmartCredentialsApi	getSmartCredentialBySerialNumberUsingGET	GET /api/web/v1/smartcredentials/serialnumber/{sernum}	Get a smart credential by serial number
SmartCredentialsApi	getSmartCredentialUsingGET	GET /api/web/v1/smartcredentials/{id}	Get a smart credential
SmartCredentialsApi	holdCertificateUsingPUT	PUT /api/web/v1/smartcredentials/certificate/{id}/hold	Hold a certificate from a smart credential
SmartCredentialsApi	listAllowedSCDefnsUsingGET	GET /api/web/v1/scdefns/users/{userId}	List allowed smart credential definitions
SmartCredentialsApi	listSCDefnsUsingGET	GET /api/web/v1/scdefns	List smart credential definitions
SmartCredentialsApi	revokeCertificateUsingPUT	PUT /api/web/v1/smartcredentials/certificate/{id}/revoke	Revoke a certificate from a smart credential
SmartCredentialsApi	startSignSmartCredentialUsingPUT	PUT /api/web/v1/smartcredentials/{id}/startsign	Smart credential start signature
SmartCredentialsApi	unassignSmartCredentialUsingPUT	PUT /api/web/v1/smartcredentials/{id}/unassign	Unassign a smart credential
SmartCredentialsApi	unblockSmartCredentialUsingPUT	PUT /api/web/v1/smartcredentials/{id}/unblock	Unblock a smart credential
SmartCredentialsApi	unholdCertificateUsingPUT	PUT /api/web/v1/smartcredentials/certificate/{id}/unhold	Unhold a certificate from a smart credential
SmartCredentialsApi	updateSmartCredentialUsingPUT	PUT /api/web/v1/smartcredentials/{id}	Update a smart credential
TempAccessCodesApi	createTempAccessCodeUsingPOST	POST /api/web/v1/users/{userid}/tempaccesscode	Create a temporary access code
TempAccessCodesApi	deleteTempAccessCodeUsingDELETE	DELETE /api/web/v1/users/{userid}/tempaccesscode	Delete a temporary access code
TempAccessCodesApi	getTempAccessCodeUsingGET	GET /api/web/v1/users/{userid}/tempaccesscode	Get a temporary access code
TenantsApi	createTenantAsyncUsingPOST	POST /api/web/v5/async/tenants	Create a tenant asynchronously
TenantsApi	createTenantUsingPOST	POST /api/web/v4/tenants	Create a tenant
TenantsApi	deleteTenantEntitlementUsingDELETE	DELETE /api/web/v4/tenants/{tenantid}/entitlements/{type}	Delete an entitlement
TenantsApi	getCreateTenantAsyncResultUsingGET	GET /api/web/v4/async/tenants/{id}/createresult	Get the result of an asynchronous tenant creation operation
TenantsApi	getCreateTenantAsyncStatusUsingGET	GET /api/web/v4/async/tenants/{id}/createstatus	Get the status of an asynchronous tenant creation operation
TenantsApi	getEntitlementUsageInfoUsingPOST	POST /api/web/v4/tenants/entitlements/usage	Lists a page of entitlement usage information
TenantsApi	getSpIdentityProviderUsingGET	GET /api/web/v1/tenants/{id}/spidentityprovider	Get Tenant Identity Provider and Service Provider OIDC Application for Tenant Management.
TenantsApi	getTenantEntitlementUsingGET	GET /api/web/v4/tenants/{tenantid}/entitlements/{type}	Get an entitlement
TenantsApi	getTenantEntitlementsUsingGET	GET /api/web/v4/tenants/{tenantid}/entitlements	Get entitlements for tenant
TenantsApi	getTenantUsingGET	GET /api/web/v4/tenants/{id}	Get a tenant
TenantsApi	getTenantsPageUsingPOST	POST /api/web/v4/tenantspaged	Lists a page of tenants
TenantsApi	lockTenantUsingPUT	PUT /api/web/v4/tenants/{id}/lock	Lock a tenant
TenantsApi	removeTenantUsingDELETE	DELETE /api/web/v4/tenants/{id}	Delete a tenant
TenantsApi	setSpIdentityProviderUsingPUT	PUT /api/web/v1/tenants/{id}/spidentityprovider	Set Tenant Identity Provider and Service Provider OIDC Application for Tenant Management
TenantsApi	setTenantEntitlementUsingPUT	PUT /api/web/v4/tenants/{tenantid}/entitlements	Set an entitlement
TenantsApi	unlockTenantUsingPUT	PUT /api/web/v4/tenants/{id}/unlock	Unlock a tenant
TokensApi	assignTokenByIdUsingPUT	PUT /api/web/v1/tokens/{tokenid}/assign	Assign token to user
TokensApi	assignTokenBySerialNumberUsingPUT	PUT /api/web/v1/users/{id}/tokens/assign	Assign user to token
TokensApi	assignedTokenPageUsingPOST	POST /api/web/v1/tokenspaged/assigned	Lists a page of assigned tokens
TokensApi	changeTokenStateUsingPUT	PUT /api/web/v1/tokens/{tokenid}/changestate	Change token state
TokensApi	completeActivateTokenUsingPUT	PUT /api/web/v1/tokens/{tokenid}/activation	Complete token activation
TokensApi	createTokenUsingPOST	POST /api/web/v1/users/{userid}/tokens/{type}	Create a token
TokensApi	deleteTokenUsingDELETE	DELETE /api/web/v1/tokens/{tokenid}	Delete a token
TokensApi	getTokenBySerialNumberUsingGET	GET /api/web/v1/tokens/sernum/{sernum}	Get a token by serial number
TokensApi	getTokenUsingGET	GET /api/web/v1/tokens/{tokenid}	Get a token
TokensApi	modifyAssignedTokenUsingPUT	PUT /api/web/v1/tokens/{tokenid}/assigned	Modify an assigned token
TokensApi	modifyTokenUsingPUT	PUT /api/web/v1/tokens/{tokenid}	Modify a token
TokensApi	resetTokenUsingPUT	PUT /api/web/v1/tokens/{tokenid}/reset	Reset a token
TokensApi	startActivateTokenUsingPOST	POST /api/web/v1/tokens/{tokenid}/activation	Start token activation
TokensApi	unassignTokenUsingPUT	PUT /api/web/v1/tokens/{tokenid}/unassign	Unassign a token
TokensApi	unassignedTokenPageUsingPOST	POST /api/web/v1/tokenspaged/unassigned	Lists a page of unassigned hardware tokens
TokensApi	unlockTokenUsingPUT	PUT /api/web/v1/tokens/{tokenid}/unlock	Unlock a token
UserAttributesApi	createUserAttributeUsingPOST	POST /api/web/v1/userattributes	Create a user attribute
UserAttributesApi	deleteUserAttributeUsingDELETE	DELETE /api/web/v1/userattributes/{id}	Delete a user attribute
UserAttributesApi	getUserAttributeUsingGET	GET /api/web/v1/userattributes/{id}	Get a user attribute
UserAttributesApi	listUserAttributesUsingGET	GET /api/web/v1/userattributes	List user attributes
UserAttributesApi	modifyUserAttributeUsingPUT	PUT /api/web/v1/userattributes/{id}	Modify a user attribute
UserRbaSettingsApi	deleteUserLocationsUsingDELETE	DELETE /api/web/v1/users/{userid}/userlocations	Delete user location history
UserRbaSettingsApi	getUserRbaSettingsUsingGET	GET /api/web/v1/users/{userid}/userrbasettings	Get user risk-based authentication settings
UserRbaSettingsApi	ipLocationFromIpAddressUsingPOST	POST /api/web/v1/iplocations	Create IP location
UserRbaSettingsApi	listUserExpectedLocationsUsingGET	GET /api/web/v1/users/{userid}/expectedlocations	List expected locations for a user
UserRbaSettingsApi	listUserLocationsUsingGET	GET /api/web/v1/users/{userid}/userlocations	Get user location history
UserRbaSettingsApi	setUserExpectedLocationsUsingPUT	PUT /api/web/v1/users/{userid}/expectedlocations	Set expected locations for a user
UserRbaSettingsApi	updateUserRbaSettingsUsingPUT	PUT /api/web/v1/users/{userid}/userrbasettings	Update user risk-based authentication settings
UsersApi	createMagicLinkUsingPUT	PUT /api/web/v1/users/{userid}/magiclink	Create and get the Magic Link for a user
UsersApi	createUserUsingPOST	POST /api/web/v3/users	Create a user
UsersApi	createUsersUsingPOST	POST /api/web/v3/users/multiple	Create multiple users
UsersApi	deleteMagicLinkUsingDELETE	DELETE /api/web/v1/users/{userid}/magiclink	Delete the Magic Link for a given user
UsersApi	deleteUserUsingDELETE	DELETE /api/web/v3/users/{id}	Delete a user
UsersApi	deleteUsersUsingDELETE	DELETE /api/web/v3/users/multiple	Delete multiple users
UsersApi	modifyUserAOrganizationAssociationsUsingPUT	PUT /api/web/v1/users/{userid}/organizations	Modify user organization membership
UsersApi	syncUserUsingPOST	POST /api/web/v1/syncusers/sync	Synchronize a new user or an existing user
UsersApi	unlockUserUsingPUT	PUT /api/web/v1/users/{id}/unlock	Unlock user
UsersApi	unsyncUserUsingPOST	POST /api/web/v1/syncusers/unsync	Unsynchronize an existing user
UsersApi	updateUserStateUsingPUT	PUT /api/web/v1/users/{id}/state	Update user state
UsersApi	updateUserUsingPUT	PUT /api/web/v3/users/{id}	Update a user
UsersApi	updateUsersUsingPUT	PUT /api/web/v3/users/multiple	Update multiple users
UsersApi	userByExternalIdUsingPOST	POST /api/web/v3/users/externalid	Get a user by externalId
UsersApi	userByUseridUsingPOST	POST /api/web/v3/users/userid	Get a user by userid or user alias
UsersApi	userUsingGET	GET /api/web/v3/users/{id}	Get a user by UUID
UsersApi	usersPagedUsingPOST	POST /api/web/v4/userspaged	Lists a page of users
WebhooksApi	createWebhookUsingPOST	POST /api/web/v1/webhooks	Register a webhook
WebhooksApi	deleteWebhookUsingDELETE	DELETE /api/web/v1/webhooks/{id}	Delete a webhook
WebhooksApi	getWebhooksUsingGET	GET /api/web/v1/webhooks	List webhooks
WebhooksApi	readWebhookUsingGET	GET /api/web/v1/webhooks/{id}	Get a webhook by id
WebhooksApi	testWebhookUsingPOST	POST /api/web/v1/webhooks/test/{id}	Test a webhook
WebhooksApi	updateWebhookUsingPUT	PUT /api/web/v1/webhooks/{id}	Update a webhook

Documentation for Models

• AccountAuditEvent
• AccountEntitlement
• AccountInfo
• AccountInfoParms
• ActivateCompleteParms
• ActivateParms
• ActivateResult
• ActivateSmartCredentialParms
• ActivateSmartCredentialResult
• AdditionalFeature
• AdminApiApplication
• AdminApiApplicationParms
• AdminApiAuthentication
• AdminApiAuthenticationResult
• ApplicationInfo
• ApplicationResourceRule
• ApplicationTemplate
• AssignParms
• AssignedTokenParms
• AuditDetails
• AuditEventPage
• AuthApiApplication
• AuthApiApplicationParms
• AuthenticationFlow
• AuthenticationFlowParms
• ChangeStateParms
• CorsOrigin
• CreateTenantAsyncStatus
• CreateTenantParms
• CreateTenantResult
• CreateUserResult
• CreateUsersParms
• DateTimeContext
• DeleteAuthenticationFlowResult
• DeleteUserParms
• DeleteUserResult
• DeleteUsersParms
• DeviceCertificateContext
• DigitalId
• DigitalIdCert
• DigitalIdConfig
• DigitalIdConfigCertTemplate
• DigitalIdConfigSubjectAltName
• DigitalIdConfigVariable
• Directory
• DirectoryAttributeMapping
• DirectoryConnection
• DirectorySync
• DirectorySyncStatusInfo
• Duration
• EmailParms
• Entitlement
• EntitlementParms
• EntityAttribute
• EntrustSTAuthenticatorSettings
• Error
• ErrorInfo
• ExpectedLocation
• ExportCertificate
• FIDORegisterChallenge
• FIDORegisterResponse
• FIDOToken
• FIDOTokenParms
• FaceAccountSettings
• FaceAuthenticator
• FaceCreateParms
• FaceUpdateParms
• FlashPassParms
• FleetManagement
• GeneralSettings
• GoogleAuthenticatorSettings
• Grid
• GridAssignParms
• GridChangeStateParms
• GridCreateParms
• GridExport
• GridParms
• GridProperties
• GridsPage
• Group
• GroupFilter
• GroupId
• GroupParms
• GroupsPage
• IdentityProvider
• IpContext
• IpLocation
• Issuance
• IssuanceParms
• KbaContext
• KnowledgeBasedAuthenticator
• LocationContext
• LocationHistoryContext
• LoginFlow
• MachineAuthenticator
• MachineAuthenticatorRegistration
• MachineAuthenticatorRegistrationResult
• MachineContext
• MagicLinkCreateParms
• MagicLinkResponse
• MobileFlashPass
• ModifiedEntityAttribute
• OAuthRole
• OAuthRoleParms
• OTP
• OTPAuthenticatorSettings
• OTPCreateParms
• OTPDeliveryMethod
• OTPVerificationAuthenticateResponse
• OTPVerificationAuthenticateValue
• OTPVerificationChallengeResponse
• OTPVerificationChallengeValue
• OidcConfigurationParms
• OidcConfigurationResponse
• OidcIdentityProvider
• OidcIdentityProviderAttributeMapping
• OidcIdentityProviderParms
• OidcIdentityProviderUserAuthMatchMapping
• OidcIdentityProviderUserVerMatchMapping
• OrderByAttribute
• Organization
• OrganizationPage
• OrganizationParms
• Paging
• PasswordResetSettings
• PayToPrint
• Permission
• PrinterEntitlement
• ProtectedOfflineSettings
• ResetParms
• ResourceRule
• ResourceRuleNameId
• ResourceRuleParms
• Role
• RoleUser
• SCDefn
• SCDefnGetParms
• SCDefnVariable
• SCVariableValue
• SamlIdentityProvider
• SamlIdentityProviderAttributeMapping
• SamlIdentityProviderParms
• SamlIdentityProviderUserAuthMatchMapping
• SamlIdentityProviderUserVerMatchMapping
• SdpParms
• SdpResponse
• SearchBase
• SearchByAttribute
• SearchParms
• ServiceBundle
• ServiceIPAddresses
• SmartCredential
• SmartCredentialChangeStateParms
• SmartCredentialCompleteSignParms
• SmartCredentialCompleteSignResponse
• SmartCredentialParms
• SmartCredentialStartSignParms
• SmartCredentialStartSignResponse
• SmartCredentialUnblockParms
• SmartCredentialUnblockResponse
• SmsVoice
• SmsVoiceParms
• SpIdentityProvider
• SpIdentityProviderParms
• SyncUser
• SyncUserParms
• TempAccessCode
• TemporalUnit
• Tenant
• TenantParms
• TenantsPage
• Token
• TokenCreateParms
• TokenParms
• TokensPage
• TransactionContext
• TransactionDetail
• TransactionRuleDescription
• TransactionRuleRisk
• TravelVelocityContext
• UnlockParms
• UnlockResult
• UnsyncUserParms
• UpdateUserParms
• UpdateUserResult
• UpdateUsersParms
• UsageInfo
• UsageInfoPage
• User
• UserAlias
• UserAlternateEmails
• UserAttribute
• UserAttributeParms
• UserAttributeValue
• UserAuthenticatorLockoutStatus
• UserChangeStateParms
• UserEntitlement
• UserExpectedLocations
• UserExtraAttribute
• UserFaceSettings
• UserGetParms
• UserLocation
• UserMachineAuthenticator
• UserOrganizationParms
• UserParms
• UserPassword
• UserPasswordParms
• UserPasswordSettings
• UserPasswordStrength
• UserPasswordValidationParms
• UserPasswordValidationResponse
• UserQuestion
• UserRbaSettings
• UsersPage
• Webhook
• WebhookEvent
• WebhookParms
• ZoneId
• ZoneOffset
• ZoneOffsetTransition
• ZoneOffsetTransitionRule
• ZoneRules

Documentation for Authorization

Authentication schemes defined for the API:

AdminAPIAuthentication

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

support@entrust.com