Module: Descope::Api::V1::Management

Includes:

AccessKey, Audit, Authz, Common, Flow, Password, Permission, Project, Role, SCIM, SSOApplication, SSOSettings, Tenant, User

Included in:

Descope::Api::V1

Defined in:

lib/descope/api/v1/management.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/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

Overview

Holds all the management API calls

Defined Under Namespace

Modules: AccessKey, Audit, Authz, Common, Flow, Password, Permission, Project, Role, SCIM, SSOApplication, SSOSettings, Tenant, User

Constant Summary

Constants included from Common

Common::ACCESS_KEYS_SEARCH_PATH, Common::ACCESS_KEY_ACTIVATE_PATH, Common::ACCESS_KEY_CREATE_PATH, Common::ACCESS_KEY_DEACTIVATE_PATH, Common::ACCESS_KEY_DELETE_PATH, Common::ACCESS_KEY_LOAD_PATH, Common::ACCESS_KEY_UPDATE_PATH, Common::AUDIT_CREATE_EVENT, Common::AUDIT_SEARCH, Common::AUTHZ_NS_DELETE, Common::AUTHZ_NS_SAVE, Common::AUTHZ_RD_DELETE, Common::AUTHZ_RD_SAVE, Common::AUTHZ_RE_CREATE, Common::AUTHZ_RE_DELETE, Common::AUTHZ_RE_DELETE_RESOURCES, Common::AUTHZ_RE_HAS_RELATIONS, Common::AUTHZ_RE_RESOURCE, Common::AUTHZ_RE_TARGETS, Common::AUTHZ_RE_TARGET_ALL, Common::AUTHZ_RE_WHO, Common::AUTHZ_SCHEMA_DELETE, Common::AUTHZ_SCHEMA_LOAD, Common::AUTHZ_SCHEMA_SAVE, Common::FLOW_EXPORT_PATH, Common::FLOW_IMPORT_PATH, Common::FLOW_LIST_PATH, Common::GROUP_LOAD_ALL_FOR_MEMBER_PATH, Common::GROUP_LOAD_ALL_GROUP_MEMBERS_PATH, Common::GROUP_LOAD_ALL_PATH, Common::PASSWORD_SETTINGS_PATH, Common::PERMISSION_CREATE_PATH, Common::PERMISSION_DELETE_PATH, Common::PERMISSION_LOAD_ALL_PATH, Common::PERMISSION_UPDATE_PATH, Common::PROJECT_CLONE, Common::PROJECT_DELETE_PATH, Common::PROJECT_EXPORT_PATH, Common::PROJECT_IMPORT_PATH, Common::PROJECT_UPDATE_NAME, Common::ROLE_CREATE_PATH, Common::ROLE_DELETE_PATH, Common::ROLE_LOAD_ALL_PATH, Common::ROLE_SEARCH_PATH, Common::ROLE_UPDATE_PATH, Common::SCIM_GROUPS_PATH, Common::SCIM_RESOURCE_TYPES_PATH, Common::SCIM_SERVICE_PROVIDER_CONFIG_PATH, Common::SCIM_USERS_PATH, Common::SSO_APPLICATION_DELETE_PATH, Common::SSO_APPLICATION_LOAD_ALL_PATH, Common::SSO_APPLICATION_LOAD_PATH, Common::SSO_APPLICATION_OIDC_CREATE_PATH, Common::SSO_APPLICATION_OIDC_UPDATE_PATH, Common::SSO_APPLICATION_SAML_CREATE_PATH, Common::SSO_APPLICATION_SAML_UPDATE_PATH, Common::SSO_CONFIGURE_OIDC_SETTINGS_PATH, Common::SSO_CONFIGURE_SAML_METADATA_PATH, Common::SSO_CONFIGURE_SAML_SETTINGS_PATH, Common::SSO_LOAD_SETTINGS_PATH, Common::SSO_MAPPING_PATH, Common::SSO_METADATA_PATH, Common::SSO_OIDC_PATH, Common::SSO_SETTINGS_PATH, Common::TENANT_CREATE_PATH, Common::TENANT_DELETE_PATH, Common::TENANT_LOAD_ALL_PATH, Common::TENANT_LOAD_PATH, Common::TENANT_SEARCH_ALL_PATH, Common::TENANT_UPDATE_PATH, Common::TEST_USERS_SEARCH_PATH, Common::TEST_USER_CREATE_PATH, Common::THEME_EXPORT_PATH, Common::THEME_IMPORT_PATH, Common::UPDATE_JWT_PATH, Common::USERS_SEARCH_PATH, Common::USER_ADD_ROLE_PATH, Common::USER_ADD_TENANT_PATH, Common::USER_CREATE_BATCH_PATH, Common::USER_CREATE_PATH, Common::USER_DELETE_ALL_TEST_USERS_PATH, Common::USER_DELETE_PATH, Common::USER_EXPIRE_PASSWORD_PATH, Common::USER_GENERATE_EMBEDDED_LINK_PATH, Common::USER_GENERATE_ENCHANTED_LINK_FOR_TEST_PATH, Common::USER_GENERATE_MAGIC_LINK_FOR_TEST_PATH, Common::USER_GENERATE_OTP_FOR_TEST_PATH, Common::USER_GET_PROVIDER_TOKEN, Common::USER_LOAD_PATH, Common::USER_LOGOUT_PATH, Common::USER_PATCH_PATH, Common::USER_REMOVE_ROLE_PATH, Common::USER_REMOVE_TENANT_PATH, Common::USER_SEARCH_PATH, Common::USER_SET_ACTIVE_PASSWORD_PATH, Common::USER_SET_PASSWORD_PATH, Common::USER_SET_TEMPORARY_PASSWORD_PATH, Common::USER_UPDATE_CUSTOM_ATTRIBUTE_PATH, Common::USER_UPDATE_EMAIL_PATH, Common::USER_UPDATE_LOGIN_ID_PATH, Common::USER_UPDATE_NAME_PATH, Common::USER_UPDATE_PATH, Common::USER_UPDATE_PHONE_PATH, Common::USER_UPDATE_PICTURE_PATH, Common::USER_UPDATE_STATUS_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

Method Summary

Methods included from Password

#get_password_settings, #update_password_settings

Methods included from Common

#associated_tenants_to_hash_array

Methods included from 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 SSOSettings

#configure_sso_oidc, #configure_sso_saml, #configure_sso_saml_metadata, #delete_sso_settings, #get_sso_settings

Methods included from 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 Audit

#audit_create_event, #audit_search

Methods included from 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 Project

#clone_project, #delete_project, #export_project, #import_project, #rename_project

Methods included from Role

#create_role, #delete_role, #load_all_roles, #search_roles, #update_role

Methods included from Permission

#create_permission, #delete_permission, #load_all_permissions, #update_permission

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 Tenant

#create_tenant, #delete_tenant, #load_all_tenants, #load_tenant, #search_all_tenants, #update_tenant

Methods included from 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 Flow

#export_flow, #export_theme, #import_flow, #import_theme, #list_or_search_flows

Methods included from 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