Skip to content

Latest commit

 

History

History
865 lines (689 loc) · 54.8 KB

File metadata and controls

865 lines (689 loc) · 54.8 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.

XML documentation ships inside the NuGet package, so your IDE shows each member's description on hover. It does not record which HTTP endpoint a method calls, because that fact lives in the OpenAPI spec rather than in the code. This index closes that gap, and is generated from the spec so it cannot drift from the client.

Call any of these as client.<Service>.<Method>Async(...) — see the service list in the README for the property name of 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