Skip to content

Latest commit

 

History

History
866 lines (690 loc) · 54.9 KB

File metadata and controls

866 lines (690 loc) · 54.9 KB

API index

Every operation the LoginRadius API exposes — 392 across 57 services — with the method name this SDK gives it and the endpoint it calls.

This is the SDK's API reference. No -javadoc.jar is attached to releases, so there is nothing on javadoc.io to consult; mvn javadoc:javadoc builds the Javadoc locally if you want signatures and parameter docs. Javadoc would not carry the HTTP verb and path in any case — that fact lives in the OpenAPI spec, not in the code — so this index is generated from the spec and cannot drift.

Call any of these as client.<service>.<method>(...), e.g. client.login.checkUserNameAvailability(...). The README's service list gives the field name for each service.

5 operation(s). Parameters, request bodies and return types are on the Account Custom Object page.

Method HTTP request Description
createCustomObject POST /identity/v2/manage/account/{uid}/customobject Create Custom Object
deleteCustomObjectByUidAndRecordId DELETE /identity/v2/manage/account/{uid}/customobject/{objectrecordid} Delete Custom Object
getCustomObjectByUid GET /identity/v2/manage/account/{uid}/customobject List Custom Objects
getCustomObjectByUidAndRecordId GET /identity/v2/manage/account/{uid}/customobject/{objectrecordid} Retrieve Custom Object
updateCustomObjectByUidAndRecordId PUT /identity/v2/manage/account/{uid}/customobject/{objectrecordid} Update Custom Object

10 operation(s). Parameters, request bodies and return types are on the Account Security page.

Method HTTP request Description
mfaGenerateBackupCodesByUid GET /identity/v2/manage/account/2fa/backupcode Generate Backup Codes
mfaResetBackupCodesByUid GET /identity/v2/manage/account/2fa/backupcode/reset Reset Backup Codes
mFAResetSMSAuthByUid DELETE /identity/v2/manage/account/2fa/sms Reset SMS Authenticator
mFAResetTotpByUid DELETE /identity/v2/manage/account/2fa/totp Reset TOTP
resetDuoAuthByUid DELETE /identity/v2/manage/account/2fa/duo Reset Duo
resetEmailAuthenticatorByUid DELETE /identity/v2/manage/account/2fa/email Reset Email OTP
resetMfaPasskeyByUid DELETE /identity/v2/manage/account/2fa/passkey Reset MFA Passkey
resetMfaPushByUid DELETE /identity/v2/manage/account/2fa/push Reset MFA Push Notification
validateSecondFactorTokenForPassword POST /identity/v2/manage/account/{uid}/reauth/password Verify Password MFA Token
validateSecondFactorTokenForPin POST /identity/v2/manage/account/{uid}/reauth/pin Verify PIN MFA Token

8 operation(s). Parameters, request bodies and return types are on the Account Session page.

Method HTTP request Description
getAccessToken GET /api/v2/access_token Retrieve Access Token
getActiveSession GET /api/v2/access_token/activesession Retrieve active session
nativeInvalidateAccessToken GET /api/v2/access_token/invalidate Invalidate Access Token
nativeRefreshAccessToken GET /api/v2/access_token/refresh Refresh Access Token
refreshAccessToken GET /identity/v2/manage/account/access_token/refresh Refresh Access Token
revokeAllRefreshToken DELETE /identity/v2/manage/account/{uid}/access_token/refresh/revoke Revoke refresh tokens
revokeRefreshToken GET /identity/v2/manage/account/access_token/refresh/revoke Revoke Refresh Token
validateAccessToken GET /api/v2/access_token/validate Validate Access Token

20 operation(s). Parameters, request bodies and return types are on the Accounts page.

Method HTTP request Description
createUser POST /identity/v2/manage/account Create Account
deleteAccountByEmail DELETE /identity/v2/manage/account Delete Account by Email
deleteAccountByUID DELETE /identity/v2/manage/account/{uid} Delete Account by UID
deleteEmailFromAccount DELETE /identity/v2/manage/account/{uid}/email Delete Email
deletePasskeyByUid DELETE /identity/v2/manage/account/passkey/{passkeyId} Delete Passkey
generateSott GET /identity/v2/manage/account/sott Generate SOTT
getAccountIdentity GET /identity/v2/manage/account Retrieve Account
getAccountIdentityByUID GET /identity/v2/manage/account/{uid} Retrieve Account by UID
getConsentLogsByUid GET /identity/v2/manage/account/{uid}/consent/logs Retrieve Consent Logs
getIdentities GET /identity/v2/manage/account/identities Retrieve Account by Email
getImpersonationToken GET /identity/v2/manage/account/access_token Retrieve Impersonation Token
getPrivacyPolicyHistoryByUid GET /identity/v2/manage/account/{uid}/privacypolicy/history Retrieve Privacy Policy History
getProfilePassword GET /identity/v2/manage/account/{uid}/password Retrieve Password
invalidateEmailVerification PUT /identity/v2/manage/account/{uid}/invalidateemail Invalidate Email Verification
listPasskeyUser GET /identity/v2/manage/account/passkey List Passkeys
resetPhoneVerification PUT /identity/v2/manage/account/{uid}/invalidatephone Invalidate Phone verification
setProfilePassword PUT /identity/v2/manage/account/{uid}/password Update Password
updateAccountProfileByUID PUT /identity/v2/manage/account/{uid} Update Account by UID
updatePhoneNumber PUT /identity/v2/manage/account/{uid}/phoneid Update Phone
upsertEmailForAccount PUT /identity/v2/manage/account/{uid}/email Upsert Email

4 operation(s). Parameters, request bodies and return types are on the BigCommerce SSO page.

Method HTTP request Description
bigCommerceAuth GET /sso/bigcommerce/auth BigCommerce OAuth Authorization
getBigCommerceLoginUrl GET /sso/bigcommerce/api/token Generate BigCommerce Login URL (GET)
postBigCommerceLoginUrl POST /sso/bigcommerce/api/token Generate BigCommerce Login URL (POST)
validateBigCommercePassword POST /sso/bigcommerce/api/validatepassword Validate BigCommerce Customer Password

2 operation(s). Parameters, request bodies and return types are on the Captcha Configuration page.

Method HTTP request Description
getCaptchaConfiguration GET /v2/manage/captcha Retrieve captcha configuration
updateCaptchaConfiguration PUT /v2/manage/captcha Update captcha configuration

7 operation(s). Parameters, request bodies and return types are on the Consent page.

Method HTTP request Description
addConsentForm POST /consent/forms Add Consent Form
createConsentOption POST /consent/options Create Consent Option
deleteConsentForm DELETE /consent/forms/{version} Delete Consent Form
deleteConsentOption DELETE /consent/options/{optionId} Delete Consent Option
getActiveConsentForms GET /consent/forms/active Retrieve Active Consent Forms
getConsentForms GET /consent/forms Retrieve Consent Forms
getConsentOptions GET /consent/options Retrieve Consent Options

3 operation(s). Parameters, request bodies and return types are on the Cross Device SSO page.

Method HTTP request Description
generateQRCode GET /sso/mobile/generate Retrieve QR code
getAccessTokenByPing GET /sso/mobile/token Retrieve Access Token by ping
mapQRCodeToAccessToken POST /sso/mobile/token Map QR code to Access Token

7 operation(s). Parameters, request bodies and return types are on the Custom Fields page.

Method HTTP request Description
createCustomField POST /v2/manage/custom-fields Create custom field
deleteCustomField DELETE /v2/manage/custom-fields/{cfname} Delete custom field
getActiveCustomFields GET /v2/manage/custom-fields/active List active custom fields
getAllCustomFields GET /v2/manage/custom-fields List custom fields
getCustomFieldLimit GET /v2/manage/custom-fields/limit Retrieve custom field limit
listCustomFields GET /v2/manage/custom-fields/list List custom fields
setCustomField PUT /v2/manage/custom-fields Set custom field

5 operation(s). Parameters, request bodies and return types are on the Custom Object page.

Method HTTP request Description
createCustomObjectByToken POST /identity/v2/auth/customobject Create Custom Object
deleteCustomObjectByTokenAndRecordId DELETE /identity/v2/auth/customobject/{objectrecordid} Delete Custom Object by ID
getCustomObjectByToken GET /identity/v2/auth/customobject Retrieve Custom Objects
getCustomObjectByTokenAndRecordId GET /identity/v2/auth/customobject/{objectrecordid} Retrieve Custom Object by ID
updateCustomObjectByTokenAndRecordId PUT /identity/v2/auth/customobject/{objectrecordid} Update Custom Object by ID

4 operation(s). Parameters, request bodies and return types are on the Custom Objects page.

Method HTTP request Description
getAllCustomObjectsByQuery GET /customobject Retrieve Custom Object data by pagination
getCustomObjectByQuery GET /identity/customobject Retrieve User's and Custom Object data by pagination
postAllCustomObjectsByQuery POST /customobject Retrieve Custom Object data by query
postCustomObjectByQuery POST /identity/customobject Retrieve User's and Custom Object data by query

2 operation(s). Parameters, request bodies and return types are on the Domain Access Restrictions page.

Method HTTP request Description
getDomainAccessRestrictionsByAppID GET /v2/manage/restrictions/domain-access Retrieve Domain Access Restrictions
updateDomainAccessRestrictionsByAppID PUT /v2/manage/restrictions/domain-access Update Domain Access Restrictions

4 operation(s). Parameters, request bodies and return types are on the Email Templates page.

Method HTTP request Description
addEmailTemplate POST /v2/manage/email-templates Create Email template
deleteEmailTemplate DELETE /v2/manage/email-templates/{templateType} Delete Email Template
getEmailTemplates GET /v2/manage/email-templates List Email templates
updateEmailTemplate PUT /v2/manage/email-templates/{templateType} Update Email Template

2 operation(s). Parameters, request bodies and return types are on the Identity page.

Method HTTP request Description
getUserProfilesByPageId GET /identity Retrieve User's by pagination
queryUserProfiles POST /identity Retrieve User's by query

1 operation(s). Parameters, request bodies and return types are on the Insights page.

Method HTTP request Description
queryUserProfilesInsights POST /insights/userprofiles Retrieve User's data by filters

3 operation(s). Parameters, request bodies and return types are on the IP Access Restrictions page.

Method HTTP request Description
getIPAccessRestrictions GET /v2/manage/restrictions/ip-access Retrieve IP Access Restrictions
resetIPAccessRestrictions DELETE /v2/manage/restrictions/ip-access Reset IP Access Restrictions
updateIPAccessRestrictions PUT /v2/manage/restrictions/ip-access Update IP Access Restrictions

2 operation(s). Parameters, request bodies and return types are on the JWT page.

Method HTTP request Description
getJWTTokenByAccessToken GET /api/jwt/{JwtAppName}/token Retrieve JWT token by Access Token
getJWTTokenByLoginCredentials POST /api/jwt/{JwtAppName}/login Retrieve JWT token

5 operation(s). Parameters, request bodies and return types are on the JWT Custom Providers page.

Method HTTP request Description
createJwtSPClientConfiguration POST /v2/manage/custom-providers/jwt Create JWT SP configuration
deleteJwtSPClientConfigurationByAppName DELETE /v2/manage/custom-providers/jwt/{jwtApp} Delete JWT SP configuration
getAllJwtConfigSPConfigurations GET /v2/manage/custom-providers/jwt List JWT SP configurations
getJwtSPClientConfigurationByAppName GET /v2/manage/custom-providers/jwt/{jwtApp} Retrieve JWT SP configuration
updateJwtSPClientConfigurationByAppName PUT /v2/manage/custom-providers/jwt/{jwtApp} Update JWT SP configuration

7 operation(s). Parameters, request bodies and return types are on the JWT Integrations page.

Method HTTP request Description
createJwtIntegration POST /v2/manage/integrations/jwt Create JWT Integration
deleteJwtIntegration DELETE /v2/manage/integrations/jwt/{jwtApp} Delete JWT Integration configuration
getAllJwtIntegrations GET /v2/manage/integrations/jwt List JWT Integrations
getJwtIntegrationByAppName GET /v2/manage/integrations/jwt/{jwtApp} Retrieve JWT Integration configuration
getJwtIntegrationDataMappingFieldsList GET /v2/manage/integrations/jwt/data-mapping List JWT data mapping fields
getJwtIntegrationSupportedAlgoList GET /v2/manage/integrations/jwt/algo List supported JWT algorithms
updateJwtIntegrationByAppName PUT /v2/manage/integrations/jwt/{jwtApp} Update JWT Integration configuration

28 operation(s). Parameters, request bodies and return types are on the Login page.

Method HTTP request Description
accountRegisterPasskeyBegin GET /identity/v2/auth/account/register/passkey/begin Begin Passkey registration
accountRegisterPasskeyFinish POST /identity/v2/auth/account/register/passkey/finish Complete Passkey registration
beginAutofillPasskeyLogin GET /identity/v2/auth/login/passkey/autofill/begin Initiate Login with Autofill Passkey
beginPasskeyLogin GET /identity/v2/auth/login/passkey/begin Initiate Login with Passkey
beginPasskeyReset GET /identity/v2/auth/passkey/reset/begin Begin Passkey Reset
checkUserNameAvailability GET /identity/v2/auth/username Check Username availability
emailByLoginUserNamePhone POST /identity/v2/auth/login Login with credentials
finishAutofillPasskeyLogin POST /identity/v2/auth/login/passkey/autofill/finish Complete Login with Autofill Passkey
finishPasskeyLogin POST /identity/v2/auth/login/passkey/finish Complete Login with Passkey
finishPasskeyReset POST /identity/v2/auth/passkey/reset/finish Complete Passkey Reset
getPhoneNumberAvailability GET /identity/v2/auth/phone Check Phone availability
getSmartLogin GET /identity/v2/auth/login/smartlogin Retrieve OTP or Link for Smart Login
loginByNoRegistrationPassCode POST /identity/v2/auth/onetouchlogin/phone/verify Verify one-touch login
nativeProviderAccessToken GET /api/v2/access_token/{nativeProvider} Login via social provider
oneTouchLoginByEmail POST /identity/v2/auth/onetouchlogin/email Retrieve link or OTP for one-touch login
oneTouchLoginByPhone POST /identity/v2/auth/onetouchlogin/phone Retrieve OTP for one-touch login
passkeyForgot POST /identity/v2/auth/passkey/forgot Initiate Forgot Passkey
passwordlessEmailVerification GET /identity/v2/auth/login/passwordlesslogin/email/verify Verify Email for passwordless login
passwordlessLoginByEmail GET /identity/v2/auth/login/passwordlesslogin/email Initiate passwordless login by Email
passwordlessLoginByEmailAndOTP POST /identity/v2/auth/login/passwordlesslogin/email/verifyotp Verify Email and OTP for passwordless login
passwordlessLoginByEmailWithProfile POST /identity/v2/auth/login/passwordlesslogin/email Initiate passwordless login by Email with a registration profile
passwordlessLoginByPhone GET /identity/v2/auth/login/passwordlesslogin/otp Initiate passwordless login by Phone
passwordlessLoginByPhoneWithProfile POST /identity/v2/auth/login/passwordlesslogin/otp Initiate passwordless login by Phone with a registration profile
passwordlessLoginByUsernameAndOTP POST /identity/v2/auth/login/passwordlesslogin/username/verifyotp Verify Username for passwordless login
passwordlessLoginPhoneVerification PUT /identity/v2/auth/login/passwordlesslogin/otp/verify Verify Phone for passwordless login
pingSmartLogin GET /identity/v2/auth/login/smartlogin/ping Ping Smart Login
verifyAutoLoginEmailOneTouch GET /identity/v2/auth/email/onetouchlogin Verify one-touch login by Email
verifyAutoLoginEmailSmartLogin GET /identity/v2/auth/email/smartlogin Verify smart login by Email

4 operation(s). Parameters, request bodies and return types are on the Multipurpose Tokens page.

Method HTTP request Description
forgotPasswordTokenAndEmail POST /identity/v2/manage/account/forgot/token Retrieve Forgot Password Token
getVerificationToken GET /identity/v2/manage/account/vtoken Retrieve Email Verification Token
multipurposeEmailTokenAPI POST /identity/v2/manage/account/emailtoken/{tokentype} Retrieve Multipurpose Email Token
multipurposeSmsOtpAPI POST /identity/v2/manage/account/smsotp/{smsotptype} Multipurpose SMS OTP

6 operation(s). Parameters, request bodies and return types are on the OAuth page.

Method HTTP request Description
getOAuthAuthorizationServerMetadataOAuth GET /service/oauth/{OAuthAppName}/.well-known/oauth-authorization-server OAuth Authorization Server Metadata (OAuth app)
getOAuthDeviceCode POST /api/oauth/{OAuthAppName}/device Retrieve OAuth device code
getOAuthTokens POST /api/oauth/{OAuthAppName}/token Retrieve OAuth tokens
introspectOAuthToken POST /api/oauth/{OAuthAppName}/introspect Introspect OAuth token
oAuthPushedAuthorizationRequest POST /api/oauth/{OAuthAppName}/par OAuth 2.0 Pushed Authorization Request (PAR)
revokeOAuthRefreshToken POST /api/oauth/{OAuthAppName}/revoke Revoke OAuth refresh token

7 operation(s). Parameters, request bodies and return types are on the OAuth Clients page.

Method HTTP request Description
createOAuthClientConfiguration POST /v2/manage/oauth-clients Create OAuth client
deleteOAuthClient DELETE /v2/manage/oauth-clients/{oAuthClientName} Delete OAuth Client Configuration
getAllOAuthClientsConfigurations GET /v2/manage/oauth-clients List OAuth clients
getOAuthClientConfigurationByAppName GET /v2/manage/oauth-clients/{oAuthClientName} Retrieve OAuth Client Configuration
getOAuthClientConnectionsMetadata GET /v2/manage/oauth-clients/connections-metadata Retrieve OAuth Client Metadata
resetOAuthClientConfigurationSecretByAppName PUT /v2/manage/oauth-clients/credentials/{oAuthClientName} Reset OAuth client secret
updateOAuthClientConfigurationByAppName PUT /v2/manage/oauth-clients/{oAuthClientName} Update OAuth Client Configuration

5 operation(s). Parameters, request bodies and return types are on the OAuth Custom Providers page.

Method HTTP request Description
createCustomProvider POST /v2/manage/custom-providers/oauth Create custom OAuth provider
deleteCustomProvider DELETE /v2/manage/custom-providers/oauth Delete custom OAuth provider
getAllCustomOAuthProviders GET /v2/manage/custom-providers/oauth List custom OAuth providers
getCustomProviderKeys GET /v2/manage/custom-providers/oauth/keys Retrieve custom OAuth provider keys
updateCustomProvider PUT /v2/manage/custom-providers/oauth Update custom OAuth provider

6 operation(s). Parameters, request bodies and return types are on the OAuth Integrations page.

Method HTTP request Description
createOAuthIntegration POST /v2/manage/integrations/oauth Create OAuth Integration
deleteOAuthIntegration DELETE /v2/manage/integrations/oauth/{integrationId} Delete OAuth Integration configuration
getAllOAuthIntegrations GET /v2/manage/integrations/oauth List OAuth Integrations
getOAuthIntegrationById GET /v2/manage/integrations/oauth/{integrationId} Retrieve OAuth Integration configuration
rotateOAuthIntegrationCredentials PUT /v2/manage/integrations/oauth/{integrationId}/credentials Rotate OAuth Integration client secret
updateOAuthIntegrationById PUT /v2/manage/integrations/oauth/{integrationId} Update OAuth Integration configuration

4 operation(s). Parameters, request bodies and return types are on the OAuth M2M page.

Method HTTP request Description
generateM2MToken POST /service/oauth/token Generate M2M token
getM2MJWKSConfig GET /service/oauth/jwks Retrieve JSON Web Key Set
getM2MTokenInfo POST /service/oauth/introspect Retrieve M2M token info
revokeM2MToken POST /service/oauth/revoke Revoke M2M token

14 operation(s). Parameters, request bodies and return types are on the OIDC page.

Method HTTP request Description
deleteDynamicClient DELETE /api/oidc/{OIDCAppName}/register/{clientID} Delete a Dynamic Client
getDynamicClient GET /api/oidc/{OIDCAppName}/register/{clientID} Get a Dynamic Client
getOAuthAuthorizationServerMetadataOIDC GET /service/oidc/{OIDCAppName}/.well-known/oauth-authorization-server OAuth Authorization Server Metadata (OIDC app)
getOIDCDeviceCode POST /api/oidc/{OIDCAppName}/device Retrieve OIDC device code
getOIDCDiscoveryConfig GET /service/oidc/{OIDCAppName}/.well-known/openid-configuration OpenID Connect Discovery endpoint
getOIDCJWKSConfig GET /service/oidc/{OIDCAppName}/jwks Retrieve JSON Web Key Set
getOIDCTokens POST /api/oidc/{OIDCAppName}/token Retrieve OIDC tokens
getOIDCUserinfo GET /service/oidc/{OIDCAppName}/userinfo Retrieve OIDC User info
getOIDCUserinfoByPost POST /service/oidc/{OIDCAppName}/userinfo Retrieve OIDC User info via POST
introspectOIDCToken POST /api/oidc/{OIDCAppName}/introspect Introspect OIDC token
oIDCDynamicClientRegistration POST /api/oidc/{OIDCAppName}/register OIDC dynamic client registration
oIDCPushedAuthorizationRequest POST /api/oidc/{OIDCAppName}/par OIDC Pushed Authorization Request (PAR)
revokeOIDCRefreshToken POST /api/oidc/{OIDCAppName}/revoke Revoke OIDC refresh token
updateDynamicClient PUT /api/oidc/{OIDCAppName}/register/{clientID} Update a Dynamic Client

8 operation(s). Parameters, request bodies and return types are on the Organization page.

Method HTTP request Description
createOrganization POST /v2/manage/organizations Create Organization
createOrgTenantRole POST /v2/manage/organizations/{orgId}/roles Create Role in Organization
deleteOrganization DELETE /v2/manage/organizations/{orgId} Delete Organization
getAllOrganizations GET /v2/manage/organizations List Organizations
getOrganization GET /v2/manage/organizations/{orgId} Retrieve Organization details
getOrgContextByOrgId GET /v2/manage/organizations/{orgId}/orgcontext Retrieve Organization context
getOrgRolesByOrgId GET /v2/manage/organizations/{orgId}/roles List Organization Roles
updateOrganization PUT /v2/manage/organizations/{orgId} Update Organization

4 operation(s). Parameters, request bodies and return types are on the Organization Connection Group Roles page.

Method HTTP request Description
createConnectionGroupRole POST /v2/manage/organizations/{orgId}/connections/{connId}/grouproles Create Organization connection group Role
deleteConnectionGroupRole DELETE /v2/manage/organizations/{orgId}/connections/{connId}/grouproles/{groupRoleId} Delete Organization connection group Role
getAllConnectionGroupRoles GET /v2/manage/organizations/{orgId}/connections/{connId}/grouproles List Organization connection group Roles
updateConnectionGroupRole PUT /v2/manage/organizations/{orgId}/connections/{connId}/grouproles/{groupRoleId} Update Organization connection group Role

6 operation(s). Parameters, request bodies and return types are on the Organization Connections page.

Method HTTP request Description
createOrganizationConnection POST /v2/manage/organizations/{orgId}/connections Create Organization connection
deleteOrganizationConnection DELETE /v2/manage/organizations/{orgId}/connections/{connId} Delete Organization connection
getAllOrganizationConnections GET /v2/manage/organizations/{orgId}/connections List Organization connections
getOrganizationConnection GET /v2/manage/organizations/{orgId}/connections/{connId} Retrieve Organization connection
updateConnectionStatus PUT /v2/manage/organizations/{orgId}/connections/{connId}/status Update Organization connection status
updateOrganizationConnection PUT /v2/manage/organizations/{orgId}/connections/{connId} Update Organization connection

5 operation(s). Parameters, request bodies and return types are on the Organization Domains page.

Method HTTP request Description
addOrganizationDomain POST /v2/manage/organizations/{orgId}/domains Add Organization domain
deleteOrganizationDomain DELETE /v2/manage/organizations/{orgId}/domains/{domainId} Delete Organization domain
getAllOrganizationDomains GET /v2/manage/organizations/{orgId}/domains List Organization domains
getOrganizationDomain GET /v2/manage/organizations/{orgId}/domains/{domainId} Retrieve Organization domain
verifyOrganizationDomain POST /v2/manage/organizations/{orgId}/domains/{domainId} Verify Organization domain

5 operation(s). Parameters, request bodies and return types are on the Organization Invitations page.

Method HTTP request Description
deleteInvitationByInvitationId DELETE /v2/manage/invitations/{invitationid} Delete invitation by ID
getInvitationsByOrgId GET /v2/manage/invitations List invitations by Organization ID
resendInvitationByInvitationId POST /v2/manage/invitations/{invitationid}/resend Resend invitation by ID
sendInvitation POST /v2/manage/invitations Send invitation
updateInvitationByInvitationId PUT /v2/manage/invitations/{invitationid} Update invitation by ID

6 operation(s). Parameters, request bodies and return types are on the Organization User Roles page.

Method HTTP request Description
assignRolesToUser PUT /v2/manage/account/{uid}/orgcontext/{orgId}/roles Assign Roles in Organization
assignRolesToUserInAllOrgs PUT /v2/manage/account/{uid}/orgcontext/roles Assign Roles in Tenant
deleteOrgContextByUid DELETE /v2/manage/account/{uid}/orgcontext Delete Organization context by UID
deleteOrgContextByUidAndOrgId DELETE /v2/manage/account/{uid}/orgcontext/{orgId} Delete Organization Roles by OrgID and UID
getOrgContextByUid GET /v2/manage/account/{uid}/orgcontext Retrieve Organization context by UID
getOrgContextByUidAndOrgId GET /v2/manage/account/{uid}/orgcontext/{orgId} Retrieve Organization Roles by OrgID and UID

2 operation(s). Parameters, request bodies and return types are on the Passkey Configuration page.

Method HTTP request Description
getPassKeyConfig GET /v2/manage/passkey Retrieve Passkey configuration
upsertPassKeyConfig PUT /v2/manage/passkey Update Passkey configuration

7 operation(s). Parameters, request bodies and return types are on the Password page.

Method HTTP request Description
changePassword PUT /identity/v2/auth/password/change Update Password
forgotPassword POST /identity/v2/auth/password Forgot Password
requestOTPForPasswordReset POST /identity/v2/auth/password/otp Retrieve Password reset OTP
resetPassword PUT /identity/v2/auth/password/reset Reset Password with token and OTP
resetPasswordByResetToken PUT /identity/v2/auth/password Reset Password with token and OTP
resetPasswordSecurityAnswer PUT /identity/v2/auth/password/securityanswer Reset Password with security question
resetPasswordWithOTP PUT /identity/v2/auth/password/otp Reset Password with Phone and OTP

2 operation(s). Parameters, request bodies and return types are on the Password Policy page.

Method HTTP request Description
getPasswordPolicy GET /v2/manage/password-policies Retrieve Password policy
updatePasswordPolicy PUT /v2/manage/password-policies Update Password policy

2 operation(s). Parameters, request bodies and return types are on the PerfectMind SSO page.

Method HTTP request Description
getPerfectMindContact GET /sso/perfectmind/contact Get PerfectMind Contact IDs
getPerfectMindSession GET /sso/perfectmind/session Generate PerfectMind Login Session

5 operation(s). Parameters, request bodies and return types are on the Permissions page.

Method HTTP request Description
addPermission POST /v2/manage/permissions Create Permission
deleteTenantPermission DELETE /v2/manage/permissions/{id} Delete Permission
getPermissionById GET /v2/manage/permissions/{id} Retrieve Permission by ID
permissions GET /v2/manage/permissions List Permissions
updateTenantPermission PUT /v2/manage/permissions/{id} Update Permission

3 operation(s). Parameters, request bodies and return types are on the Push Notification Configuration page.

Method HTTP request Description
createPushSettings POST /v2/manage/2fa/push-notification-settings Create Push Notification settings
getPushSettings GET /v2/manage/2fa/push-notification-settings Retrieve Push Notification settings
updatePushSettings PUT /v2/manage/2fa/push-notification-settings Update Push Notification settings

4 operation(s). Parameters, request bodies and return types are on the Registration page.

Method HTTP request Description
beginPasskeyRegistration GET /identity/v2/auth/register/passkey/begin Initiate Registration with Passkey
finishPasskeyRegistration POST /identity/v2/auth/register/passkey/finish Complete Registration with Passkey
userRegistrationByReCaptchaEmailPhoneUserName POST /identity/v2/auth/register/captcha Registration by Email/Phone/Username via Captcha
userRegistrationBySottEmailPhoneUserName POST /identity/v2/auth/register Registration by Email/Phone/Username via SOTT

7 operation(s). Parameters, request bodies and return types are on the Roles page.

Method HTTP request Description
createTenantRole POST /v2/manage/roles Create Tenant Role
deleteTenantRole DELETE /v2/manage/roles/{id} Delete Role
getAllTenantRoles GET /v2/manage/roles List Tenant Roles
getRoleById GET /v2/manage/roles/{id} Retrieve Role by ID
roleByName GET /v2/manage/roles/{name}/name Retrieve Role by name
setDefaultRole PUT /v2/manage/roles/{id}/default Set default Role
updateRole PUT /v2/manage/roles/{id} Update Role

9 operation(s). Parameters, request bodies and return types are on the Roles Management page.

Method HTTP request Description
deleteContextRoleByUid DELETE /identity/v2/manage/account/{uid}/rolecontext/{contextName}/role Delete Role from Context
deleteRoleContextAdditionalPermissionsByUid DELETE /identity/v2/manage/account/{uid}/rolecontext/{contextName}/additionalpermission Delete Additional Permissions from Context
deleteRoleContextByUid DELETE /identity/v2/manage/account/{uid}/rolecontext/{contextName} Delete Role Context
deleteRolesByUid DELETE /identity/v2/manage/account/{uid}/role Unassign Roles by UID
getRoleContextByContextName GET /identity/v2/manage/account/roleContext/{contextName} Retrieve Role Context
getRoleContextByUid GET /identity/v2/manage/account/{uid}/rolecontext Retrieve Context by UID
getRolesByUid GET /identity/v2/manage/account/{uid}/role Retrieve Roles by UID
saveRolesByUid PUT /identity/v2/manage/account/{uid}/role Assign Roles by UID
upsertRoleContextByUid PUT /identity/v2/manage/account/{uid}/rolecontext Upsert Context by UID

1 operation(s). Parameters, request bodies and return types are on the SAML page.

Method HTTP request Description
getSAMLIDPMetadata GET /service/saml/idp/metadata Retrieve SAML IDP metadata

7 operation(s). Parameters, request bodies and return types are on the SAML Custom Providers page.

Method HTTP request Description
createSAMLSPClientConfiguration POST /v2/manage/custom-providers/saml Create SAML SP Configuration
deleteSAMLSPClientConfigurationByAppName DELETE /v2/manage/custom-providers/saml/{samlApp} Delete SAML SP Configuration
getAllSAMLSPClientConfigurations GET /v2/manage/custom-providers/saml List SAML SP Configurations
getSAMLSPClientConfigurationByAppName GET /v2/manage/custom-providers/saml/{samlApp} Retrieve SAML SP Configuration
getSamlSPClientMappingKeys GET /v2/manage/custom-providers/saml/keys Retrieve SAML SP Mapping Keys
renewSAMLSppCertificate POST /v2/manage/custom-providers/saml/{samlApp}/renew-certificate Renew SAML SP Certificate
updateSAMLSPClientConfigurationByAppName PUT /v2/manage/custom-providers/saml/{samlApp} Update SAML SP Configuration

6 operation(s). Parameters, request bodies and return types are on the SAML Integrations page.

Method HTTP request Description
createSamlIntegration POST /v2/manage/integrations/saml Create SAML IdP Configuration
deleteSamlIntegrationByAppName DELETE /v2/manage/integrations/saml/{samlApp} Delete SAML IdP Configuration
getAllSamlIntegrations GET /v2/manage/integrations/saml List SAML Integrations
getSamlIntegrationByAppName GET /v2/manage/integrations/saml/{samlApp} Retrieve SAML IdP client configuration by app name
renewSamlIntegrationCertificate POST /v2/manage/integrations/saml/{samlApp}/renew-certificate Renew SAML IdP Certificate
updateSamlIntegrationByAppName PUT /v2/manage/integrations/saml/{samlApp} Update SAML IdP client configuration by app name

6 operation(s). Parameters, request bodies and return types are on the Second Factor Configuration page.

Method HTTP request Description
getDuoAuthenticatorConfiguration GET /v2/manage/2fa/duo-authenticator-settings Retrieve Duo configuration
getSecondFactorConfiguration GET /v2/manage/2fa/config Retrieve second factor configuration
getTOTPConfiguration GET /v2/manage/2fa/totp-authenticator-settings Retrieve TOTP configuration
updateDuoAuthenticatorConfiguration PUT /v2/manage/2fa/duo-authenticator-settings Update Duo configuration
updateSecondFactorConfiguration PUT /v2/manage/2fa/config Update second factor configuration
updateTOTPConfiguration PUT /v2/manage/2fa/totp-authenticator-settings Update TOTP configuration

51 operation(s). Parameters, request bodies and return types are on the Security page.

Method HTTP request Description
accountRegisterMFAPasskeyBegin GET /identity/v2/auth/account/2fa/register/passkey/begin Begin MFA Passkey registration
accountRegisterMFAPasskeyFinish POST /identity/v2/auth/account/2fa/register/passkey/finish Complete MFA Passkey registration
beginMFAPasskeyRegistration GET /identity/v2/auth/login/2fa/register/passkey/begin Begin Passkey Registration with MFA Token
beginPasskeyMFAVerification GET /identity/v2/auth/login/2fa/passkey/begin Begin Passkey Login with MFA Token
changePinByAccessToken PUT /identity/v2/auth/pin/change Update PIN with Access Token
duoAuthenticationReAuthVerificationByAccessToken PUT /identity/v2/auth/account/reauth/2fa/duo Verify Duo
duoAuthenticationVerificationByAccessToken PUT /identity/v2/auth/account/2fa/duo Verify Duo authentication
duoAuthVerificationByMFASecondFactorToken PUT /identity/v2/auth/login/2fa/duo Verify Duo with MFA Token
emailOTPAuthVerificationByAccessToken PUT /identity/v2/auth/account/2fa/email Verify Email OTP
finishMFAPasskeyRegistration POST /identity/v2/auth/login/2fa/register/passkey/finish Complete Passkey registration
finishPasskeyMFAVerification POST /identity/v2/auth/login/2fa/passkey/finish Complete Passkey Login with MFA Token
forgotPinByEmail POST /identity/v2/auth/pin/forgot/email Send PIN Reset Email
forgotPinByPhone POST /identity/v2/auth/pin/forgot/otp Send OTP for PIN Reset
forgotPinByUsername POST /identity/v2/auth/pin/forgot/username Send PIN Reset Email by Username
getMfaPushDeviceStatus GET /identity/v2/auth/account/2fa/push/ping Check push device registration status
getMFASettings GET /identity/v2/auth/account/2fa Retrieve MFA settings
mfaGenerateBackupCodes GET /identity/v2/auth/account/2fa/backupcode Generate backup codes
mfaResendPushNotification POST /identity/v2/auth/login/2fa/push Resend Push Notification
mfaResetBackupCodes GET /identity/v2/auth/account/2fa/backupcode/reset Reset backup codes
mFAResetSMSAuthByToken DELETE /identity/v2/auth/account/2fa/sms Reset SMS Authenticator
mFAResetTotpByToken DELETE /identity/v2/auth/account/2fa/totp Reset TOTP
mFAUpdatePhoneNumberByMfaToken PUT /identity/v2/auth/login/2fa/sms/phone Update Phone with MFA Token
mFAUpdatePhoneNumberByToken PUT /identity/v2/auth/account/2fa/sms/phone Update Phone by token
mFAVerifyPhoneNumberByAccessToken PUT /identity/v2/auth/account/2fa/sms Verify Phone MFA
pingPushVerificationStatus GET /identity/v2/auth/login/2fa/push/ping Check Push Notification Verification Status
pINLogin POST /identity/v2/auth/login/pin Login with PIN
reauthPassword PUT /identity/v2/auth/account/reauth/password Verify Password
reauthPin PUT /identity/v2/auth/account/reauth/pin Verify PIN
reauthTrigger GET /identity/v2/auth/account/reauth/2fa Retrieve Step-Up Authentication settings
resend2FAOTP GET /identity/v2/auth/login/2fa/resend Resend SMS OTP with MFA Token
resend2faSMSOtp GET /identity/v2/auth/login/2fa/sms/resend Resend SMS OTP with MFA Token
resendEmailOTPMFAToken POST /identity/v2/auth/login/2fa/email Resend Email OTP with MFA Token
resendTwoFactorEmailOtp GET /identity/v2/auth/account/2fa/email Resend Email OTP
resetDuoAuthViaAccessToken DELETE /identity/v2/auth/account/2fa/duo Reset Duo Authenticator
resetMFAEmailAuthByAccessToken DELETE /identity/v2/auth/account/2fa/email Reset Email OTP Authenticator
resetMFAPasskeyByAccessToken DELETE /identity/v2/auth/account/2fa/passkey Reset Passkey Authenticator
resetMfaPushAuthSettings DELETE /identity/v2/auth/account/2fa/push Reset MFA Push Notification
resetPinByOTP PUT /identity/v2/auth/pin/reset/otp/{type} Reset PIN with OTP
resetPinByResetToken PUT /identity/v2/auth/pin/reset/token Reset PIN with Reset Token
sendEmailOtpForReauthMFA GET /identity/v2/auth/account/reauth/2fa/email Send Email OTP
sendReAuthEmailOtp GET /identity/v2/auth/account/reauth/otp/email Send Email OTP
setPinByPinAuthToken POST /identity/v2/auth/pin/set/pinauthtoken Set PIN with Authentication Token
validateEmailOtpForReauth PUT /identity/v2/auth/account/reauth/otp/email Verify Email OTP
validateEmailOtpForReauthMFA PUT /identity/v2/auth/account/reauth/2fa/otp/email/verify Verify Email OTP
validateMfaOTPByEmail PUT /identity/v2/auth/login/2fa/email Verify Email OTP with MFA Token
validateMfaOTPByPhone PUT /identity/v2/auth/login/2fa/sms Verify SMS OTP
validateReauthMFA PUT /identity/v2/auth/account/reauth/2fa/{type} Verify backup code or OTP
validateSecurityQuestionReauthMFA POST /identity/v2/auth/account/reauth/2fa/securityquestionanswer/verify Verify security question answer
verify2faTOTPAuth PUT /identity/v2/auth/account/2fa/totp Verify TOTP code
verifyBackupCodeForMFALogin PUT /identity/v2/auth/login/2fa/backupcode Verify Backup Code with MFA Token
verifyTotpByMfaToken PUT /identity/v2/auth/login/2fa/totp Verify TOTP Code with MFA Token

6 operation(s). Parameters, request bodies and return types are on the Security Questions page.

Method HTTP request Description
addSecurityQuestion POST /v2/manage/security-questions Add security question
deleteSecurityQuestion DELETE /v2/manage/security-questions/{securityQuestionID} Delete security question
getSecurityQuestionRenderCount GET /v2/manage/security-questions/count Retrieve security question count
getSecurityQuestions GET /v2/manage/security-questions Retrieve security questions
updateSecurityQuestion PUT /v2/manage/security-questions/{securityQuestionID} Update security question
updateSecurityQuestionRenderCount PUT /v2/manage/security-questions/count Update security question count

3 operation(s). Parameters, request bodies and return types are on the Session page.

Method HTTP request Description
authValidateAccessToken GET /identity/v2/auth/access_token/validate Validate Access Token
getAccessTokenInfo GET /identity/v2/auth/access_token Retrieve Access Token information
invalidateAccessToken GET /identity/v2/auth/access_token/invalidate Invalidate Access Token

1 operation(s). Parameters, request bodies and return types are on the Shopify SSO page.

Method HTTP request Description
getShopifyLoginUrl GET /sso/shopify/api/token Generate Shopify Multipass Login URL

4 operation(s). Parameters, request bodies and return types are on the SMS Templates page.

Method HTTP request Description
createSmsTemplate POST /v2/manage/smstemplates Create SMS template
deleteSmsTemplate DELETE /v2/manage/sms-templates/{templateType} Delete SMS template
getSmsTemplates GET /v2/manage/smstemplates List SMS templates
updateSmsTemplate PUT /v2/manage/sms-templates/{templateType} Update SMS template

7 operation(s). Parameters, request bodies and return types are on the Social Providers page.

Method HTTP request Description
deleteSocialProviderByName DELETE /v2/manage/providers/{provider} Delete social provider configuration
getAllProviderConfigurations GET /v2/manage/providers List social provider configurations
getEnabledProviders GET /v2/manage/providers/active Retrieve enabled social providers
getSocialProviderByName GET /v2/manage/providers/{provider} Retrieve social provider configuration
setProvidersOrder PUT /v2/manage/providers/setorder Set social provider order
setProvidersStatus PUT /v2/manage/providers Set social provider status
updateSocialProviderByName PUT /v2/manage/providers/{provider} Update social provider configuration

2 operation(s). Parameters, request bodies and return types are on the SOTT page.

Method HTTP request Description
addSott POST /v2/manage/sott Generate SOTT
getAllSOTT GET /v2/manage/sott List SOTTs

33 operation(s). Parameters, request bodies and return types are on the User page.

Method HTTP request Description
accountListPasskey GET /identity/v2/auth/account/passkey List registered Passkeys
accountRemovePasskey DELETE /identity/v2/auth/account/passkey/{passkeyId} Remove Passkey
addEmail POST /identity/v2/auth/email Add Email
changePhoneNumber PUT /identity/v2/auth/phone Change Phone number
checkEmailAvailability GET /identity/v2/auth/email Check Email availability
deleteAccByPhoneOTP POST /identity/v2/auth/account/delete Delete Account by Phone OTP
deleteAccount GET /identity/v2/auth/account/delete Delete Account by Email token or OTP
deleteAccountByAccessToken DELETE /identity/v2/auth/account Send User deletion Email
deleteemailbyaccesstoken DELETE /identity/v2/auth/email Remove Email
getAccountDetails GET /identity/v2/auth/account Retrieve User
getConsentLogs GET /identity/v2/auth/consent/logs Retrieve Consent Logs
getInvitation GET /identity/v2/auth/invitations/{invitation_token} Retrieve invitation details
getInvitationByInvitationId GET /v2/manage/invitations/{invitationid} Retrieve invitation by ID
getPrivacyPolicyAcceptance GET /identity/v2/auth/privacypolicy/accept Accept Privacy Policy
getPrivacyPolicyHistory GET /identity/v2/auth/privacypolicy/history Retrieve Privacy Policy History
getVerifiedConsentWithAccessToken GET /identity/v2/auth/consent/verify Retrieve Consent Status
linkSocialIdentitiesByAccessToken POST /identity/v2/auth/socialidentity Link social identities
linkSocialIdentitiesByPing POST /identity/v2/auth/socialidentity/ping Link social identities via PING
removePhoneIdByToken DELETE /identity/v2/auth/phone Remove Phone number
resendEmailVerification PUT /identity/v2/auth/register Resend verification Email
resendPhoneOtp POST /identity/v2/auth/phone/otp Resend Phone OTP
sendDeleteOtp GET /identity/v2/auth/account/otp Retrieve delete Account OTP
sendEmailVerification GET /identity/v2/auth/email/sendverificationemail Send verification Email for social profile linking
sendWelcomeEmail GET /identity/v2/auth/account/sendwelcomeemail Send Welcome Email
setorchangeusernamebyaccesstoken PUT /identity/v2/auth/username Update Username
submitConsentByAccessToken POST /identity/v2/auth/consent/profile Submit Consent
submitConsentByConsentToken POST /identity/v2/auth/consent Submit Consent with Token
unlinkSocialIdentitiesByAccessToken DELETE /identity/v2/auth/socialidentity Unlink social identities
unlockaccountbyaccesstoken PUT /identity/v2/auth/account/unlock Unlock User
updateAccountByAccessToken PUT /identity/v2/auth/account Update User
updateConsentByAccessToken PUT /identity/v2/auth/consent Update Consent Profile
updateEmail PUT /identity/v2/auth/email Verify Email
verifyPhoneOtp PUT /identity/v2/auth/phone/otp Verify Phone

1 operation(s). Parameters, request bodies and return types are on the User Migration page.

Method HTTP request Description
batchUpload POST /bulk/upsert Batch upload Users

6 operation(s). Parameters, request bodies and return types are on the Webhooks page.

Method HTTP request Description
createWebhookConfiguration POST /v2/manage/webhooks Create webhook configuration
deleteWebhookConfigurationById DELETE /v2/manage/webhooks/{hookId} Delete webhook configuration
getAllEvents GET /v2/manage/webhooks/events List webhook events
getAllWebhooksConfigurations GET /v2/manage/webhooks List webhook configurations
getWebhookConfigurationById GET /v2/manage/webhooks/{hookId} Retrieve webhook configuration
updateWebhookConfigurationById PUT /v2/manage/webhooks/{hookId} Update webhook configuration

8 operation(s). Parameters, request bodies and return types are on the Workflows page.

Method HTTP request Description
addWorkflow POST /v2/manage/workflows Add workflow
deleteWorkflow DELETE /v2/manage/workflows/{workflowId} Delete Workflow
deleteWorkflowVersion DELETE /v2/manage/workflows/{workflowId}/versions/{version} Delete Workflow Version
getAllWorkflows GET /v2/manage/workflows List workflows
getAllWorkflowVersionList GET /v2/manage/workflows/{workflowId}/versions List Workflow Versions
getWorkflowById GET /v2/manage/workflows/{workflowId} Retrieve Workflow
restoreWorkflowVersion PUT /v2/manage/workflows/{workflowId}/versions/{version} Restore Workflow Version
updateWorkflow PUT /v2/manage/workflows/{workflowId} Update Workflow