the C# library for the Entrust Identity as a Service Administration API

Entrust Identity as a Service Administration API Client

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
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
FaceApi	CreateFaceAuthenticatorUsingPOST	POST /api/web/v2/users/{userid}/face	Create a Face Biometric for a user
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
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
MagicLinkApi	CreateMagicLinkUsingPUT	PUT /api/web/v1/users/{userid}/magiclink	Create and get the Magic Link for a user
MagicLinkApi	DeleteMagicLinkUsingDELETE	DELETE /api/web/v1/users/{userid}/magiclink	Delete the Magic Link for a given user
MagicLinkApi	GetMagicLinkUsingGET	GET /api/web/v1/users/{userid}/magiclink	Get the Magic Link 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
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
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
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	CreateAcrUsingPOST	POST /api/web/v1/acrs	Create an acr
ResourceRulesApi	CreateAuthenticationFlowUsingPOST	POST /api/web/v2/authenticationflows	Create an authentication flow
ResourceRulesApi	CreateResourceRuleUsingPOST	POST /api/web/v2/resourcerules	Create a resource rule
ResourceRulesApi	GetAcrUsingGET	GET /api/web/v1/acrs/{id}	Get an acr
ResourceRulesApi	GetAcrsUsingGET	GET /api/web/v1/acrs	Get all acrs
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	ListDomainBasedIdentityProvidersUsingGET	GET /api/web/v1/domainbasedidentityproviders	Lists domain-based identity providers
ResourceRulesApi	RemoveAcrUsingDELETE	DELETE /api/web/v1/acrs/{id}	Delete an acr
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	FetchAndroidAssociationFileUsingPOST	POST /api/web/v1/settings/fido/configuration/android	Fetch Android association file for a FIDO relying party
SettingsApi	FetchAppleAssociationFileUsingPOST	POST /api/web/v1/settings/fido/configuration/ios	Fetch Apple association file for a FIDO relying party
SettingsApi	GetEntrustSTAuthenticatorSettingsUsingGET	GET /api/web/v1/settings/entrustst	Get Entrust ST Authenticator settings
SettingsApi	GetFIDOSettingsUsingGET	GET /api/web/v1/settings/fido	Get FIDO 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	UpdateFIDOSettingsUsingPUT	PUT /api/web/v1/settings/fido	Update FIDO 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	CreateUserUsingPOST	POST /api/web/v3/users	Create a user
UsersApi	CreateUsersUsingPOST	POST /api/web/v3/users/multiple	Create multiple users
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

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

Documentation for Authorization

Authentication schemes defined for the API:

AdminAPIAuthentication

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