Module: Descope::Api::V1
- Includes:
- Auth, Management, Session
- Defined in:
- lib/descope/api/v1.rb,
lib/descope/api/v1/auth.rb,
lib/descope/api/v1/session.rb,
lib/descope/api/v1/auth/otp.rb,
lib/descope/api/v1/auth/saml.rb,
lib/descope/api/v1/auth/totp.rb,
lib/descope/api/v1/auth/oauth.rb,
lib/descope/api/v1/management.rb,
lib/descope/api/v1/auth/password.rb,
lib/descope/api/v1/auth/magiclink.rb,
lib/descope/api/v1/management/flow.rb,
lib/descope/api/v1/management/role.rb,
lib/descope/api/v1/management/scim.rb,
lib/descope/api/v1/management/user.rb,
lib/descope/api/v1/management/audit.rb,
lib/descope/api/v1/management/authz.rb,
lib/descope/api/v1/management/common.rb,
lib/descope/api/v1/management/tenant.rb,
lib/descope/api/v1/auth/enchantedlink.rb,
lib/descope/api/v1/management/project.rb,
lib/descope/api/v1/management/password.rb,
lib/descope/api/v1/management/access_key.rb,
lib/descope/api/v1/management/permission.rb,
lib/descope/api/v1/management/sso_settings.rb,
lib/descope/api/v1/management/sso_application.rb
Defined Under Namespace
Modules: Auth, Management, Session
Constant Summary
Constants included from Auth
Constants included from Mixins::Common::EndpointsV2
Mixins::Common::EndpointsV2::PUBLIC_KEY_PATH
Constants included from Mixins::Common::EndpointsV1
Mixins::Common::EndpointsV1::AUTH_SAML_START_PATH, Mixins::Common::EndpointsV1::EXCHANGE_AUTH_ACCESS_KEY_PATH, Mixins::Common::EndpointsV1::GET_SESSION_ENCHANTEDLINK_AUTH_PATH, Mixins::Common::EndpointsV1::GET_SESSION_MAGICLINK_AUTH_PATH, Mixins::Common::EndpointsV1::HISTORY_PATH, Mixins::Common::EndpointsV1::LOGOUT_ALL_PATH, Mixins::Common::EndpointsV1::LOGOUT_PATH, Mixins::Common::EndpointsV1::ME_PATH, Mixins::Common::EndpointsV1::OAUTH_CREATE_REDIRECT_URL_FOR_SIGN_IN_REQUEST_PATH, Mixins::Common::EndpointsV1::OAUTH_CREATE_REDIRECT_URL_FOR_SIGN_UP_REQUEST_PATH, Mixins::Common::EndpointsV1::OAUTH_EXCHANGE_TOKEN_PATH, Mixins::Common::EndpointsV1::OAUTH_START_PATH, Mixins::Common::EndpointsV1::PASSWORD_POLICY_PATH, Mixins::Common::EndpointsV1::REFRESH_TOKEN_PATH, Mixins::Common::EndpointsV1::REPLACE_PASSWORD_PATH, Mixins::Common::EndpointsV1::SAML_EXCHANGE_TOKEN_PATH, Mixins::Common::EndpointsV1::SELECT_TENANT_PATH, Mixins::Common::EndpointsV1::SEND_RESET_PASSWORD_PATH, Mixins::Common::EndpointsV1::SIGN_IN_AUTH_ENCHANTEDLINK_PATH, Mixins::Common::EndpointsV1::SIGN_IN_AUTH_MAGICLINK_PATH, Mixins::Common::EndpointsV1::SIGN_IN_AUTH_OTP_PATH, Mixins::Common::EndpointsV1::SIGN_IN_AUTH_WEBAUTHN_FINISH_PATH, Mixins::Common::EndpointsV1::SIGN_IN_AUTH_WEBAUTHN_START_PATH, Mixins::Common::EndpointsV1::SIGN_IN_PASSWORD_PATH, Mixins::Common::EndpointsV1::SIGN_UP_AUTH_ENCHANTEDLINK_PATH, Mixins::Common::EndpointsV1::SIGN_UP_AUTH_MAGICLINK_PATH, Mixins::Common::EndpointsV1::SIGN_UP_AUTH_OTP_PATH, Mixins::Common::EndpointsV1::SIGN_UP_AUTH_TOTP_PATH, Mixins::Common::EndpointsV1::SIGN_UP_AUTH_WEBAUTHN_FINISH_PATH, Mixins::Common::EndpointsV1::SIGN_UP_AUTH_WEBAUTHN_START_PATH, Mixins::Common::EndpointsV1::SIGN_UP_OR_IN_AUTH_ENCHANTEDLINK_PATH, Mixins::Common::EndpointsV1::SIGN_UP_OR_IN_AUTH_MAGICLINK_PATH, Mixins::Common::EndpointsV1::SIGN_UP_OR_IN_AUTH_OTP_PATH, Mixins::Common::EndpointsV1::SIGN_UP_OR_IN_AUTH_WEBAUTHN_START_PATH, Mixins::Common::EndpointsV1::SIGN_UP_PASSWORD_PATH, Mixins::Common::EndpointsV1::UPDATE_AUTH_WEBAUTHN_FINISH_PATH, Mixins::Common::EndpointsV1::UPDATE_AUTH_WEBAUTHN_START_PATH, Mixins::Common::EndpointsV1::UPDATE_PASSWORD_PATH, Mixins::Common::EndpointsV1::UPDATE_TOTP_PATH, Mixins::Common::EndpointsV1::UPDATE_USER_EMAIL_ENCHANTEDLINK_PATH, Mixins::Common::EndpointsV1::UPDATE_USER_EMAIL_MAGICLINK_PATH, Mixins::Common::EndpointsV1::UPDATE_USER_EMAIL_OTP_PATH, Mixins::Common::EndpointsV1::UPDATE_USER_PHONE_MAGICLINK_PATH, Mixins::Common::EndpointsV1::UPDATE_USER_PHONE_OTP_PATH, Mixins::Common::EndpointsV1::VALIDATE_SESSION_PATH, Mixins::Common::EndpointsV1::VERIFY_CODE_AUTH_PATH, Mixins::Common::EndpointsV1::VERIFY_ENCHANTEDLINK_AUTH_PATH, Mixins::Common::EndpointsV1::VERIFY_MAGICLINK_AUTH_PATH, Mixins::Common::EndpointsV1::VERIFY_TOTP_PATH
Constants included from Mixins::Common
Mixins::Common::COOKIE_DATA_NAME, Mixins::Common::DEFAULT_BASE_URL, Mixins::Common::DEFAULT_JWT_VALIDATION_LEEWAY, Mixins::Common::DEFAULT_TIMEOUT_SECONDS, Mixins::Common::PHONE_REGEX, Mixins::Common::REDIRECT_LOCATION_COOKIE_NAME, Mixins::Common::REFRESH_SESSION_COOKIE_NAME, Mixins::Common::REFRESH_SESSION_TOKEN_NAME, Mixins::Common::SESSION_COOKIE_NAME, Mixins::Common::SESSION_TOKEN_NAME
Constants included from Management::Common
Management::Common::ACCESS_KEYS_SEARCH_PATH, Management::Common::ACCESS_KEY_ACTIVATE_PATH, Management::Common::ACCESS_KEY_CREATE_PATH, Management::Common::ACCESS_KEY_DEACTIVATE_PATH, Management::Common::ACCESS_KEY_DELETE_PATH, Management::Common::ACCESS_KEY_LOAD_PATH, Management::Common::ACCESS_KEY_UPDATE_PATH, Management::Common::AUDIT_CREATE_EVENT, Management::Common::AUDIT_SEARCH, Management::Common::AUTHZ_NS_DELETE, Management::Common::AUTHZ_NS_SAVE, Management::Common::AUTHZ_RD_DELETE, Management::Common::AUTHZ_RD_SAVE, Management::Common::AUTHZ_RE_CREATE, Management::Common::AUTHZ_RE_DELETE, Management::Common::AUTHZ_RE_DELETE_RESOURCES, Management::Common::AUTHZ_RE_HAS_RELATIONS, Management::Common::AUTHZ_RE_RESOURCE, Management::Common::AUTHZ_RE_TARGETS, Management::Common::AUTHZ_RE_TARGET_ALL, Management::Common::AUTHZ_RE_WHO, Management::Common::AUTHZ_SCHEMA_DELETE, Management::Common::AUTHZ_SCHEMA_LOAD, Management::Common::AUTHZ_SCHEMA_SAVE, Management::Common::FLOW_EXPORT_PATH, Management::Common::FLOW_IMPORT_PATH, Management::Common::FLOW_LIST_PATH, Management::Common::GROUP_LOAD_ALL_FOR_MEMBER_PATH, Management::Common::GROUP_LOAD_ALL_GROUP_MEMBERS_PATH, Management::Common::GROUP_LOAD_ALL_PATH, Management::Common::PASSWORD_SETTINGS_PATH, Management::Common::PERMISSION_CREATE_PATH, Management::Common::PERMISSION_DELETE_PATH, Management::Common::PERMISSION_LOAD_ALL_PATH, Management::Common::PERMISSION_UPDATE_PATH, Management::Common::PROJECT_CLONE, Management::Common::PROJECT_DELETE_PATH, Management::Common::PROJECT_EXPORT_PATH, Management::Common::PROJECT_IMPORT_PATH, Management::Common::PROJECT_UPDATE_NAME, Management::Common::ROLE_CREATE_PATH, Management::Common::ROLE_DELETE_PATH, Management::Common::ROLE_LOAD_ALL_PATH, Management::Common::ROLE_SEARCH_PATH, Management::Common::ROLE_UPDATE_PATH, Management::Common::SCIM_GROUPS_PATH, Management::Common::SCIM_RESOURCE_TYPES_PATH, Management::Common::SCIM_SERVICE_PROVIDER_CONFIG_PATH, Management::Common::SCIM_USERS_PATH, Management::Common::SSO_APPLICATION_DELETE_PATH, Management::Common::SSO_APPLICATION_LOAD_ALL_PATH, Management::Common::SSO_APPLICATION_LOAD_PATH, Management::Common::SSO_APPLICATION_OIDC_CREATE_PATH, Management::Common::SSO_APPLICATION_OIDC_UPDATE_PATH, Management::Common::SSO_APPLICATION_SAML_CREATE_PATH, Management::Common::SSO_APPLICATION_SAML_UPDATE_PATH, Management::Common::SSO_CONFIGURE_OIDC_SETTINGS_PATH, Management::Common::SSO_CONFIGURE_SAML_METADATA_PATH, Management::Common::SSO_CONFIGURE_SAML_SETTINGS_PATH, Management::Common::SSO_LOAD_SETTINGS_PATH, Management::Common::SSO_MAPPING_PATH, Management::Common::SSO_METADATA_PATH, Management::Common::SSO_OIDC_PATH, Management::Common::SSO_SETTINGS_PATH, Management::Common::TENANT_CREATE_PATH, Management::Common::TENANT_DELETE_PATH, Management::Common::TENANT_LOAD_ALL_PATH, Management::Common::TENANT_LOAD_PATH, Management::Common::TENANT_SEARCH_ALL_PATH, Management::Common::TENANT_UPDATE_PATH, Management::Common::TEST_USERS_SEARCH_PATH, Management::Common::TEST_USER_CREATE_PATH, Management::Common::THEME_EXPORT_PATH, Management::Common::THEME_IMPORT_PATH, Management::Common::UPDATE_JWT_PATH, Management::Common::USERS_SEARCH_PATH, Management::Common::USER_ADD_ROLE_PATH, Management::Common::USER_ADD_TENANT_PATH, Management::Common::USER_CREATE_BATCH_PATH, Management::Common::USER_CREATE_PATH, Management::Common::USER_DELETE_ALL_TEST_USERS_PATH, Management::Common::USER_DELETE_PATH, Management::Common::USER_EXPIRE_PASSWORD_PATH, Management::Common::USER_GENERATE_EMBEDDED_LINK_PATH, Management::Common::USER_GENERATE_ENCHANTED_LINK_FOR_TEST_PATH, Management::Common::USER_GENERATE_MAGIC_LINK_FOR_TEST_PATH, Management::Common::USER_GENERATE_OTP_FOR_TEST_PATH, Management::Common::USER_GET_PROVIDER_TOKEN, Management::Common::USER_LOAD_PATH, Management::Common::USER_LOGOUT_PATH, Management::Common::USER_PATCH_PATH, Management::Common::USER_REMOVE_ROLE_PATH, Management::Common::USER_REMOVE_TENANT_PATH, Management::Common::USER_SEARCH_PATH, Management::Common::USER_SET_ACTIVE_PASSWORD_PATH, Management::Common::USER_SET_PASSWORD_PATH, Management::Common::USER_SET_TEMPORARY_PASSWORD_PATH, Management::Common::USER_UPDATE_CUSTOM_ATTRIBUTE_PATH, Management::Common::USER_UPDATE_EMAIL_PATH, Management::Common::USER_UPDATE_LOGIN_ID_PATH, Management::Common::USER_UPDATE_NAME_PATH, Management::Common::USER_UPDATE_PATH, Management::Common::USER_UPDATE_PHONE_PATH, Management::Common::USER_UPDATE_PICTURE_PATH, Management::Common::USER_UPDATE_STATUS_PATH
Method Summary
Methods included from Auth
#exchange_access_key, #generate_jwt_response, #select_tenant, #validate_permissions, #validate_roles, #validate_tenant_permissions, #validate_tenant_roles, #validate_token
Methods included from Auth::TOTP
#totp_add_update_key, #totp_sign_in_code, #totp_sign_up
Methods included from Mixins::Validation
#validate_code, #validate_email, #validate_login_id, #validate_password, #validate_phone, #validate_redirect_url, #validate_refresh_token_not_nil, #validate_scim_group_id, #validate_tenant, #validate_tenants, #validate_token_not_empty, #validate_user_id, #verify_provider
Methods included from Mixins::Common
#deep_copy, #get_method_string
Methods included from Auth::SAML
#saml_exchange_token, #saml_sign_in
Methods included from Auth::OTP
#otp_sign_in, #otp_sign_up, #otp_sign_up_or_in, #otp_update_user_email, #otp_update_user_phone, #otp_verify_code
Methods included from Auth::OAuth
#oauth_create_redirect_url_for_sign_in_request, #oauth_create_redirect_url_for_sign_up_request, #oauth_exchange_token, #oauth_start
Methods included from Auth::MagicLink
#magiclink_sign_in, #magiclink_sign_up, #magiclink_sign_up_or_in, #magiclink_update_user_email, #magiclink_update_user_phone, #magiclink_verify_token
Methods included from Auth::EnchantedLink
#enchanted_link_get_session, #enchanted_link_sign_in, #enchanted_link_sign_up, #enchanted_link_sign_up_or_in, #enchanted_link_update_user_email, #enchanted_link_verify_token
Methods included from Auth::Password
#get_password_policy, #password_replace, #password_reset, #password_sign_in, #password_sign_up, #password_update
Methods included from Session
#history, #me, #refresh_session, #sign_out, #sign_out_all, #token_validation_key, #validate_and_refresh_session, #validate_session
Methods included from Management::Password
#get_password_settings, #update_password_settings
Methods included from Management::Common
#associated_tenants_to_hash_array
Methods included from Management::SCIM
#scim_create_group, #scim_create_user, #scim_delete_group, #scim_delete_user, #scim_load_group, #scim_load_resource_types, #scim_load_service_provider_config, #scim_load_user, #scim_patch_group, #scim_patch_user, #scim_search_groups, #scim_search_users, #scim_update_group, #scim_update_user
Methods included from Management::SSOSettings
#configure_sso_oidc, #configure_sso_saml, #configure_sso_saml_metadata, #delete_sso_settings, #get_sso_settings
Methods included from Management::SSOApplication
#create_saml_application, #create_sso_oidc_app, #delete_sso_app, #load_all_sso_apps, #load_sso_app, #update_saml_application, #update_sso_oidc_app
Methods included from Management::Audit
#audit_create_event, #audit_search
Methods included from Management::Authz
#authz_create_relations, #authz_delete_namespace, #authz_delete_relation_definition, #authz_delete_relations, #authz_delete_relations_for_resources, #authz_delete_schema, #authz_has_relations?, #authz_load_schema, #authz_resource_relations, #authz_save_namespace, #authz_save_relation_definition, #authz_save_schema, #authz_target_relations, #authz_what_can_target_access?, #authz_who_can_access?
Methods included from Management::Project
#clone_project, #delete_project, #export_project, #import_project, #rename_project
Methods included from Management::Role
#create_role, #delete_role, #load_all_roles, #search_roles, #update_role
Methods included from Management::Permission
#create_permission, #delete_permission, #load_all_permissions, #update_permission
Methods included from Management::Tenant
#create_tenant, #delete_tenant, #load_all_tenants, #load_tenant, #search_all_tenants, #update_tenant
Methods included from Management::AccessKey
#access_key_compose_create_body, #activate_access_key, #create_access_key, #deactivate_access_key, #delete_access_key, #load_access_key, #search_all_access_keys, #update_access_key
Methods included from Management::Flow
#export_flow, #export_theme, #import_flow, #import_theme, #list_or_search_flows
Methods included from Management::User
#activate, #add_tenant_role, #create_batch_users, #create_test_user, #create_user, #deactivate, #delete_all_test_users, #delete_user, #expire_password, #generate_embedded_link, #generate_enchanted_link_for_test_user, #generate_magic_link_for_test_user, #generate_otp_for_test_user, #get_provider_token, #invite_user, #load_by_user_id, #load_user, #logout_user, #logout_user_by_id, #map_to_values_object, #patch_user, #search_all_test_users, #search_all_users, #set_active_password, #set_password, #set_temporary_password, #update_custom_attribute, #update_display_name, #update_email, #update_jwt, #update_login_id, #update_phone, #update_picture, #update_user, #user_add_roles, #user_add_tenant, #user_remove_roles, #user_remove_tenant, #user_remove_tenant_roles