Skip to main content

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

Entrust Identity as a Service Administration API Client

Documentation for API Endpoints

ClassMethodHTTP requestDescription
AccountInfoApiGetAccoutInfoUsingGETGET /api/web/v1/accountinfoGet account info
AccountInfoApiGetServiceIPAddressesUsingGETGET /api/web/v1/serviceipaddressesGet service IP addresses
AccountInfoApiUpdateAccountInfoUsingPUTPUT /api/web/v1/accountinfoUpdate account info
AdminAuthApiAuthenticateAdminApiUsingPOSTPOST /api/web/v1/adminapi/authenticateAuthenticate to an Admin API application.
ApplicationsApiCreateAdminApiApplicationUsingPOSTPOST /api/web/v1/applications/adminapiCreate Admin API application
ApplicationsApiCreateAuthApiApplicationUsingPOSTPOST /api/web/v1/applications/authapiCreate Auth API application
ApplicationsApiGetAdminApiApplicationUsingGETGET /api/web/v1/applications/adminapi/{id}Get Admin API application
ApplicationsApiGetAuthApiApplicationUsingGETGET /api/web/v1/applications/authapi/{id}Get Auth API application
ApplicationsApiListAdminApiApplicationsUsingGETGET /api/web/v1/applications/adminapiList Admin API application
ApplicationsApiListApplicationInfoUsingGETGET /api/web/v1/applicationinfoList application information
ApplicationsApiListApplicationTemplatesUsingGETGET /api/web/v1/applications/templatesList application templates
ApplicationsApiListAuthApiApplicationsUsingGETGET /api/web/v1/applications/authapiList Auth API applications
ApplicationsApiRemoveAdminApiApplicationUsingDELETEDELETE /api/web/v1/applications/adminapi/{id}Remove Admin API application
ApplicationsApiRemoveAuthApiApplicationUsingDELETEDELETE /api/web/v1/applications/authapi/{id}Remove Auth API application
ApplicationsApiUpdateAdminApiApplicationUsingPUTPUT /api/web/v1/applications/adminapi/{id}Update Admin API application
ApplicationsApiUpdateAdminApiSharedSecretUsingPUTPUT /api/web/v1/applications/adminapi/regenerate/{id}Regenerate Admin API application shared secret
ApplicationsApiUpdateAuthApiApplicationUsingPUTPUT /api/web/v1/applications/authapi/{id}Update Auth API application
DevicesApiGetActiveSyncDevicesUsingPOSTPOST /api/web/v1/users/{userid}/activesyncdevicesGet ActiveSync devices from Office 365.
DevicesApiGetCachedActiveSyncDevicesUsingGETGET /api/web/v1/users/{userid}/activesyncdevicesGet ActiveSync devices.
DevicesApiRemoveActiveSyncDeviceUsingDELETEDELETE /api/web/v1/users/{userid}/activesyncdevices/{deviceid}Remove ActiveSync devices.
DevicesApiUpdateActiveSyncDevicesUsingPUTPUT /api/web/v1/users/{userid}/activesyncdevicesUpdate ActiveSync devices.
DirectoriesApiGetDirectoryAttrMappingUsingGETGET /api/web/v1/attributemappings/{id}Get a directory attribute mapping
DirectoriesApiGetDirectoryAttrMappingsUsingGETGET /api/web/v1/directories/{id}/attributemappingsList directory attribute mappings
DirectoriesApiGetDirectorySyncStatusInfoUsingGETGET /api/web/v1/directorysyncinfo/{id}Get directory synchronization status
DirectoriesApiGetDirectorySyncUsingGETGET /api/web/v1/directorysyncs/{id}Get directory synchronization settings
DirectoriesApiGetDirectorySyncsUsingGETGET /api/web/v1/directories/{id}/directorysyncsList directory sync settings
DirectoriesApiGetDirectoryUsingGETGET /api/web/v1/directories/{id}Get a directory
DirectoriesApiGetGroupFilterUsingGETGET /api/web/v1/groupfilters/{id}Get directory group filter
DirectoriesApiGetGroupFiltersUsingGETGET /api/web/v1/directories/{id}/groupfiltersList directory group filters
DirectoriesApiGetSearchBaseUsingGETGET /api/web/v1/searchbases/{searchbaseid}Get a searchbase
DirectoriesApiGetSearchBasesUsingGETGET /api/web/v1/directories/{id}/searchbasesList directory searchbases
DirectoriesApiListDirectoriesUsingGETGET /api/web/v1/directoriesList directories
EntitlementsApiGetSubscriberAccountActiveEntitlementsUsingGETGET /api/web/v1/entitlements/infoGet entitlement info
FIDOTokensApiCompleteCreateFIDOTokenUsingPOSTPOST /api/web/v1/fidotokens/complete/{id}Complete FIDO token registration
FIDOTokensApiDeleteFIDOTokenUsingDELETEDELETE /api/web/v1/fidotokens/{fidoid}Delete a FIDO token
FIDOTokensApiGetFIDOTokenUsingGETGET /api/web/v1/fidotokens/{fidoid}Get a FIDO token
FIDOTokensApiStartCreateFIDOTokenUsingGETGET /api/web/v1/fidotokens/challenge/{id}Start FIDO token registration
FIDOTokensApiUpdateFIDOTokenUsingPUTPUT /api/web/v1/fidotokens/{fidoid}Update a FIDO token
FaceApiCreateFaceUsingPOSTPOST /api/web/v1/users/{userid}/faceCreate a Face Biometric for a user
FaceApiDeleteFaceUsingDELETEDELETE /api/web/v1/face/{faceid}Delete the Face Biometric by a given ID
FaceApiGetFacesUsingGETGET /api/web/v1/users/{userid}/facesGet the Face Biometrics for a given user
FaceApiGetUserFaceSettingsUsingGETGET /api/web/v1/users/{userid}/settings/faceGets a user Face Biometric settings
FaceApiUpdateFaceUsingPUTPUT /api/web/v1/users/{userid}/faceUpdate the Face Biometric for a given user
GridsApiAssignGridByIdUsingPUTPUT /api/web/v1/grids/{gridserialnumber}/assignAssign a grid to a user by serial number
GridsApiAssignGridBySerialNumberUsingPUTPUT /api/web/v1/users/{id}/grids/assignAssign a user to a grid
GridsApiAssignedGridsPageUsingPOSTPOST /api/web/v2/gridspaged/assignedLists a page of assigned grids
GridsApiChangeGridStateUsingPUTPUT /api/web/v2/grids/{gridid}/changestateChange state of grid
GridsApiCreateGridUsingPOSTPOST /api/web/v2/users/{userid}/gridsCreate a grid
GridsApiCreateUnassignedGridsUsingPOSTPOST /api/web/v1/gridsCreate unassigned grids
GridsApiDeleteGridUsingDELETEDELETE /api/web/v2/grids/{gridid}Delete a grid
GridsApiDeliverAssignedGridByEmailUsingPOSTPOST /api/web/v1/grids/{gridid}/emailEmail a grid card to the card owner
GridsApiGetGridBySerialNumberUsingGETGET /api/web/v2/grids/sernum/{sernum}Get a grid by serial number
GridsApiGetGridPropertiesUsingGETGET /api/web/v1/grids/propertiesGet grid properties
GridsApiGetGridUsingGETGET /api/web/v2/grids/{gridid}Get a grid
GridsApiGetSingleGridExportUsingGETGET /api/web/v1/grids/{gridid}/exportExport a grid to PDF format
GridsApiModifyUnassignedGridUsingPUTPUT /api/web/v2/grids/{gridid}Modify unassigned grid
GridsApiUnassignGridUsingPUTPUT /api/web/v1/grids/{id}/unassignUnassign a grid
GridsApiUnassignedGridsPageUsingPOSTPOST /api/web/v1/gridspaged/unassignedLists a page of unassigned grids
GroupsApiCreateGroupUsingPOSTPOST /api/web/v1/groupsCreate a group
GroupsApiDeleteGroupUsingDELETEDELETE /api/web/v1/groups/{id}Remove a group
GroupsApiGroupByExternalIdUsingPOSTPOST /api/web/v1/groups/externalidGet a group by externalId
GroupsApiGroupUsingGETGET /api/web/v1/groups/{id}Get a group
GroupsApiGroupsPagedUsingPOSTPOST /api/web/v1/groupspagedList a page of groups
GroupsApiGroupsUsingGETGET /api/web/v1/groupsList groups
GroupsApiModifyUserAuthorizationGroupAssociationsUsingPUTPUT /api/web/v1/userauthorizationgroup/{userid}/groupsModify user group membership
GroupsApiUpdateGroupUsingPUTPUT /api/web/v1/groups/{id}Update a group
IDProofingApiIdProofingCompleteSelfieUsingPUTPUT /api/web/v1/idproofing/{requestId}/completeselfieUpload a selfie image and performs a face match with the ID Document photo image.
IDProofingApiIdProofingCompleteUsingPUTPUT /api/web/v1/idproofing/{requestId}/completeSend liveness check transaction data and performs a face match with the ID Document photo image.
IDProofingApiIdProofingImageUsingPUTPUT /api/web/v1/idproofing/{requestId}/image/{side}Upload an ID Document image (binary)
IDProofingApiIdProofingInitUsingPOSTPOST /api/web/v1/idproofing/initInitiates an ID Proofing request, checks the risk of a device and obtains license details
IDProofingApiIdProofingRequestUsingGETGET /api/web/v1/idproofing/{requestId}Gets an ID Proofing request
IDProofingApiIdProofingRequestsPagedUsingPOSTPOST /api/web/v1/idproofingLists a page of ID Proofing requests
IdentityProvidersApiCreateOidcIdentityProviderUsingPOSTPOST /api/web/v1/identityproviders/oidcCreate an OIDC identity provider
IdentityProvidersApiDeleteOidcIdentityProviderUsingDELETEDELETE /api/web/v1/identityproviders/oidc/{id}Delete an OIDC identity provider
IdentityProvidersApiFetchOidcConfigurationUsingPOSTPOST /api/web/v1/identityproviders/oidc/configurationFetch OIDC Configuration for an OIDC identity provider
IdentityProvidersApiGetOidcIdentityProviderUsingGETGET /api/web/v1/identityproviders/oidc/{id}Get an OIDC identity provider
IdentityProvidersApiListOidcIdentityProvidersUsingGETGET /api/web/v1/identityproviders/oidcLists OIDC identity providers
IdentityProvidersApiUpdateOidcIdentityProviderUsingPUTPUT /api/web/v1/identityproviders/oidc/{id}Update an OIDC identity provider
KBAApiAddKnowledgeBasedAuthenticatorUsingPOSTPOST /api/web/v1/users/{userid}/userquestionsAdd a knowledge-based authenticator
KBAApiDeleteUserKbaChallengesUsingDELETEDELETE /api/web/v1/users/{userid}/kbachallengesDelete retained knowledge-based authenticator challenges
KBAApiDeleteUserKbaQuestionUsingDELETEDELETE /api/web/v1/users/{userid}/userquestions/{id}Delete a question from the knowledge-based authenticator
KBAApiDeleteUserKbaUsingDELETEDELETE /api/web/v1/users/{userid}/userquestionsDelete the knowledge-based authenticator
KBAApiGetKbaQuestionsUsingGETGET /api/web/v1/users/userquestions/{locale}Get a list of Knowledge-based questions that a user can answer
KBAApiGetUserKbaUsingGETGET /api/web/v1/users/{userid}/userquestionsGet the knowledge-based authenticator
KBAApiUpdateKnowledgeBasedAuthenticatorUsingPUTPUT /api/web/v1/users/{userid}/userquestionsModify a knowledge-based authenticator
MachineAuthApiCreateMachineAuthenticatorUsingPOSTPOST /api/web/v1/users/{userid}/machinesCreate a Machine Authenticator
MachineAuthApiDeleteMachineAuthenticatorUsingDELETEDELETE /api/web/v1/users/{userid}/machines/{id}Delete a Machine Authenticator
MachineAuthApiListMachineAuthenticatorsUsingGETGET /api/web/v1/users/{userid}/machinesList machine authenticators for a user
OAuthRolesApiListOAuthRolesUsingGETGET /api/web/v1/oauthrolesList oauth roles
OAuthRolesApiModifyUserOAuthRoleAssociationsUsingPUTPUT /api/web/v1/useroauthrole/{userid}/oauthrolesModify user oauth role membership
OTPsApiContactVerificationAuthenticateUsingPOSTPOST /api/web/v1/contact/verification/authenticateAuthenticate Contact Verification Challenge
OTPsApiContactVerificationChallengeUsingPOSTPOST /api/web/v1/contact/verification/challengeGet Contact Verification Challenge
OTPsApiCreateOTPUsingPOSTPOST /api/web/v1/otpsCreates and returns an OTP
OrganizationsApiCreateOrganizationUsingPOSTPOST /api/web/v1/organizationsCreate an organization
OrganizationsApiCreateUserOrganizationAssociationUsingPOSTPOST /api/web/v1/organizations/{orgid}/users/{userid}Add user to organization
OrganizationsApiDeleteUserOrganizationAssociationUsingDELETEDELETE /api/web/v1/organizations/{orgid}/users/{userid}Remove user from organization
OrganizationsApiGetOrganizationUsingGETGET /api/web/v1/organizations/{id}Get an organization
OrganizationsApiOrganizationsPagedUsingPOSTPOST /api/web/v1/organizationspagedList a page of organizations
OrganizationsApiRemoveOrganizationUsingDELETEDELETE /api/web/v1/organizations/{id}Delete an organization
OrganizationsApiUpdateOrganizationUsingPUTPUT /api/web/v1/organizations/{id}Update an organization
PasswordsApiDeleteUserPasswordUsingDELETEDELETE /api/web/v1/users/{userid}/passwordsDelete a user password
PasswordsApiGetUserPasswordSettingsUsingGETGET /api/web/v1/users/{userid}/settings/passwordGets a user password settings
PasswordsApiGetUserPasswordUsingGETGET /api/web/v1/users/{userid}/passwordsGets a user password
PasswordsApiSendPasswordExpiryNotificationUsingPUTPUT /api/web/v1/users/{userid}/password/notifyUpdate and send a password expiry notification
PasswordsApiSetUserPasswordUsingPUTPUT /api/web/v1/users/{userid}/passwordsSet a user password
PasswordsApiValidateUserPasswordUsingPOSTPOST /api/web/v1/users/{userid}/password/validateValidate user password
ReportsApiAuditEventPageUsingPOSTPOST /api/web/v2/reports/auditeventspagedLists a page of audit events
ReportsApiSiemAuditEventPageUsingPOSTPOST /api/web/v2/reports/auditeventspaged/siemLists a page of audit events (SIEM)
ResourceRulesApiCreateAuthenticationFlowUsingPOSTPOST /api/web/v2/authenticationflowsCreate an authentication flow
ResourceRulesApiCreateResourceRuleUsingPOSTPOST /api/web/v2/resourcerulesCreate a resource rule
ResourceRulesApiGetAuthenticationFlowUsingGETGET /api/web/v2/authenticationflows/{id}Get an authentication flow
ResourceRulesApiGetAuthenticationFlowsUsingGETGET /api/web/v2/authenticationflowsGet all authentication flows
ResourceRulesApiGetResourceRuleUsingGETGET /api/web/v2/resourcerules/{id}Get a resource rule
ResourceRulesApiGetResourceRulesForResourceUsingGETGET /api/web/v2/resourcerules/resource/{id}Get all resource rules for a resource
ResourceRulesApiGetResourceRulesUsingGETGET /api/web/v2/resourcerulesGet all resource rules
ResourceRulesApiGetTransactionRulesUsingGETGET /api/web/v1/transactionrulesList all transaction rules
ResourceRulesApiRemoveAuthenticationFlowUsingDELETEDELETE /api/web/v2/authenticationflows/{id}Delete an authentication flow
ResourceRulesApiRemoveResourceRuleUsingDELETEDELETE /api/web/v2/resourcerules/{id}Delete a resource rule
ResourceRulesApiUpdateAuthenticationFlowUsingPUTPUT /api/web/v2/authenticationflows/{id}Update an authentication flow
ResourceRulesApiUpdateResourceRuleUsingPUTPUT /api/web/v2/resourcerules/{id}Update a resource rule
RolesApiDeleteUserSiteRoleAssociationUsingDELETEDELETE /api/web/v1/users/{userid}/roles/{roleid}Delete a site role from a user
RolesApiGetSiteRoleUsingGETGET /api/web/v1/roles/{id}Get a role
RolesApiGetUserRolesUsingGETGET /api/web/v1/users/{userid}/rolesList all site roles assigned to user
RolesApiGetUserSiteRoleAssociationUsingGETGET /api/web/v1/users/{userid}/roles/{roleid}Get site role assigned to user
RolesApiListSiteRolesUsingGETGET /api/web/v1/rolesList roles
RolesApiModifyUserSiteRoleAssociationUsingPUTPUT /api/web/v1/users/{userid}/roles/{roleid}Set user role
SettingsApiGetEntrustSTAuthenticatorSettingsUsingGETGET /api/web/v1/settings/entruststGet Entrust ST Authenticator settings
SettingsApiGetGeneralSettingsUsingGETGET /api/web/v1/settings/generalGet general settings
SettingsApiGetGoogleAuthenticatorSettingsUsingGETGET /api/web/v1/settings/googleGet Google Authenticator settings
SettingsApiGetOTPAuthenticatorSettingsUsingGETGET /api/web/v3/settings/otpGet OTP authenticator settings
SettingsApiGetPasswordResetSettingsUsingGETGET /api/web/v1/settings/passwordresetGet Password Reset settings
SettingsApiUpdateEntrustSTAuthenticatorSettingsUsingPUTPUT /api/web/v1/settings/entruststUpdate Entrust ST Authenticator settings
SettingsApiUpdateGeneralSettingsUsingPUTPUT /api/web/v1/settings/generalUpdate general settings
SettingsApiUpdateGoogleAuthenticatorSettingsUsingPUTPUT /api/web/v1/settings/googleUpdate Google Authenticator settings
SettingsApiUpdateOTPAuthenticatorSettingsUsingPUTPUT /api/web/v3/settings/otpUpdate OTP authenticator settings
SettingsApiUpdatePasswordResetSettingsUsingPUTPUT /api/web/v1/settings/passwordresetUpdate Password Reset settings
SmartCredentialsApiActivateSmartCredentialUsingPUTPUT /api/web/v1/smartcredentials/{id}/activateActivate a smart credential
SmartCredentialsApiChangeSmartCredentialStateUsingPUTPUT /api/web/v1/smartcredentials/{id}/changestateChange smart credential state
SmartCredentialsApiCompleteSignSmartCredentialUsingPUTPUT /api/web/v1/smartcredentials/{id}/completesignSmart credential complete signature
SmartCredentialsApiCreateSmartCredentialUsingPOSTPOST /api/web/v1/smartcredentialsCreate a smart credential
SmartCredentialsApiDeleteSmartCredentialUsingDELETEDELETE /api/web/v1/smartcredentials/{id}Delete a smart credential
SmartCredentialsApiExportCertificateUsingGETGET /api/web/v1/smartcredentials/certificate/{id}/export/{format}Export a certificate from a smart credential
SmartCredentialsApiGetSCDefnByNameUsingPOSTPOST /api/web/v1/scdefns/nameGet a smart credential definition by name
SmartCredentialsApiGetSCDefnUsingGETGET /api/web/v1/scdefns/{id}Get a smart credential definition
SmartCredentialsApiGetSmartCredentialBySerialNumberUsingGETGET /api/web/v1/smartcredentials/serialnumber/{sernum}Get a smart credential by serial number
SmartCredentialsApiGetSmartCredentialUsingGETGET /api/web/v1/smartcredentials/{id}Get a smart credential
SmartCredentialsApiHoldCertificateUsingPUTPUT /api/web/v1/smartcredentials/certificate/{id}/holdHold a certificate from a smart credential
SmartCredentialsApiListAllowedSCDefnsUsingGETGET /api/web/v1/scdefns/users/{userId}List allowed smart credential definitions
SmartCredentialsApiListSCDefnsUsingGETGET /api/web/v1/scdefnsList smart credential definitions
SmartCredentialsApiRevokeCertificateUsingPUTPUT /api/web/v1/smartcredentials/certificate/{id}/revokeRevoke a certificate from a smart credential
SmartCredentialsApiStartSignSmartCredentialUsingPUTPUT /api/web/v1/smartcredentials/{id}/startsignSmart credential start signature
SmartCredentialsApiUnassignSmartCredentialUsingPUTPUT /api/web/v1/smartcredentials/{id}/unassignUnassign a smart credential
SmartCredentialsApiUnblockSmartCredentialUsingPUTPUT /api/web/v1/smartcredentials/{id}/unblockUnblock a smart credential
SmartCredentialsApiUnholdCertificateUsingPUTPUT /api/web/v1/smartcredentials/certificate/{id}/unholdUnhold a certificate from a smart credential
SmartCredentialsApiUpdateSmartCredentialUsingPUTPUT /api/web/v1/smartcredentials/{id}Update a smart credential
TempAccessCodesApiCreateTempAccessCodeUsingPOSTPOST /api/web/v1/users/{userid}/tempaccesscodeCreate a temporary access code
TempAccessCodesApiDeleteTempAccessCodeUsingDELETEDELETE /api/web/v1/users/{userid}/tempaccesscodeDelete a temporary access code
TempAccessCodesApiGetTempAccessCodeUsingGETGET /api/web/v1/users/{userid}/tempaccesscodeGet a temporary access code
TenantsApiCreateTenantAsyncUsingPOSTPOST /api/web/v5/async/tenantsCreate a tenant asynchronously
TenantsApiCreateTenantUsingPOSTPOST /api/web/v4/tenantsCreate a tenant
TenantsApiGetCreateTenantAsyncResultUsingGETGET /api/web/v4/async/tenants/{id}/createresultGet the result of an asynchronous tenant creation operation
TenantsApiGetCreateTenantAsyncStatusUsingGETGET /api/web/v4/async/tenants/{id}/createstatusGet the status of an asynchronous tenant creation operation
TenantsApiGetEntitlementUsageInfoUsingPOSTPOST /api/web/v4/tenants/entitlements/usageLists a page of entitlement usage information
TenantsApiGetSpIdentityProviderUsingGETGET /api/web/v1/tenants/{id}/spidentityproviderGet Tenant Identity Provider and Service Provider OIDC Application for Tenant Management.
TenantsApiGetTenantEntitlementUsingGETGET /api/web/v4/tenants/{tenantid}/entitlements/{type}Get an entitlement
TenantsApiGetTenantEntitlementsUsingGETGET /api/web/v4/tenants/{tenantid}/entitlementsGet entitlements for tenant
TenantsApiGetTenantUsingGETGET /api/web/v4/tenants/{id}Get a tenant
TenantsApiGetTenantsPageUsingPOSTPOST /api/web/v4/tenantspagedLists a page of tenants
TenantsApiLockTenantUsingPUTPUT /api/web/v4/tenants/{id}/lockLock a tenant
TenantsApiRemoveTenantUsingDELETEDELETE /api/web/v4/tenants/{id}Delete a tenant
TenantsApiSetSpIdentityProviderUsingPUTPUT /api/web/v1/tenants/{id}/spidentityproviderSet Tenant Identity Provider and Service Provider OIDC Application for Tenant Management
TenantsApiSetTenantEntitlementUsingPUTPUT /api/web/v4/tenants/{tenantid}/entitlementsSet an entitlement
TenantsApiUnlockTenantUsingPUTPUT /api/web/v4/tenants/{id}/unlockUnlock a tenant
TokensApiAssignTokenByIdUsingPUTPUT /api/web/v1/tokens/{tokenid}/assignAssign token to user
TokensApiAssignTokenBySerialNumberUsingPUTPUT /api/web/v1/users/{id}/tokens/assignAssign user to token
TokensApiAssignedTokenPageUsingPOSTPOST /api/web/v1/tokenspaged/assignedLists a page of assigned tokens
TokensApiChangeTokenStateUsingPUTPUT /api/web/v1/tokens/{tokenid}/changestateChange token state
TokensApiCompleteActivateTokenUsingPUTPUT /api/web/v1/tokens/{tokenid}/activationComplete token activation
TokensApiCreateTokenUsingPOSTPOST /api/web/v1/users/{userid}/tokens/{type}Create a token
TokensApiDeleteTokenUsingDELETEDELETE /api/web/v1/tokens/{tokenid}Delete a token
TokensApiGetTokenBySerialNumberUsingGETGET /api/web/v1/tokens/sernum/{sernum}Get a token by serial number
TokensApiGetTokenUsingGETGET /api/web/v1/tokens/{tokenid}Get a token
TokensApiModifyAssignedTokenUsingPUTPUT /api/web/v1/tokens/{tokenid}/assignedModify an assigned token
TokensApiModifyTokenUsingPUTPUT /api/web/v1/tokens/{tokenid}Modify a token
TokensApiResetTokenUsingPUTPUT /api/web/v1/tokens/{tokenid}/resetReset a token
TokensApiStartActivateTokenUsingPOSTPOST /api/web/v1/tokens/{tokenid}/activationStart token activation
TokensApiUnassignTokenUsingPUTPUT /api/web/v1/tokens/{tokenid}/unassignUnassign a token
TokensApiUnassignedTokenPageUsingPOSTPOST /api/web/v1/tokenspaged/unassignedLists a page of unassigned hardware tokens
TokensApiUnlockTokenUsingPUTPUT /api/web/v1/tokens/{tokenid}/unlockUnlock a token
UserAttributesApiCreateUserAttributeUsingPOSTPOST /api/web/v1/userattributesCreate a user attribute
UserAttributesApiDeleteUserAttributeUsingDELETEDELETE /api/web/v1/userattributes/{id}Delete a user attribute
UserAttributesApiGetUserAttributeUsingGETGET /api/web/v1/userattributes/{id}Get a user attribute
UserAttributesApiListUserAttributesUsingGETGET /api/web/v1/userattributesList user attributes
UserAttributesApiModifyUserAttributeUsingPUTPUT /api/web/v1/userattributes/{id}Modify a user attribute
UserRBASettingsApiDeleteUserLocationsUsingDELETEDELETE /api/web/v1/users/{userid}/userlocationsDelete user location history
UserRBASettingsApiGetUserRbaSettingsUsingGETGET /api/web/v1/users/{userid}/userrbasettingsGet user risk-based authentication settings
UserRBASettingsApiIpLocationFromIpAddressUsingPOSTPOST /api/web/v1/iplocationsCreate IP location
UserRBASettingsApiListUserExpectedLocationsUsingGETGET /api/web/v1/users/{userid}/expectedlocationsList expected locations for a user
UserRBASettingsApiListUserLocationsUsingGETGET /api/web/v1/users/{userid}/userlocationsGet user location history
UserRBASettingsApiSetUserExpectedLocationsUsingPUTPUT /api/web/v1/users/{userid}/expectedlocationsSet expected locations for a user
UserRBASettingsApiUpdateUserRbaSettingsUsingPUTPUT /api/web/v1/users/{userid}/userrbasettingsUpdate user risk-based authentication settings
UsersApiCreateMagicLinkUsingPUTPUT /api/web/v1/users/{userid}/magiclinkCreate and get the Magic Link for a user
UsersApiCreateUserUsingPOSTPOST /api/web/v3/usersCreate a user
UsersApiCreateUsersUsingPOSTPOST /api/web/v3/users/multipleCreate multiple users
UsersApiDeleteMagicLinkUsingDELETEDELETE /api/web/v1/users/{userid}/magiclinkDelete the Magic Link for a given user
UsersApiDeleteUserUsingDELETEDELETE /api/web/v3/users/{id}Delete a user
UsersApiDeleteUsersUsingDELETEDELETE /api/web/v3/users/multipleDelete multiple users
UsersApiModifyUserAOrganizationAssociationsUsingPUTPUT /api/web/v1/users/{userid}/organizationsModify user organization membership
UsersApiSyncUserUsingPOSTPOST /api/web/v1/syncusers/syncSynchronize a new user or an existing user
UsersApiUnlockUserUsingPUTPUT /api/web/v1/users/{id}/unlockUnlock user
UsersApiUnsyncUserUsingPOSTPOST /api/web/v1/syncusers/unsyncUnsynchronize an existing user
UsersApiUpdateUserStateUsingPUTPUT /api/web/v1/users/{id}/stateUpdate user state
UsersApiUpdateUserUsingPUTPUT /api/web/v3/users/{id}Update a user
UsersApiUpdateUsersUsingPUTPUT /api/web/v3/users/multipleUpdate multiple users
UsersApiUserByExternalIdUsingPOSTPOST /api/web/v3/users/externalidGet a user by externalId
UsersApiUserByUseridUsingPOSTPOST /api/web/v3/users/useridGet a user by userid or user alias
UsersApiUserUsingGETGET /api/web/v3/users/{id}Get a user by UUID
UsersApiUsersPagedUsingPOSTPOST /api/web/v4/userspagedLists a page of users

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

AdminAPIAuthentication

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