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

Included in:
Descope::Api::V1::Management, AccessKey, Audit, Authz, Flow, Password, Permission, Project, Role, SCIM, SSOApplication, SSOSettings, Tenant, User
Defined in:
lib/descope/api/v1/management/common.rb

Overview

Common Management constants

Constant Summary collapse

TENANT_CREATE_PATH =

tenant

'/v1/mgmt/tenant/create'
TENANT_UPDATE_PATH = 
'/v1/mgmt/tenant/update'
TENANT_DELETE_PATH = 
'/v1/mgmt/tenant/delete'
TENANT_LOAD_PATH = 
'/v1/mgmt/tenant'
TENANT_LOAD_ALL_PATH = 
'/v1/mgmt/tenant/all'
TENANT_SEARCH_ALL_PATH = 
'/v1/mgmt/tenant/search'
PASSWORD_SETTINGS_PATH = 
'/v1/mgmt/password/settings'
USER_CREATE_PATH =

user

'/v1/mgmt/user/create'
TEST_USER_CREATE_PATH = 
'/v1/mgmt/user/create/test'
USER_CREATE_BATCH_PATH = 
'/v1/mgmt/user/create/batch'
USER_UPDATE_PATH = 
'/v1/mgmt/user/update'
USER_DELETE_PATH = 
'/v1/mgmt/user/delete'
USER_LOGOUT_PATH = 
'/v1/mgmt/user/logout'
USER_DELETE_ALL_TEST_USERS_PATH = 
'/v1/mgmt/user/test/delete/all'
USER_LOAD_PATH = 
'/v1/mgmt/user'
USERS_SEARCH_PATH = 
'/v1/mgmt/user/search'
USER_GET_PROVIDER_TOKEN = 
'/v1/mgmt/user/provider/token'
USER_UPDATE_STATUS_PATH = 
'/v1/mgmt/user/update/status'
USER_UPDATE_LOGIN_ID_PATH = 
'/v1/mgmt/user/update/loginid'
USER_UPDATE_EMAIL_PATH = 
'/v1/mgmt/user/update/email'
USER_UPDATE_PHONE_PATH = 
'/v1/mgmt/user/update/phone'
USER_UPDATE_NAME_PATH = 
'/v1/mgmt/user/update/name'
USER_UPDATE_PICTURE_PATH = 
'/v1/mgmt/user/update/picture'
USER_UPDATE_CUSTOM_ATTRIBUTE_PATH = 
'/v1/mgmt/user/update/customAttribute'
USER_ADD_ROLE_PATH = 
'/v1/mgmt/user/update/role/add'
USER_REMOVE_ROLE_PATH = 
'/v1/mgmt/user/update/role/remove'
USER_SET_TEMPORARY_PASSWORD_PATH = 
'/v1/mgmt/user/password/set/temporary'
USER_SET_ACTIVE_PASSWORD_PATH = 
'/v1/mgmt/user/password/set/active'
USER_SET_PASSWORD_PATH = 
'/v1/mgmt/user/password/set'
USER_SEARCH_PATH = 
"/v2/mgmt/user/search"
TEST_USERS_SEARCH_PATH = 
"/v2/mgmt/user/search/test"
USER_EXPIRE_PASSWORD_PATH = 
'/v1/mgmt/user/password/expire'
USER_ADD_TENANT_PATH = 
'/v1/mgmt/user/update/tenant/add'
USER_REMOVE_TENANT_PATH = 
'/v1/mgmt/user/update/tenant/remove'
USER_GENERATE_OTP_FOR_TEST_PATH = 
'/v1/mgmt/tests/generate/otp'

'/v1/mgmt/tests/generate/magiclink'

'/v1/mgmt/tests/generate/enchantedlink'

'/v1/mgmt/user/signin/embeddedlink'
USER_PATCH_PATH = 
'/v1/mgmt/user/patch'
ACCESS_KEY_CREATE_PATH =

access key

'/v1/mgmt/accesskey/create'
ACCESS_KEY_LOAD_PATH = 
'/v1/mgmt/accesskey'
ACCESS_KEYS_SEARCH_PATH = 
'/v1/mgmt/accesskey/search'
ACCESS_KEY_UPDATE_PATH = 
'/v1/mgmt/accesskey/update'
ACCESS_KEY_DEACTIVATE_PATH = 
'/v1/mgmt/accesskey/deactivate'
ACCESS_KEY_ACTIVATE_PATH = 
'/v1/mgmt/accesskey/activate'
ACCESS_KEY_DELETE_PATH = 
'/v1/mgmt/accesskey/delete'
SSO_APPLICATION_OIDC_CREATE_PATH =

sso application

'/v1/mgmt/sso/idp/app/oidc/create'
SSO_APPLICATION_SAML_CREATE_PATH = 
'/v1/mgmt/sso/idp/app/saml/create'
SSO_APPLICATION_OIDC_UPDATE_PATH = 
'/v1/mgmt/sso/idp/app/oidc/update'
SSO_APPLICATION_SAML_UPDATE_PATH = 
'/v1/mgmt/sso/idp/app/saml/update'
SSO_APPLICATION_DELETE_PATH = 
'/v1/mgmt/sso/idp/app/delete'
SSO_APPLICATION_LOAD_PATH = 
'/v1/mgmt/sso/idp/app/load'
SSO_APPLICATION_LOAD_ALL_PATH = 
'/v1/mgmt/sso/idp/apps/load'
SSO_SETTINGS_PATH =

sso settings

'/v2/mgmt/sso/settings'
SSO_METADATA_PATH = 
'/v1/mgmt/sso/metadata'
SSO_MAPPING_PATH = 
'/v1/mgmt/sso/mapping'
SSO_LOAD_SETTINGS_PATH =

v2 only

'/v2/mgmt/sso/settings'
SSO_OIDC_PATH =

configure ssp settings via oidc

'/v1/mgmt/sso/oidc'
SSO_CONFIGURE_OIDC_SETTINGS_PATH = 
'/v1/mgmt/sso/oidc'
SSO_CONFIGURE_SAML_SETTINGS_PATH = 
'/v1/mgmt/sso/saml'
SSO_CONFIGURE_SAML_METADATA_PATH = 
'/v1/mgmt/sso/saml/metadata'
SCIM_GROUPS_PATH =

SCIM

'/scim/v2/Groups'
SCIM_RESOURCE_TYPES_PATH = 
'/scim/v2/ResourceTypes'
SCIM_SERVICE_PROVIDER_CONFIG_PATH = 
'/scim/v2/ServiceProviderConfig'
SCIM_USERS_PATH = 
'/scim/v2/Users'
UPDATE_JWT_PATH =

jwt

'/v1/mgmt/jwt/update'
PERMISSION_CREATE_PATH =

permission

'/v1/mgmt/permission/create'
PERMISSION_UPDATE_PATH = 
'/v1/mgmt/permission/update'
PERMISSION_DELETE_PATH = 
'/v1/mgmt/permission/delete'
PERMISSION_LOAD_ALL_PATH = 
'/v1/mgmt/permission/all'
ROLE_CREATE_PATH =

role

'/v1/mgmt/role/create'
ROLE_UPDATE_PATH = 
'/v1/mgmt/role/update'
ROLE_DELETE_PATH = 
'/v1/mgmt/role/delete'
ROLE_LOAD_ALL_PATH = 
'/v1/mgmt/role/all'
ROLE_SEARCH_PATH = 
'/v1/mgmt/role/search'
FLOW_LIST_PATH =

flow

'/v1/mgmt/flow/list'
FLOW_IMPORT_PATH = 
'/v1/mgmt/flow/import'
FLOW_EXPORT_PATH = 
'/v1/mgmt/flow/export'
THEME_IMPORT_PATH =

theme

'/v1/mgmt/theme/import'
THEME_EXPORT_PATH = 
'/v1/mgmt/theme/export'
GROUP_LOAD_ALL_PATH =

group

'/v1/mgmt/group/all'
GROUP_LOAD_ALL_FOR_MEMBER_PATH = 
'/v1/mgmt/group/member/all'
GROUP_LOAD_ALL_GROUP_MEMBERS_PATH = 
'/v1/mgmt/group/members'
AUDIT_SEARCH =

Audit

'/v1/mgmt/audit/search'
AUDIT_CREATE_EVENT = 
'/v1/mgmt/audit/event'
AUTHZ_SCHEMA_SAVE =

Authz ReBAC

'/v1/mgmt/authz/schema/save'
AUTHZ_SCHEMA_DELETE = 
'/v1/mgmt/authz/schema/delete'
AUTHZ_SCHEMA_LOAD = 
'/v1/mgmt/authz/schema/load'
AUTHZ_NS_SAVE = 
'/v1/mgmt/authz/ns/save'
AUTHZ_NS_DELETE = 
'/v1/mgmt/authz/ns/delete'
AUTHZ_RD_SAVE = 
'/v1/mgmt/authz/rd/save'
AUTHZ_RD_DELETE = 
'/v1/mgmt/authz/rd/delete'
AUTHZ_RE_CREATE = 
'/v1/mgmt/authz/re/create'
AUTHZ_RE_DELETE = 
'/v1/mgmt/authz/re/delete'
AUTHZ_RE_DELETE_RESOURCES = 
'/v1/mgmt/authz/re/deleteresources'
AUTHZ_RE_HAS_RELATIONS = 
'/v1/mgmt/authz/re/has'
AUTHZ_RE_WHO = 
'/v1/mgmt/authz/re/who'
AUTHZ_RE_RESOURCE = 
'/v1/mgmt/authz/re/resource'
AUTHZ_RE_TARGETS = 
'/v1/mgmt/authz/re/targets'
AUTHZ_RE_TARGET_ALL = 
'/v1/mgmt/authz/re/targetall'
PROJECT_UPDATE_NAME =

Project

'/v1/mgmt/project/update/name'
PROJECT_CLONE = 
'/v1/mgmt/project/clone'
PROJECT_EXPORT_PATH = 
'/v1/mgmt/project/export'
PROJECT_IMPORT_PATH = 
'/v1/mgmt/project/import'
PROJECT_DELETE_PATH = 
'/v1/mgmt/project/delete'

Instance Method Summary collapse

Instance Method Details

#associated_tenants_to_hash_array(associated_tenants = []) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/descope/api/v1/management/common.rb', line 144

def associated_tenants_to_hash_array(associated_tenants = [])
  # Represents a tenant association for a User or Access Key. The tenant_id is required to denote
  # which tenant the user or access key belongs to. The role_names array is an optional list of
  # roles for the user or access key in this specific tenant.
  # @param [Array] associated_tenants - list of associated tenants in the format of
  #  [{tenant_id: 'tenant_id', role_names: ['role_name1', 'role_name2']}]
  associated_tenants = associated_tenants.nil? ? [] : associated_tenants
  associated_tenant_list = []
  associated_tenants.each do |tenant|
    associated_tenant_list.append(
      {
        "tenantId": tenant[:tenant_id],
        "roleNames": tenant[:role_names]
      }
    )
  end
  associated_tenant_list
end