{"swagger":"2.0","host":false,"tags":[{"name":"AiAuthoring","description":"Manage the seat association for AI Authoring feature"},{"name":"Ai","description":"Manage the AI brain endpoints"},{"name":"Auth0","description":"General purpose endpoint for anonymous users"},{"name":"Automation","description":"General purpose endpoint for anonymous users"},{"name":"Centralrepo","description":"Manipulates CLOR"},{"name":"Certificates","description":"Manages certificates operations"},{"name":"CertificationsAwards","description":"Manages certifications awards operations"},{"name":"Certifications","description":"Manages certifications operations"},{"name":"Channels","description":"Manipulate the channels "},{"name":"Clickjacking","description":"Enables something"},{"name":"CloudConvert","description":"Enables something"},{"name":"Community","description":"Manages communities."},{"name":"Contentpartnerfields","description":"Manipulates the Content Partner Additional Fields"},{"name":"Contentpartners","description":"Manipulates the Content Partners"},{"name":"Cookie","description":"Manipulates the Content Partners"},{"name":"Cookiepolicy","description":"Manipulate the cookie policy of the LMS"},{"name":"Csm","description":"Manages csm actions"},{"name":"CspHeader","description":"Manages csp source actions"},{"name":"ESignature","description":"Manages E-Signature operations"},{"name":"Elucidat","description":"Descrizione elucidat"},{"name":"EnrollmentRules","description":"LegacyEnrollmentRules."},{"name":"EnrollmentRulesLogs","description":"LegacyEnrollmentRules."},{"name":"Enrollmentfield","description":"Manipulate enrollment fields  \r"},{"name":"Erp","description":"Manage ERP data. Only administrators allowed"},{"name":"EventTracking","description":"Endpoint for event tracking"},{"name":"ExternalApp","description":"Manage the ExternalApp APIs"},{"name":"Externaluser","description":"Associate external users"},{"name":"Feature","description":"Manages feature toggles (only available for OEM-enabled systems)."},{"name":"Featureoptin","description":"Manages opt-in features visibility."},{"name":"Gamification","description":"Manage Gamification"},{"name":"Globalsearch","description":"Globalsearch Controller"},{"name":"GoogleDrive","description":"Manage google drive's actions"},{"name":"Graph","description":"Graph controller"},{"name":"Group","description":"Manages group operations"},{"name":"Impersonate","description":"Manages impersonation operations"},{"name":"Importer","description":"Manages importer CRUD operations"},{"name":"IntegrationLogging","description":"Manage the Integration Logging APIs"},{"name":"Job","description":"Manages Job CRUD operations"},{"name":"Kafka","description":"Manages Kafka operations"},{"name":"Language","description":"Manage Language configuration"},{"name":"LegacyEnrollmentRules","description":"LegacyEnrollmentRules."},{"name":"Manager","description":"Manages notification operations"},{"name":"Mobile","description":"Manages everything that considers the Mobile App\r"},{"name":"Multidomain","description":"Manages multidomain operations"},{"name":"Notification","description":"Manages notification operations\r"},{"name":"Oauth2","description":"Manages OAuth2 clients and their configuration"},{"name":"Objectives","description":"Manage User skill profile"},{"name":"Opengraph","description":"Handle Open Graph markup"},{"name":"Orgchart","description":"Manage branches"},{"name":"Orgchartsync","description":"Manages Job CRUD operations"},{"name":"Player","description":"Player Controller"},{"name":"Plugins","description":"Plugins"},{"name":"Policy","description":"Manipulates the Privacy Policies"},{"name":"Powerusers","description":"Manages power users"},{"name":"Reports","description":"Manage the reports endpoints"},{"name":"Richtextarea","description":"Manipulates Rich Textarea"},{"name":"Screenrecording","description":"Manipulates ScreenRecordingApp"},{"name":"Site","description":"General purpose endpoint for anonymous users  */"},{"name":"Tags","description":"Manipulate the tags"},{"name":"Termsandconditions","description":"Manipulates the Terms & Conditions"},{"name":"Theme","description":"Manage the themes\r"},{"name":"Trails","description":"Manages trail logs"},{"name":"Twofactorauth","description":"Manages Two-Factor Authentication operations"},{"name":"Unsplash","description":"API for fetching and listing photos from Unsplash"},{"name":"Upload","description":"Manage files contents on Amazon S3"},{"name":"User","description":"Manipulates the users"},{"name":"Userfield","description":"Manipulates the User Additional Fields\r"},{"name":"Video","description":"Video Controller  "},{"name":"Webanalyticstool","description":"WebanalyticstoolController"},{"name":"Widget","description":"Widgets Controller"},{"name":"Workforce","description":"Workforce Controller"}],"info":{"title":"Manage","version":"1.0","description":""},"paths":{"/manage/v1/auth0/login":{"post":{"tags":["Auth0"],"operationId":"Auth0./manage/v1/auth0/login","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageAuth0LoginSchema"}}],"summary":"Login and create/optionally/ user, also update info and additional fields data","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageAuth0LoginResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"No user found","1003":"Wrong parameters provided","1004":"No valid Auth0 configuration found","1005":"User update failed","1006":"User not active"}},"500":{"description":"Internal server error"}}}},"/manage/v1/auth0/settings":{"get":{"tags":["Auth0"],"operationId":"Auth0./manage/v1/auth0/settings","parameters":[{"in":"query","name":"id_multidomain","type":"integer","required":false,"description":"id of desired multidomain /if any/"}],"summary":"Get settings for Auth0 app","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageAuth0SettingsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters"}},"500":{"description":"Internal server error"}}}},"/manage/v1/centralrepo/get_categories":{"get":{"tags":["Centralrepo"],"operationId":"Centralrepo./manage/v1/centralrepo/get_categories","parameters":[{"in":"query","name":"node_id","type":"integer","required":false,"description":"ID of the currently selected category, if not set, the root is selected"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. Default to the platform setting for pagination"}],"summary":"Return the list of the CLOR categories with additional info","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageCentralrepoGetCategoriesResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid current category ID"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/centralrepo/get_imported_objects":{"get":{"tags":["Centralrepo"],"operationId":"Centralrepo./manage/v1/centralrepo/get_imported_objects","parameters":[{"in":"query","name":"provider_id","type":"integer","required":false,"description":"Internal ID for the desired CSP. If left blank, all objects linked to a CSP will be returned"}],"summary":"Get a list of already imported LTI objects for a specific CSP or all CSP's.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageCentralrepoGetImportedObjectsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Parameter 'provider_id' refers to an invalid catalog"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/channels/{id}":{"put":{"tags":["Channels"],"operationId":"Channels./manage/v1/channels/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageChannelsUpdateSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the channel"}],"summary":"Update Channel Details","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageChannelsUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Channel not found!","1002":"Missing parameter description"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/channels":{"get":{"tags":["Channels"],"operationId":"Channels./manage/v1/channels","parameters":[{"in":"query","name":"search","type":"string","required":false,"description":"Search channels by specific key"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default: platform dependant"},{"in":"query","name":"ignore_system_channels","type":"integer","required":false,"description":"Ignore system channels - 1, Include system channels - 0; Default: 1"},{"in":"query","name":"count_user","type":"integer","required":false,"description":"Return channel users count - 1, No channels users count - 0; Default: 0"},{"in":"query","name":"include_ai_channels","type":"integer","required":false,"description":"Return AI channels if profiled - 1, No AI channels - 0; Default: 0"},{"in":"query","name":"hide_empty_channels","type":"boolean","required":false,"description":"If true, show only channels that have content"},{"in":"query","name":"only_followed_channels","type":"boolean","required":false,"description":"If true, show only channels that are followed by me"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"channel_ids","type":"array","required":false,"description":"The array containing channel IDs"}],"summary":"List of visible channels","last_modified_date":"2023.10.11","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageChannelsViewChannelsToUserResponse"}},"400":{"description":"General Error","error_codes":{"1003":"Invalid parameter: channel_ids"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/clickjacking/status":{"put":{"tags":["Clickjacking"],"operationId":"Clickjacking./manage/v1/clickjacking/status","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageClickjackingToggleStatusSchema"}}],"summary":"Toggle Clickjacking enable status","last_modified_date":"2024.09.11","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageClickjackingToggleStatusResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter: enabled","1002":"Invalid parameter: enabled"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Clickjacking"],"operationId":"Clickjacking./manage/v1/clickjacking/status","parameters":[],"summary":"Returns the status of clickjacking","last_modified_date":"2024.09.11","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageClickjackingViewStatusResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/clickjacking/whitelist":{"get":{"tags":["Clickjacking"],"operationId":"Clickjacking./manage/v1/clickjacking/whitelist","parameters":[],"summary":"Returns the domains of clickjacking","last_modified_date":"2024.09.11","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageClickjackingWhitelistResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Clickjacking"],"operationId":"Clickjacking./manage/v1/clickjacking/whitelist","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageClickjackingDeleteWhitelistSchema"}}],"summary":"Clears the whitelisted domains or deletes one or more domains from whitelist","last_modified_date":"2024.09.11","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageClickjackingDeleteWhitelistResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Wrong whitelist format"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Clickjacking"],"operationId":"Clickjacking./manage/v1/clickjacking/whitelist","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageClickjackingSetWhitelistSchema"}}],"summary":"Sets the list of domains allowed by clickjacking prevention","last_modified_date":"2024.09.11","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageClickjackingSetWhitelistResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter: whitelist","1002":"Wrong whitelist format"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"post":{"tags":["Clickjacking"],"operationId":"Clickjacking./manage/v1/clickjacking/whitelist","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageClickjackingUpdateWhitelistSchema"}}],"summary":"Updates the existing list of domains allowed by clickjacking prevention","last_modified_date":"2024.09.11","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageClickjackingUpdateWhitelistResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter: whitelist","1002":"Wrong whitelist format"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/contentpartnerfields":{"post":{"tags":["Contentpartnerfields"],"operationId":"Contentpartnerfields./manage/v1/contentpartnerfields","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageContentpartnerfieldsCreateSchema"}}],"summary":"Create user field","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnerfieldsCreateResponse"}},"400":{"description":"General Error","error_codes":{"1100":"You don't have permissions for this action.","1101":"Missing parameter - type.","1102":"Invalid parameter - type.","1103":"Missing parameter - translations.","1104":"Please provide translation on system default language.","1105":"Missing parameter - dropdown_options.","1106":"Invalid parameter - dropdown_options.","1107":"Parameters 'url, field_name' are mandatory for field type 'iframe'","1108":"Invalid parameter - customizable.","1109":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Contentpartnerfields"],"operationId":"Contentpartnerfields./manage/v1/contentpartnerfields","parameters":[{"in":"query","name":"id_partner","type":"integer","required":false,"description":"Filter user additional fields by user ID. If  it is passed and branch_ids is not not passed, the branches of requested user will be taken."},{"in":"query","name":"as_array","type":"integer","required":false,"description":"If it is not passed the responce will be simplified paginated list. If it is passed the responce will contains fully filled list (drop down with options, filled countries, etc.)"},{"in":"query","name":"skip_all","type":"integer","required":false,"description":"Set this parameter to 1 in cases when the condition is to return empty array if the requested branch has no visibility set, instead of an array with all fields."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"search_text","type":"array","required":false,"description":"Search text in the user field title. Default empty array. OR is performed among multiple array items"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id. Options: title, id"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 200"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"in":"query","name":"get_total_count","type":"integer","required":false,"description":"If 1 the count of found items will be returned. Options: 0, 1 default 0"},{"in":"query","name":"multidomain","type":"integer","required":false,"description":"If 1 and no folder was send it will check also for the multidomain specific folder assigned fields. Options: 0, 1 default 0"}],"summary":"Retrieves the list of partner additional fields, filtered on input parameters","last_modified_date":"","description":"All filter parameters are optional. If filter parameters are provided operation is OR for partner_field_title and AND among other parameters","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnerfieldsIndexResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Please provide valid partner id.","1002":"Invalid parameter type"}},"500":{"description":"Internal server error"}}}},"/manage/v1/contentpartnerfields/{field_id}":{"delete":{"tags":["Contentpartnerfields"],"operationId":"Contentpartnerfields./manage/v1/contentpartnerfields/{field_id}","parameters":[{"in":"path","name":"field_id","type":"integer","required":true,"description":"Id of selected field."}],"summary":"Deletes one partner field","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnerfieldsDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1090":"Invalid parameter - id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Contentpartnerfields"],"operationId":"Contentpartnerfields./manage/v1/contentpartnerfields/{field_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageContentpartnerfieldsUpdateSchema"}},{"in":"path","name":"field_id","type":"integer","required":true,"description":"Id of selected field."}],"summary":"Update user fields","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnerfieldsUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Additional field with id: idNum dosn\\'t exist.","1003":"Please provide field name","1004":"Error.","1006":"Please provide valid type","1108":"Invalid parameter - customizable.","1109":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Contentpartnerfields"],"operationId":"Contentpartnerfields./manage/v1/contentpartnerfields/{field_id}","parameters":[{"in":"path","name":"field_id","type":"integer","required":true,"description":"Id of selected field."}],"summary":"Get User addtional filds info","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnerfieldsViewResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Additional field with id 7777 doesn't exist"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/contentpartners/{id}":{"delete":{"tags":["Contentpartners"],"operationId":"Contentpartners./manage/v1/contentpartners/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"Tag id"}],"summary":"Delete content partner","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnersDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Partner not found!","1002":"Partner was not Deleted!"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Contentpartners"],"operationId":"Contentpartners./manage/v1/contentpartners/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageContentpartnersUpdateSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"Id of selected Content Partner."}],"summary":"Update specific Content Partner","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnersUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter","1002":"Invalid ContentPartner","1003":"Content Partner ID is required","1004":"Failed to update the object for unknown reason.","1005":"Discount has to be an integer"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Contentpartners"],"operationId":"Contentpartners./manage/v1/contentpartners/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"contentpartner id"}],"summary":"View Content Partner","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnersViewResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Partner not found!","1002":"Plugin is not active!"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/contentpartners":{"get":{"tags":["Contentpartners"],"operationId":"Contentpartners./manage/v1/contentpartners","parameters":[{"in":"query","name":"cursor","type":"string","required":false,"description":"For pagination"},{"in":"query","enum":["id","name_sort","code","discount"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 20"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to search in content partners name"},{"in":"query","name":"active","type":"boolean","required":false,"description":"Filters the list by active and non-active content partners. If passed as true, the result contains only active content partners and if passed as false - non-active."}],"summary":"Get the content partners","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnersListResponse"}},"400":{"description":"General Error","error_codes":{"1002":"App is not active","1003":"Invalid parameter"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/contentpartners/{partner_id}/courses":{"get":{"tags":["Contentpartners"],"operationId":"Contentpartners./manage/v1/contentpartners/{partner_id}/courses","parameters":[{"in":"path","name":"partner_id","type":"integer","required":true,"description":"Content Partner id"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used for the branch names. Default - Platform default language"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - first_name. Options: affiliate_since, item_name, type_order"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 20"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to search in branch name, group name, first name, last name and username of the affiliates"},{"in":"query","name":"filters","type":"string","required":false,"description":"serialize object containing list of filters and their options - ( field:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains} )"}],"summary":"Get the courses of a content partner","last_modified_date":"2024.03.21","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnersCoursesResponse"}},"400":{"description":"General Error","error_codes":{"1000":"ContentPartnersApp is not active","1001":"Missing parameter partner_id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/contentpartners/{partner_id}/affiliates":{"get":{"tags":["Contentpartners"],"operationId":"Contentpartners./manage/v1/contentpartners/{partner_id}/affiliates","parameters":[{"in":"path","name":"partner_id","type":"integer","required":true,"description":"Content Partner id"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used for the branch names. Default - Platform default language"},{"in":"query","enum":["affiliate_since","item_name","type_order"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - affiliate_since. Options: item_name, type_order"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 20"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to search in branch name, group name, first name, last name and username of the affiliates"},{"in":"query","name":"filters","type":"string","required":false,"description":"serialize object containing list of filters and their options - ( field:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains} )"}],"summary":"Get the affiliates of a content partner","last_modified_date":"2024.03.21","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnersAffiliatesResponse"}},"400":{"description":"General Error","error_codes":{"1000":"ContentPartnersApp is not active","1001":"Missing parameter partner_id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"post":{"tags":["Contentpartners"],"operationId":"Contentpartners./manage/v1/contentpartners/{partner_id}/affiliates","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageContentpartnersCreateAffiliatesSchema"}},{"in":"path","name":"partner_id","type":"integer","required":true,"description":"Content Partner ID"}],"summary":"Adds users as a Content Partners affiliates","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnersCreateAffiliatesResponse"}},"400":{"description":"General Error","error_codes":{"1000":"App is not active","1001":"Missing required parameter","1002":"Parameter validation error","1003":"Error when saving changes to database"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/contentpartners/affiliates/{id}":{"delete":{"tags":["Contentpartners"],"operationId":"Contentpartners./manage/v1/contentpartners/affiliates/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"Affiliate id ID"}],"summary":"Delete a content partners affiliated users","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnersDeleteAffiliatesResponse"}},"400":{"description":"General Error","error_codes":{"1000":"App is not active","1001":"Missing required parameter","1002":"Parameter validation error","1003":"Error when saving changes to database"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/contentpartners/affiliation":{"post":{"tags":["Contentpartners"],"operationId":"Contentpartners./manage/v1/contentpartners/affiliation","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageContentpartnersAddAffiliateCodeSchema"}}],"summary":"Adds user as a Content Partners affiliate (if the correct partner code is provided)","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnersAddAffiliateCodeResponse"}},"400":{"description":"General Error","error_codes":{"1000":"App is not active","1001":"Missing required parameter","1002":"Parameter validation error","1003":"Error when saving changes to database"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Contentpartners"],"operationId":"Contentpartners./manage/v1/contentpartners/affiliation","parameters":[{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 20"}],"summary":"Lists all Content Partners affiliations for the current user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnersListUserAffiliationsResponse"}},"400":{"description":"General Error","error_codes":{"1000":"App is not active"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Contentpartners"],"operationId":"Contentpartners./manage/v1/contentpartners/affiliation","parameters":[{"in":"path","name":"affiliation_ids","type":"array","required":true,"description":"Content Partner affiliation ID"}],"summary":"Deletes a Content Partner affiliation for the current user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageContentpartnersDeleteUserAffiliationResponse"}},"400":{"description":"General Error","error_codes":{"1000":"App is not active","1001":"Missing required parameter","1002":"Parameter validation error","1003":"Error when saving changes to database"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/csm/details":{"get":{"tags":["Csm"],"operationId":"Csm./manage/v1/csm/details","parameters":[],"summary":"Get the general csm information for the service availability and parameters for the FE","last_modified_date":"2024.02.15","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageCsmDetailsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/csm/contact-requests":{"post":{"tags":["Csm"],"operationId":"Csm./manage/v1/csm/contact-requests","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageCsmContact-requestsSchema"}}],"summary":"Send CSM contact request via email.","last_modified_date":"2024.02.20","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageCsmContact-requestsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Maximum number of Csm calls reached for the day"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/e-signature/settings":{"get":{"tags":["ESignature"],"operationId":"ESignature./manage/v1/e-signature/settings","parameters":[],"summary":"Get E-Signature settings","last_modified_date":"","description":"Only available when EsignatureApp is on","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageEsignatureGetSettingsResponse"}},"400":{"description":"General Error","error_codes":{"403":"Permission denied"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["ESignature"],"operationId":"ESignature./manage/v1/e-signature/settings","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageEsignatureSaveSettingsSchema"}}],"summary":"Save E-Signature settings","last_modified_date":"","description":"Only available when EsignatureApp is on","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageEsignatureSaveSettingsResponse"}},"400":{"description":"General Error","error_codes":{"403":"Permission denied","1001":"Missing parameter 'enabled'","1002":"Invalid parameter: enabled","1003":"Invalid parameter: auth_types","1004":"At least one authentication type must be enabled"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules":{"get":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules","parameters":[{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. The default size is defined in Advanced Settings page (Set the amount of elements you want to display in each page)"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. 1 is enabled, 0 disabled. Default is 0."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search string to filter enrollment rules by titles."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - title"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"}],"summary":"Get a list of the Enrollment Rules","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1002":"Invalid search text","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"post":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesCreateActionSchema"}}],"summary":"Create a new Enrollment Rule","last_modified_date":"2024.08.12","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesCreateActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1010":"Missing required parameter {title}","1011":"Parameter {title} is too long","1012":"Parameter {code} is too long","1013":"Parameter {title} is too short. Cannot be empty.","1020":"Missing required parameter {audience_type_from}","1021":"Parameter {audience_type_from} has an invalid value","1030":"Missing required parameter {enroll_to}","1031":"Parameter {enroll_to} has an invalid value","1040":"Wrong value in parameter {description}","1041":"Parameter {description} is too long","1199":"DB problem"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules/{enrollment_rule_id}":{"get":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}","parameters":[{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule"}],"summary":"Get a single Enrollment Rule","last_modified_date":"2024.09.13","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesViewActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1010":"Enrollment rule id does not exist","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateActionSchema"}},{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The internal ID of the rule to be updated"}],"summary":"Update an Enrollment Rule","last_modified_date":"2025.02.04","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1001":"Parameter {assignment_type} is empty or has a wrong value","1010":"The Enrollment Rule does not exist","1020":"Missing required parameter {title}","1021":"Parameter {title} is too long","1024":"Parameter {title} cannot be empty","1023":"Parameter {code} is too long","1025":"Parameter {active_status} is invalid","1040":"Wrong value in parameter {description}","1041":"Parameter {description} is too long","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}","parameters":[{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule to be deleted"}],"summary":"Delete an Enrollment Rule","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesDeleteActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1010":"The Enrollment Rule does not exists","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules/{enrollment_rule_id}/status":{"put":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/status","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateStatusActionSchema"}},{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The internal ID of the rule to be updated"}],"summary":"Update the status of an enrollment rule","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateStatusActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1010":"The Enrollment Rule does not exists","1020":"Missing required parameter {enabled}","1021":"Parameter {enabled} not in the range of acceptable values. Accepted values: true, false","1199":"DB Errors."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules/{enrollment_rule_id}/branches":{"put":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/branches","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateBranchActionSchema"}},{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule to be updated"}],"summary":"Update the branches of an Enrollment Rule when the audience_type is set as branch","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateBranchActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1010":"The Enrollment Rule {id} audit type is not set to branch","1020":"Missing required parameter {branches}","1021":"Wrong value in parameter {branches}","1022":"Wrong value for parameter {branches -> selection_status}","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/branches","parameters":[{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. The default size is defined in Advanced Settings page (Set the amount of elements you want to display in each page)"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. 1 is enabled, 0 disabled. Default is 0."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search string to filter enrollment rules by titles."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - title"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"}],"summary":"Get a list of the Branches Associated To An Enrollment Rule","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexBranchActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1001":"the enrollment rule id field is mandatory","1002":"Invalid enrollment rule log id, must be numeric","1003":"Enrollment rule does not exist","1004":"Invalid search text","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/branches","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesDeleteBranchesActionSchema"}},{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule to modify"}],"summary":"Delete the branchs of an Enrollment Rule","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesDeleteBranchesActionResponse"}},"400":{"description":"General Error","error_codes":{"1001":"branch_ids not valid","1002":"select_all not valid","1003":"search_string not valid","1004":"One between branch_ids or select_all must be passed","1005":"All resources must be linked to the enrollment rule","1006":"The Enrollment Rule must have at least one linked resource for selected type to delete","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules/{enrollment_rule_id}/courses":{"put":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/courses","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateCourseActionSchema"}},{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule to modify"}],"summary":"Update the courses of an Enrollment Rule when the enroll_to is set to course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateCourseActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1010":"The Enrollment Rule {id} enroll is not set to course","1020":"Missing required parameter {course_ids}","1021":"Wrong value in parameter {course_ids}","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/courses","parameters":[{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. The default size is defined in Advanced Settings page (Set the amount of elements you want to display in each page)"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. 1 is enabled, 0 disabled. Default is 0."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search string to filter enrollment rules by titles."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - title"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"}],"summary":"Get a list of the Courses Associated To An Enrollment Rule","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexCourseActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1001":"the enrollment rule id field is mandatory","1002":"Invalid enrollment rule log id, must be numeric","1003":"Enrollment rule does not exist","1004":"Invalid search text","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/courses","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesDeleteCourseActionSchema"}},{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule to modify"}],"summary":"Delete the courses of an Enrollment Rule","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesDeleteCourseActionResponse"}},"400":{"description":"General Error","error_codes":{"1001":"course_ids not valid","1002":"select_all not valid","1003":"search_string not valid","1004":"One between course_ids or select_all must be passed","1005":"All resources must be linked to the enrollment rule","1006":"The Enrollment Rule must have at least one linked resource for selected type to delete","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules/{enrollment_rule_id}/groups":{"put":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/groups","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateGroupActionSchema"}},{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule to modify"}],"summary":"Update the groups of an Enrollment Rule when the enroll_to is set to groups","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateGroupActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1010":"The Enrollment Rule {id} audit type is not set to group","1020":"Missing required parameter {group_ids}","1021":"Wrong value in parameter {group_ids}","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/groups","parameters":[{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. The default size is defined in Advanced Settings page (Set the amount of elements you want to display in each page)"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. 1 is enabled, 0 disabled. Default is 0."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search string to filter enrollment rules by titles."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - title. Options: id, title, description."},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"}],"summary":"Get a list of the Groups Associated To An Enrollment Rule","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexGroupActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1001":"the enrollment rule id field is mandatory","1002":"Invalid enrollment rule log id, must be numeric","1003":"Enrollment rule does not exist","1004":"Invalid search text","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/groups","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesDeleteGroupActionSchema"}},{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule to modify"}],"summary":"Delete the groups of an Enrollment Rule","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesDeleteGroupActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1001":"group_ids not valid","1002":"select_all not valid","1003":"search_text not valid","1004":"One between group_ids or select_all must be passed","1005":"All resources must be linked to the enrollment rule","1006":"The Enrollment Rule must have at least one linked resource for selected type to delete","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules/{enrollment_rule_id}/lps":{"put":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/lps","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateLpActionSchema"}},{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule to modify"}],"summary":"Update the learning plans of an Enrollment Rule when the enroll_to is set to Learning plan","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateLpActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1010":"The Enrollment Rule {id} enroll is not set to lp","1020":"Missing required parameter {learning_plan_ids}","1021":"Wrong value in parameter {learning_plan_ids}","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/lps","parameters":[{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. The default size is defined in Advanced Settings page (Set the amount of elements you want to display in each page)"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. 1 is enabled, 0 disabled. Default is 0."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search string to filter learning plans by titles."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - title"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"}],"summary":"Get a list of Learning Plans Associated To An Enrollment Rule","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexLpActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1003":"Enrollment rule does not exist","1004":"Invalid search text","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/lps","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesDeleteLpActionSchema"}},{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule to modify"}],"summary":"Delete the learning plans of an Enrollment Rule when the enroll_to is set to Learning plan","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesDeleteLpActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1001":"learning_plan_ids not valid","1002":"select_all not valid","1003":"search_string not valid","1004":"One between learning_plan_ids or select_all must be passed","1005":"All resources must be linked to the enrollment rule","1006":"The Enrollment Rule must have at least one linked resource for selected type to delete","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules/{enrollment_rule_id}/resources/courses":{"get":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/resources/courses","parameters":[{"in":"path","name":"enrollment_rule_id","type":"string","required":true,"description":"The id of the rule"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. The default size is defined in Advanced Settings page (Set the amount of elements you want to display in each page)"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. 1 is enabled, 0 disabled. Default is 0."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search string to filter enrollment rules by titles."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - title"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"}],"summary":"Get a list of the Courses Not Associated To An Enrollment Rule","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListCourseActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1003":"Enrollment rule does not exist","1004":"Invalid search text","1010":"The Enrollment Rule {enrollment_rule_id} does not have the enroll set to course","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules/{enrollment_rule_id}/resources/lps":{"get":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/resources/lps","parameters":[{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. The default size is defined in Advanced Settings page (Set the amount of elements you want to display in each page)"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. 1 is enabled, 0 disabled. Default is 0."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search string to filter Learning Plans by titles."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - title"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"}],"summary":"Get a list of Learning Plans Not Associated To An Enrollment Rule","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListLpActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1003":"Enrollment rule does not exist","1010":"The Enrollment Rule {enrollment_rule_id} does not have the enroll set to lp","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules/{enrollment_rule_id}/resources/groups":{"get":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/resources/groups","parameters":[{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. The default size is defined in Advanced Settings page (Set the amount of elements you want to display in each page)"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. 1 is enabled, 0 disabled. Default is 0."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search string to filter enrollment rules by titles."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - title. Options: id, title, description."},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"}],"summary":"Get a list of the Groups Not Associated To An Enrollment Rule","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListGroupActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1001":"the enrollment rule id field is mandatory","1002":"Invalid enrollment rule log id, must be numeric","1003":"Enrollment rule does not exist","1004":"Invalid search text","1010":"The Enrollment Rule {enrollment_rule_id} does not have the enroll set to group","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules/{enrollment_rule_id}/resources/notifications":{"get":{"tags":["LegacyEnrollmentRules"],"operationId":"LegacyEnrollmentRules./manage/v1/enrollment_rules/{enrollment_rule_id}/resources/notifications","parameters":[{"in":"path","name":"enrollment_rule_id","type":"integer","required":true,"description":"The id of the rule"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. The default size is defined in Advanced Settings page (Set the amount of elements you want to display in each page)"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. 1 is enabled, 0 disabled. Default is 0."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search string to filter enrollment rules by titles."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - title"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"}],"summary":"Get a list of the Notifications Not Associated To An Enrollment Rule","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListNotificationActionResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1001":"Enrollment rule does not exist","1002":"Invalid search text","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules_logs":{"get":{"tags":["EnrollmentRulesLogs"],"operationId":"EnrollmentRulesLogs./manage/v1/enrollment_rules_logs","parameters":[{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. The default size is defined in Advanced Settings page (Set the amount of elements you want to display in each page)"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. 1 is enabled, 0 disabled. Default is 0."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search string to filter enrollment rules by titles."},{"in":"query","name":"rule_type","type":"string","required":false,"description":"Search logs for rule type"},{"in":"query","name":"rule_log_from","type":"string","required":false,"description":"Search logs from time"},{"in":"query","name":"rule_log_to","type":"string","required":false,"description":"Search logs to time"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - enrollment_rule_id. Options: none (default), date_created, title"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"}],"summary":"Get a list of the Enrollment Rules Logs","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageEnrollmentruleslogsIndexActionResponse"}},"400":{"description":"General Error","error_codes":{"1001":"\"search_text\" invalid input","1002":"\"rule_type\" invalid input","1003":"\"rule_type\" value not allowed","1004":"\"rule_log_from\" invalid input","1005":"\"rule_log_from\" invalid date format","1006":"\"rule_log_from\" The \"to\" date exceed the maximum timespan","1007":"\"rule_log_from\" The \"to\" date is in the future","1008":"\"rule_log_to\" invalid input","1009":"\"rule_log_to\" invalid date format","1051":"Runtime Error - Log not found","1052":"Runtime Error - Rule not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules_logs/{enroll_log_id}":{"get":{"tags":["EnrollmentRulesLogs"],"operationId":"EnrollmentRulesLogs./manage/v1/enrollment_rules_logs/{enroll_log_id}","parameters":[{"in":"path","name":"enroll_log_id","type":"integer","required":true,"description":"The id of the rule log"}],"summary":"Get a list of the Enrollment Rules Logs Items by Enrollment Log","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageEnrollmentruleslogsViewActionResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Enrollment rule log does not exist","1051":"Could not load log from database","1052":"Could not load rule from database"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules_logs/{enroll_log_id}/items":{"get":{"tags":["EnrollmentRulesLogs"],"operationId":"EnrollmentRulesLogs./manage/v1/enrollment_rules_logs/{enroll_log_id}/items","parameters":[{"in":"path","name":"enroll_log_id","type":"integer","required":true,"description":"The id of the rule log"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. The default size is defined in Advanced Settings page (Set the amount of elements you want to display in each page)"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. 1 is enabled, 0 disabled. Default is 0."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - item_log_id. Options: none (default), code, name, rollback_status"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"}],"summary":"Get a list of log items associated to a logs","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageEnrollmentruleslogsViewLogItemsActionResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Enrollment rule log does not exist","1051":"Could not load log from database","1052":"Could not load rule from database"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules_logs/{enroll_log_id}/rollback":{"put":{"tags":["EnrollmentRulesLogs"],"operationId":"EnrollmentRulesLogs./manage/v1/enrollment_rules_logs/{enroll_log_id}/rollback","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageEnrollmentruleslogsRollbackActionSchema"}},{"in":"path","name":"enroll_log_id","type":"integer","required":true,"description":"The id of the resource enrollment log to be updated"}],"summary":"Rollback Enrollment on Rule trigger","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageEnrollmentruleslogsRollbackActionResponse"}},"400":{"description":"General Error","error_codes":{"1001":"\"enroll_log_id\" is mandatory","1002":"Enroll log does not exist","1003":"Rollback already done on Enrollment Log or all his items","1050":"Runtime Error: No Enrollment Log found","1051":"Runtime Error: Could not create background job"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules_logs/{enroll_log_id}/{log_item_id}/rollback":{"put":{"tags":["EnrollmentRulesLogs"],"operationId":"EnrollmentRulesLogs./manage/v1/enrollment_rules_logs/{enroll_log_id}/{log_item_id}/rollback","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageEnrollmentruleslogsRollbackItemActionSchema"}},{"in":"path","name":"enroll_log_id","type":"integer","required":true,"description":"The id of the resource enrollment log to be updated"},{"in":"path","name":"log_item_id","type":"integer","required":true,"description":"The id of the resource enrollment log item to be updated"}],"summary":"Rollback Enrollment on Course or Learning Plan","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageEnrollmentruleslogsRollbackItemActionResponse"}},"400":{"description":"General Error","error_codes":{"1001":"\"log_item_id\" is mandatory","1002":"Log Item does not exist","1003":"Rollback already done on log item","1004":"\"enroll_log_id\" is mandatory","1005":"Enrollment Log does not exist","1050":"Runtime Error: No Log item found","1051":"Runtime Error: Rollback failed"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_rules_logs/massive/rollback":{"post":{"tags":["EnrollmentRulesLogs"],"operationId":"EnrollmentRulesLogs./manage/v1/enrollment_rules_logs/massive/rollback","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageEnrollmentruleslogsMassiveRollbackActionSchema"}}],"summary":"Massive Rollback","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageEnrollmentruleslogsMassiveRollbackActionResponse"}},"400":{"description":"General Error","error_codes":{"1001":"\"enroll_log_ids\" missing, mandatory field","1002":"\"enroll_log_ids\" invalid input, must be array","1003":"\"enroll_log_ids\" if select_all is passed: must not be empty","1004":"\"enroll_log_ids\" contains a rule that does not exist","1005":"\"search_text\" invalid input","1006":"\"rule_type\" invalid input","1007":"\"rule_type\" value not allowed","1008":"\"rule_log_from\" invalid input","1009":"\"rule_log_from\" invalid date format","1019":"\"rule_log_from\" The \"to\" date exceed the maximum timespan","1020":"\"rule_log_from\" The \"to\" date is in the future","1010":"\"rule_log_to\" invalid input","1011":"\"rule_log_to\" invalid date format","1012":"\"un_enroll_courses\" invalid input","1013":"\"avoid_in_progress\" invalid input","1014":"\"avoid_completed\" invalid input","1015":"\"enroll_log_ids\" log does not exist","1016":"\"enroll_log_ids\" rules does not exist","1017":"\"enroll_log_ids\" contains a log that has a rollback in progress","1018":"\"enroll_log_ids\" contains a log that is already rollback","1051":"Runtime Error - Log not found","1052":"Runtime Error - Could not create background job"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_fields":{"post":{"tags":["Enrollmentfield"],"operationId":"Enrollmentfield./manage/v1/enrollment_fields","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageEnrollmentfieldCreateSchema"}}],"summary":"Create enrollment field","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageEnrollmentfieldCreateResponse"}},"400":{"description":"General Error","error_codes":{"1100":"You don't have permissions for this action.","1101":"Missing parameter - type.","1102":"Invalid parameter - type.","1103":"Missing parameter - translations.","1104":"Please provide translation on system default language.","1105":"Missing parameter - dropdown_options.","1106":"Invalid parameter - dropdown_options."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Enrollmentfield"],"operationId":"Enrollmentfield./manage/v1/enrollment_fields","parameters":[{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"enrollment_field_title","type":"array","required":false,"description":"Search text in the enrollment field title. Default empty array. OR is performed among multiple array items"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id. Options: title, id"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 200"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"in":"query","name":"course_id","type":"integer","required":false,"description":"Filter enrollment fields by course or by a list of courses (comma-separated numeric IDs)"},{"in":"query","name":"visible_to_user","type":"boolean","required":false,"description":"Allows you to see only visible fields"},{"in":"query","name":"lp_id","type":"integer","required":false,"description":"Filter enrollment fields by learning plan"}],"summary":"Retrieves the list of Enrollment fields, filtered on input parameters","last_modified_date":"","description":"All filter parameters are optional. If filter parameters are provided operation is OR for enrollment_field_title and AND among other parameters","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageEnrollmentfieldListResponse"}},"400":{"description":"General Error","error_codes":{"1200":"Invalid parameter - lang."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Enrollmentfield"],"operationId":"Enrollmentfield./manage/v1/enrollment_fields","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageEnrollmentfieldMultipleDeleteSchema"}}],"summary":"Deletes more then one enrolment fields","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageEnrollmentfieldMultipleDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1090":"Missing parameter - field_ids."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/enrollment_fields/{field_id}":{"delete":{"tags":["Enrollmentfield"],"operationId":"Enrollmentfield./manage/v1/enrollment_fields/{field_id}","parameters":[{"in":"path","name":"field_id","type":"integer","required":true,"description":"Id of selected field."}],"summary":"Deletes one enrolment field","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageEnrollmentfieldDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1090":"Invalid parameter - id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Enrollmentfield"],"operationId":"Enrollmentfield./manage/v1/enrollment_fields/{field_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageEnrollmentfieldUpdateSchema"}},{"in":"path","name":"field_id","type":"integer","required":true,"description":"Id of selected field."}],"summary":"Update enrollment fields for selected courses","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageEnrollmentfieldUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Additional field with id: idNum dosn\\'t exist.","1003":"Please provide course ids.","1004":"Error.","1005":"Please provide dropdown options"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/erp/url":{"get":{"tags":["Erp"],"operationId":"Erp./manage/v1/erp/url","parameters":[{"in":"query","name":"path","type":"string","required":true,"description":"The full path to be appended after ERP domain"}],"summary":"Generate URL Url by given path and append the params needed for authentication for ERP","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageErpUrlResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/externaluser":{"post":{"tags":["Externaluser"],"operationId":"Externaluser./manage/v1/externaluser","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageExternaluserAssociateExternalUsersSchema"}}],"summary":"Associate a list of external user id and type with the corresponding Docebo users","last_modified_date":"","description":"Userdata is an array, where every item contains a user specification (idst, userid or email)","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageExternaluserAssociateExternalUsersResponse"}},"400":{"description":"General Error","error_codes":{"210":"Invalid user specification"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/feature":{"get":{"tags":["Feature"],"operationId":"Feature./manage/v1/feature","parameters":[{"in":"query","name":"filter_by_name","type":"string","required":false,"description":"Filter by toggle name"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - name. Options: name"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 50"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. 1 is enabled, 0 disabled. Default is 0."}],"summary":"Returns all feature toggles","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageFeatureIndexResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: filter_by_name"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/feature/{feature}":{"put":{"tags":["Feature"],"operationId":"Feature./manage/v1/feature/{feature}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageFeatureToggleSchema"}},{"in":"path","name":"feature","type":"string","required":true,"description":"Name of the feature. It&#039;s possible to enable/disable a branch of features by specifying the partial feature name followed by /\\* (e.g.: toggle/admin/\\*). A trailing slash without &#039;*&#039; (e.g. toggle/foo/, release/foo/, optin/foo/) is treated as a malformed toggle name."}],"summary":"Enables or disables one or more feature toggles","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageFeatureToggleResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter 'is_enabled'","1002":"Invalid parameter: is_enabled","1003":"Invalid feature","1004":"Optin toggles do not support branch operations"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/optin":{"get":{"tags":["Featureoptin"],"operationId":"Featureoptin./manage/v1/optin","parameters":[],"summary":"Returns all persisted opt-in features that have a valid code handler","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageFeatureoptinIndexResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Unable to retrieve opt-in features"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/optin/{featureId}/status":{"put":{"tags":["Featureoptin"],"operationId":"Featureoptin./manage/v1/optin/{featureId}/status","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageFeatureoptinUpdateSchema"}}],"summary":"Updates activation status for one opt-in feature","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageFeatureoptinUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid feature id","1002":"Invalid activation_status parameter","1003":"Feature not found or invalid feature handler","1004":"Unsupported activation_status for this feature","1005":"Feature is not ready and cannot be updated","1006":"Feature is not available on this platform"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/optin/{featureId}":{"put":{"tags":["Featureoptin"],"operationId":"Featureoptin./manage/v1/optin/{featureId}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageFeatureoptinUpdateFeatureSchema"}}],"summary":"Updates persisted opt-in feature properties","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageFeatureoptinUpdateFeatureResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid feature id","1002":"Request payload cannot be empty","1003":"Feature not found, no valid fields provided, or invalid thumbnail type","1004":"Feature is not ready and cannot be updated","1000":"Unable to update opt-in feature"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/gamification/summary":{"get":{"tags":["Gamification"],"operationId":"Gamification./manage/v1/gamification/summary","parameters":[],"summary":"Get Gamification information for the current user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageGamificationSummaryResponse"}},"400":{"description":"General Error","error_codes":{"1002":"GamificationApp not active"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."}}}},"/manage/v1/gamification/reward_requests":{"get":{"tags":["Gamification"],"operationId":"Gamification./manage/v1/gamification/reward_requests","parameters":[{"in":"query","name":"id_user","type":"integer","required":false,"description":"ID of the LMS user"},{"in":"query","enum":["request_date"],"name":"sort_attr","type":"string","required":false,"description":"Sort data by request_date (current only this is available)"}],"summary":"Retrieve gamification reward requests for specific user or currently logged user.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageGamificationRewardRequestsResponse"}},"400":{"description":"General Error","error_codes":{"1002":"GamificationApp not active"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/gamification/badges":{"get":{"tags":["Gamification"],"operationId":"Gamification./manage/v1/gamification/badges","parameters":[{"in":"query","name":"id_user","type":"integer","required":false,"description":"Get badges for specific user."},{"in":"query","name":"only_community_badges","type":"boolean","required":false,"description":"If true, returns only the badges with shows_in_community_profile flag set to true. NOTE: available only when the Community App is active."}],"summary":"Get user assigned badges, grouped by badge (user can have assigned to the same badge multiple times)","last_modified_date":"2024.04.03","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageGamificationBadgesResponse"}},"400":{"description":"General Error","error_codes":{"1002":"GamificationApp not active"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/gamification/leaderboards":{"get":{"tags":["Gamification"],"operationId":"Gamification./manage/v1/gamification/leaderboards","parameters":[{"in":"query","name":"id_user","type":"integer","required":false,"description":"Internal ID of the user. If not provided, current user will be used"},{"in":"query","name":"limit","type":"integer","required":false,"description":"Limit of the user position, with current user position. Default - 5"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Filter by leaderboards name"},{"in":"query","name":"show_inactive","type":"boolean","required":false,"description":"If true, show both active and inactive leaderboards"},{"in":"query","name":"id_leaderboard","type":"integer","required":false,"description":"Show only data of the selected leaderboard"},{"in":"query","name":"segment","type":"integer","required":false,"description":"Reference to a branch ID"},{"in":"query","name":"preview","type":"boolean","required":false,"description":"When set to TRUE, and the current user is SA, positions will be returned for leaderboards with any type of availability/visibility."},{"in":"query","name":"show_anonymous","type":"boolean","required":false,"description":"When set to TRUE and the current user is SA, always return explicit user data even if leaderboard is anonymous"},{"in":"query","name":"hide_positions","type":"boolean","required":false,"description":"If true, hide the positions and my_position items. The following parameters will have no effect: id_user, limit, preview, show_anonymous. Default: false"}],"summary":"Get Leaderboards list with positions of the users, including requested user position","last_modified_date":"2024.11.25","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageGamificationLeaderboardsResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter: {parameter_name}","1002":"GamificationApp not active"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/gamification/contests":{"get":{"tags":["Gamification"],"operationId":"Gamification./manage/v1/gamification/contests","parameters":[{"in":"query","name":"id_user","type":"integer","required":false,"description":"ID of the user. If not provided, current user will be used"},{"in":"query","name":"get_upcoming","type":"integer","required":false,"description":"Get also upcoming contest from now with provided limit; Default 5"}],"summary":"Get user contests that he is part of","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageGamificationContestsResponse"}},"400":{"description":"General Error","error_codes":{"1002":"GamificationApp not active"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/gamification/reward_requests/{id}":{"put":{"tags":["Gamification"],"operationId":"Gamification./manage/v1/gamification/reward_requests/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageGamificationUpdateStatusSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the reward request transaction"}],"summary":"Update gamification reward request status","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageGamificationUpdateStatusResponse"}},"400":{"description":"General Error","error_codes":{"1002":"GamificationApp not active"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"post":{"tags":["Gamification"],"operationId":"Gamification./manage/v1/gamification/reward_requests/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageGamificationSendMessageSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID transaction of the request"}],"summary":"Send message to the user who made the reward request","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageGamificationSendMessageResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/globalsearch/search":{"get":{"tags":["Globalsearch"],"operationId":"Globalsearch./manage/v1/globalsearch/search","parameters":[{"in":"query","name":"criteria","type":"string","required":false,"description":"Text to search"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 200, if value is -1 then all items are returned"},{"in":"query","name":"from","type":"integer","required":false,"description":"like pagination from which item to display. It must be a positive number, default: 0"},{"in":"query","name":"min_score","type":"float","required":false,"description":"Minimal score (relevancy) required. Default: 0"},{"in":"query","name":"search_type","type":"string","required":false,"description":"Type of the search. Can be: &quot;suggestions&quot; or &quot;results&quot;. Default: &quot;results&quot;"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - best-match. Options: titlesort, created, price, best-match"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"g","type":"integer","required":false,"description":"Filter by tab. Options: 1 - My Courses and Learning Plans, 2 - Course Content, 3 - Course catalog, 4 - Knowledge Assets, 5 - Questions and answers, 6 - All entities, 7 - Knowledge Assets and Courses. Default: 6 - returns information for all tabs"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"es","type":"array","required":false,"description":"Filter for Tab My Courses and Learning Plans by status. Options: 1 - Not Started, 2 - In Progress, 3 - Completed. Default: all. It will only work with the &#039;adv&#039; and &#039;g&#039; correctly set"},{"in":"query","name":"deadline","type":"integer","required":false,"description":"Filter for Tab My Courses and Learning Plans by deadline. Options: 0 - All deadlines, 1 - Today, 2 - This Week, 3 - This Month, 4 - This year. Default: all. It will only work with the &#039;adv&#039; and &#039;g&#039; correctly set."},{"in":"query","name":"duration","type":"integer","required":false,"description":"Filter for Tab My Courses and Learning Plans and Tab Knowledge Assets by deadline. Options: 1 - Short(under 5 minutes), 2 - Medium(5-30 minutes), 3 - Long(more then 30 minutes). Default: all. It will only work with the &#039;adv&#039; and &#039;g&#039; correctly set."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"lot","type":"array","required":false,"description":"Filter for Tab Course Content by type. Options: &#039;scormorg&#039;, &#039;test&#039;, &#039;aicc&#039;, &#039;tincan&#039;, &#039;video&#039;, &#039;file&#039;, &#039;deliverable&#039;, &#039;googledrive&#039;, &#039;authoring&#039;, &#039;htmlpage&#039;, &#039;poll&#039;, &#039;lti&#039;. Default: all. It will only work with the &#039;adv&#039; and &#039;g&#039; correctly set."},{"in":"query","name":"created","type":"integer","required":false,"description":"Filter for Tab Knowledge Assets by uploaded date. Options: 0 - Any Time, 1 - Today, 2 - This Week, 3 - This Month, 4 - This year. Default: all. It will only work with the &#039;adv&#039; and &#039;g&#039; correctly set."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"st","type":"array","required":false,"description":"Filter for Tab Knowledge Assets by status. Note: this filter is visible only for super admins. Options: &#039;published&#039;, &#039;review&#039;, &#039;private&#039;. Default: all. It will only work with the &#039;adv&#039; and &#039;g&#039; correctly set."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"kt","type":"array","required":false,"description":"Filter for Tab Knowledge Assets by type. Options: 1 - Videos, 2 - Documents, 3 - Google Drive, 4 - Images, 5 - Links, 6 - PDFs, 7 - Audio, 8 - Others, 9 - Playlists. Default: all. It will only work with the &#039;adv&#039; and &#039;g&#039; correctly set."},{"in":"query","name":"show","type":"string","required":false,"description":"Filter for Tab Questions and Answers that returns questions by this options: &#039;new&#039; - New Questions, &#039;best&#039; - New Best Answers, &#039;open&#039; - Open questions, &#039;my_questions&#039; - My Questions, &#039;my_answers&#039; - My Answers, &#039;follow&#039; - Followed questions. Default - all. It will only work with the &#039;adv&#039; and &#039;g&#039; correctly set."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"type","type":"array","required":false,"description":"For Tab My Courses and Learning Plans, filters courses and learning plans by type. Options: 1 - E-Learning, 3 - Classroom, 4 - Learning Plan. Default: all. For Tab Questions and Answers, filters questions and answers by type. Options: [0] - direct questions, [1] - linked to an asset/course. Default - both. It will only work with the &#039;adv&#039; and &#039;g&#039; correctly set."},{"in":"query","name":"ch","type":"integer","required":false,"description":"Filter items that are found inside the given channels. It will only work with the &#039;adv&#039; and &#039;g&#039; correctly set."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"language","type":"array","required":false,"description":"Filters courses by two letter language code (ISO 639-1 ex: en,it,fr,..). It will only work with the &#039;adv&#039; and &#039;g&#039; correctly set."},{"in":"query","name":"is_paid","type":"integer","required":false,"description":"Filters courses by the selling status. Options 1 - selling content, 0 - not selling content default to all. It will only work with the &#039;adv&#039; and &#039;g&#039; correctly set."},{"in":"query","name":"adv","type":"integer","required":false,"description":"Enable advanced filtering from the other fields. Options 1 - enable, 0 - disable default to 0."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"skill_codes","type":"array","required":false,"description":"Filter items by assigned skill codes. This filter is available only when the Skill application is active."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"epriority","type":"array","required":false,"description":"Enrollment priority. Can be passed only when this attribute is configured in the platform advanced settings. The possible values are &quot;null&quot;, &quot;mandatory&quot;, &quot;required&quot;, &quot;recommended&quot; and &quot;optional&quot;, but to be accepted they must be enabled in the settings. The null value can be used to get enrollments with priority not set"},{"in":"query","name":"has_embedding","type":"boolean","required":false,"description":"Filter items that have embedding. Default: false."}],"summary":"ElasticSearch action","last_modified_date":"2025.06.12","description":"All filter parameters are optional","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageGlobalsearchSearchResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Cannot find ANY super admin!","1002":"Missing 'hits' in elastic search result","1003":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/globalsearch":{"get":{"tags":["Globalsearch"],"operationId":"Globalsearch./manage/v1/globalsearch","parameters":[{"in":"query","name":"criteria","type":"string","required":false,"description":"Text to search"}],"summary":"ElasticSearch Initial action","last_modified_date":"2025.05.13","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageGlobalsearchInitialResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/importer/preset":{"post":{"tags":["Importer"],"operationId":"Importer./manage/v1/importer/preset","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageImporterCreatePresetSchema"}}],"summary":"Create an importer preset","last_modified_date":"2023.09.04","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageImporterCreatePresetResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter","1101":"Invalid parameter: datasource_params","1102":"Invalid parameter: options","1103":"Invalid parameter: mapping","1104":"Name must not be empty","1105":"Type must not b empty"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/importer/preset/{type}":{"get":{"tags":["Importer"],"operationId":"Importer./manage/v1/importer/preset/{type}","parameters":[{"in":"path","name":"type","type":"string","required":true,"description":"The group name"}],"summary":"View importer presets for the selected type","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageImporterViewPresetsResponse"}},"400":{"description":"General Error","error_codes":{"1100":"You don't have permissions for this action.","1101":"Type must not be empty."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/importer/preset/{id}":{"put":{"tags":["Importer"],"operationId":"Importer./manage/v1/importer/preset/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageImporterUpdatePresetSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"Preset ID"}],"summary":"Update an importer preset","last_modified_date":"2023.09.04","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageImporterUpdatePresetResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter","1100":"You don't have permissions for this action.","1101":"Invalid parameter: {type}","1103":"No preset found with given ID","1105":"Invalid record","1106":"You don't have the permissions to access this record"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Importer"],"operationId":"Importer./manage/v1/importer/preset/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"Preset ID"}],"summary":"Delete an importer preset","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageImporterDeletePresetResponse"}},"400":{"description":"General Error","error_codes":{"1100":"You don't have permissions for this action.","1103":"No preset found with given ID","1105":"Invalid record","1106":"You don't have the permissions to access this record"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/importer/get_csv_sample_data":{"get":{"tags":["Importer"],"operationId":"Importer./manage/v1/importer/get_csv_sample_data","parameters":[{"in":"query","name":"filename","type":"string","required":true,"description":"S3 filename of the uploaded CSV. If a path is passed, only the filename will be taken"},{"in":"query","name":"delimiter","type":"string","required":false,"description":"The delimiter used to separate the fields in a row. Default is &quot;,&quot;"},{"in":"query","name":"charset","type":"string","required":true,"description":"The used character set for the CSV file. Supported charsets: &#039;Windows-1252&#039;, &#039;BIG-5&#039; and &#039;UTF-8&#039;"},{"in":"query","name":"skip_first_row","type":"boolean","required":true,"description":"Will the first line contain the column names"}],"summary":"Get a preview for the to be imported CSV file.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageImporterGetCsvSampleDataResponse"}},"400":{"description":"General Error","error_codes":{"1101":"Delimiter must be a single character","1102":"Wrong file type (must be csv)","1103":"General error: {error description}","1104":"Could not read file, check link","1105":"Unsupported character set","1106":"Could not convert string to UTF-8","1107":"File is empty","1108":"Invalid parameter {parameter name}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/importer/download_csv_sample/{type}":{"get":{"tags":["Importer"],"operationId":"Importer./manage/v1/importer/download_csv_sample/{type}","parameters":[{"in":"path","enum":["demo_sample","users_sample","skills_sample","roles_sample","learning_plan_sample","enrollments_single_learning_plan_sample","unenrollments_single_learning_plan_sample","enrollments_multi_learning_plan_sample","unenrollments_multi_learning_plan_sample"],"name":"type","type":"string","required":true,"description":"Type of the CSV sample"}],"summary":"Get CSV Sample URL","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageImporterDownloadCsvSampleResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter","1002":"Invalid parameter: {type}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/job":{"post":{"tags":["Job"],"operationId":"Job./manage/v1/job","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageJobCreateJobSchema"}}],"summary":"Pushes a new background job for immediate handling and execution.","last_modified_date":"2022.07.21","description":"<b>Data Source params, according to the data source type:</b><pre>For type <b>importer</b>, must contain the importer preset with the following structure, used to trigger the import job:{&nbsp;&nbsp;\"type\": \"\",&nbsp;&nbsp;\"datasource_params\": {},&nbsp;&nbsp;\"mapping\": [],&nbsp;&nbsp;\"options\": {}}<div style=\"font-size: 0.9em; line-height: 1.5em; margin-top: -10px\"><b>type</b> (enum) Type of the DataSource parser, possible values (csv_user_import, csv_branch_import, csv_course_import, csv_pu_mapping_import).<b>datasource_params</b> (object) Parameters of the data source, i.e filename, url.<b>mapping</b> (array, optional) List of associative arrays used to map the data source before sending it to be processed.<b>options</b> (array, optional) Additional options that would be sent to the batch API. Can contain <b>select_all</b> (bool, optional) If true will trigger a specific resolver to get the list of items from the database.</div><br />For type <b>api</b>, must contain an object with the following structure:{&nbsp;&nbsp;\"items\": []}<div style=\"font-size: 0.9em; line-height: 1.5em; margin-top: -10px\"><b>items</b> [object, required] List of associative arrays of data to be processed.</div><br />For type <b>polling</b>, can contain the following structure:{&nbsp;&nbsp;\"total_url\": \"\",&nbsp;&nbsp;\"total_url_params\": {},&nbsp;&nbsp;\"chunk_url\": \"\",&nbsp;&nbsp;\"chunk_url_params\": {},&nbsp;&nbsp;\"post_process_chunk_items\": {}}<div style=\"font-size: 0.9em; line-height: 1.5em; margin-top: -10px\"><b>total_url</b> (string, required) URL that would be called with GET verb, to retrieve the total items.<b>total_url_params</b> (object, optional) Object representing additional query params that would be passed to the total_url API.<b>chunk_url</b> (string, required) URL that would be called with GET verb, to retrieve chunk of items (The URL would be called until the SUM of retrieved items from each chunk reaches the total number).<b>chunk_url_params</b> (object, optional) Object representing additional query params that would be passed to the chunk_url API.<b>post_process_chunk_items</b> (object, optional) Object containing attributes to set for each item of every chunk (existing item's attributes would be overridden). After a chunk is retrieved from chunk_url and before it gets sent to destination (endpoint) URL.</div></pre>","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageJobCreateJobResponse"}},"400":{"description":"General Error","error_codes":{"1101":"Invalid Background Job Configuration {parameter_name}","1102":"Invalid user email"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Job"],"operationId":"Job./manage/v1/job","parameters":[{"in":"query","name":"id_author","type":"integer","required":false,"description":"A user ID used to filter returned job records. If not provided, the API will only return jobs belonging to the logged in user."},{"in":"query","name":"status","type":"string","required":false,"description":"A status identifier user to filter jobs. Possible values: &quot;queued&quot;, &quot;running&quot;, &quot;aborted&quot;, &quot;completed&quot;."},{"in":"query","name":"hidden","type":"boolean","required":false,"description":"if set to true, hidden background jobs will be returned too"},{"in":"query","name":"page","type":"integer","required":false,"description":"Determines the page number [job_descriptor pagination] and limits the amount of results to that of the corresponding page."},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default will be the system setting for elements per page"}],"summary":"Returns a paginated array of job descriptors matching the specified filters.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageJobViewJobsResponse"}},"400":{"description":"General Error","error_codes":{"1110":"Invalid Background Job Configuration Parameters"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/job/{hash}":{"delete":{"tags":["Job"],"operationId":"Job./manage/v1/job/{hash}","parameters":[{"in":"path","name":"hash","type":"string","required":true,"description":"Hash of the background job."}],"summary":"Deletes the passed job. This operation is only possible if the job is in the \"aborted\" or \"completed\" state.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageJobDeleteJobResponse"}},"400":{"description":"General Error","error_codes":{"1101":"Unable to delete Job","1103":"Invalid background job state. Only aborted or completed jobs can be deleted"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Job"],"operationId":"Job./manage/v1/job/{hash}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageJobUpdateJobSchema"}},{"in":"path","name":"hash","type":"string","required":true,"description":"Hash of the background job."}],"summary":"Updates a subset of information of a given job.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageJobUpdateJobResponse"}},"400":{"description":"General Error","error_codes":{"1100":"Invalid parameters for an API call","1101":"Unable to update Job","1102":"Invalid job state. Cannot cancel a job in {current_state} state"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Job"],"operationId":"Job./manage/v1/job/{hash}","parameters":[{"in":"path","name":"hash","type":"string","required":true,"description":"Hash of the background job."}],"summary":"Returns the descriptor of the requested job.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageJobViewJobResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers":{"post":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageManagerCreateSchema"}}],"summary":"Creates new manager type","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerCreateResponse"}},"400":{"description":"General Error","error_codes":{"100001":"Missing parameter - title.","0":"Item already exist.","1058":"Generic Internal Operation Error (message will vary according to the actual error)","100009":"You cannot add more than 10 manager types"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageManagerDeleteSchema"}}],"summary":"Deletes the manager type/s","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerDeleteResponse"}},"400":{"description":"General Error","error_codes":{"100001":"Missing parameter - manager_type_ids.","100007":"Cannot delete manager type as it is already in use.","100008":"Not existing manager types","1056":"Generic Internal Operation Error (message will vary according to the actual error)"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers","parameters":[{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - title. Options: title, id"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 200"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"in":"query","name":"active","type":"integer","required":false,"description":"Options: active manager types -&gt; 1, inactive -&gt; 0. If not passed, will return both types."},{"in":"query","name":"get_total_count","type":"integer","required":false,"description":"If 1 the count of found items will be returned. Options: 0, 1 default 0"},{"in":"query","name":"user_id","type":"integer","required":false,"description":"Get all active manager types, managers assigned to the active m.types, and list of subordinates - if passed"},{"in":"query","name":"as_array","type":"integer","required":false,"description":"If it is not passed the response will be simplified paginated list. as_array -&gt; 1 the response will contains fully filled list"},{"in":"query","name":"entire_tree","type":"boolean","required":false,"description":"If true, show the entire tree for the manager"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"manager_type_id","type":"array","required":false,"description":"If passed, filter subordinate based on the manager type"}],"summary":"Returns a paginated list of manager types.","last_modified_date":"","description":"A manager can call this API by passing his user_id in the related parameter.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerListResponse"}},"400":{"description":"General Error","error_codes":{"100005":"Invalid parameter - user_id.","100011":"Invalid parameter - entire_tree.","100012":"Invalid parameter - manager_type_id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/{id}":{"put":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageManagerUpdateSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the manager type."}],"summary":"Updates a manager type.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerUpdateResponse"}},"400":{"description":"General Error","error_codes":{"100001":"Missing parameter - id.","100002":"Invalid parameter - id.","100010":"Manager type cannot be deactivated","1058":"Active must be an integer","1002":"The value for \"title\" is required","1003":"Item already exist."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the manager type."}],"summary":"Returns info for given manager type.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerViewResponse"}},"400":{"description":"General Error","error_codes":{"100002":"Invalid parameter - id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/subordinates":{"get":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/subordinates","parameters":[{"in":"query","name":"search_text","type":"string","required":false,"description":"Search all string fields for this value"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"relation_ids","type":"array","required":false,"description":"Filter by ids of the manager subordinate relation records"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"subordinate_ids","type":"array","required":false,"description":"Filter by ids of the subordinates"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"manager_ids","type":"array","required":false,"description":"Filter by ids of the managers"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"manager_type_ids","type":"array","required":false,"description":"Filter by ids of the manager types"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"manager_type_statuses","type":"array","required":false,"description":"Filter by statuses Possible values (&#039;confirmed&#039;, &#039;not_confirmed&#039;, &#039;pending&#039;, &#039;imported&#039;)"}],"summary":"List all manager subordinate relation records","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerListSubordinatesL2Response"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter relation_ids","1002":"Invalid parameter subordinate_ids","1004":"Invalid parameter manager_ids","1005":"Invalid parameter manager_type_ids","1006":"Invalid parameter manager_type_statuses","1007":"Invalid parameter search_text"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/subordinate/{user_id}":{"get":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/subordinate/{user_id}","parameters":[{"in":"path","name":"user_id","type":"integer","required":true,"description":"The id of the subordinate"},{"in":"query","enum":["relevance"],"name":"sort_attr","type":"string","required":false,"description":""}],"summary":"Retrieves the subordinate information","last_modified_date":"2024.02.26","description":"Only users with manager permission can call this API","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerViewManagerSubordinateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter manager_type_ids"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/subordinates/batch":{"delete":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/subordinates/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageManagerDeleteSubordinateRelationsBatchSchema"}}],"summary":"Delete manager subordinate relations","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerDeleteSubordinateRelationsBatchResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/subordinates/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageManagerUpdateSubordinateRelationsBatchSchema"}}],"summary":"Update manager subordinate relations","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerUpdateSubordinateRelationsBatchResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"post":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/subordinates/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageManagerCreateSubordinateRelationsBatchSchema"}}],"summary":"Batch create manager subordinate relations","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerCreateSubordinateRelationsBatchResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/subordinates/notifications/batch":{"post":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/subordinates/notifications/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageManagerBatchNotifyMangersSchema"}}],"summary":"Send notification to manager for pending subordinates","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerBatchNotifyMangersResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/subordinates/emails/batch":{"post":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/subordinates/emails/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageManagerBatchMailSubordinatesSchema"}}],"summary":"Send emails to subordinates","last_modified_date":"","description":"Only users with manager permission can call this API","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerBatchMailSubordinatesResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/subordinates/candidates":{"get":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/subordinates/candidates","parameters":[{"in":"query","name":"search_text","type":"string","required":false,"description":"Partial match search in the following fields: subordinate_username, subordinate_fullname, subordinate_firstname, subordinate_lastname, subordinate_email"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"subordinate_ids","type":"array","required":false,"description":"Filter by ids of the subordinates"},{"in":"query","name":"filter_per_domain","type":"boolean","required":false,"description":"Whether or not to filter by domain (Available only when the multidomain is used for the request)"}],"summary":"List of users for a specific domain","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerSubordinateCandidatesResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter subordinate_ids","1002":"Invalid parameter search_text","1003":"Invalid parameter filter_per_domain"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/candidates":{"get":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/candidates","parameters":[{"in":"query","name":"search_text","type":"string","required":false,"description":"Partial match search in the following fields: manager_username, manager_fullname, manager_firstname, manager_lastname, manager_email"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"manager_ids","type":"array","required":false,"description":"Filter by ids of the managers"},{"in":"query","name":"filter_per_domain","type":"boolean","required":false,"description":"Whether or not to filter by domain (Available only when the multidomain is used for the request)"}],"summary":"List managers","last_modified_date":"","description":"This API can be called by normal users when \"Automatic Notification for Team Members\" and \"Auto Suggestion in Automatic Notification\" settings for the given domain are enabled","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerListManagersCandidatesResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter search_text","1002":"Invalid parameter manager_ids","1003":"Invalid parameter filter_per_domain"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/{id}/subordinates":{"get":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/{id}/subordinates","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The idst of the manager"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search all string fields for this value"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"manager_type_ids","type":"array","required":false,"description":"Filter by ids of the manager types"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"manager_type_statuses","type":"array","required":false,"description":"Filter by statuses Possible values (&#039;confirmed&#039;, &#039;not_confirmed&#039;, &#039;pending&#039;, &#039;imported&#039;)"},{"in":"query","name":"show_only_warnings","type":"boolean","required":false,"description":"Return the users with &quot;heads_up&quot; KPI status"},{"in":"query","enum":["id","priority","name"],"name":"sort_attr","type":"string","required":false,"description":"Sort by attribute. The default value is &quot;name&quot;"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"skill_code","type":"string","required":false,"description":"Filter the results showing only users with the skill assigned to them"}],"summary":"Retrieves all the subordinates for the given manager","last_modified_date":"","description":"Only users with manager permission can call this API. The manager can only see their own subordinates with this API.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerListManagerSubordinatesResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter manager_type_ids","1002":"Invalid parameter manager_type_statuses","1003":"Invalid parameter search_text","1004":"Invalid parameter show_only_warnings","1009":"Invalid parameter skill_code"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/types":{"get":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/types","parameters":[{"in":"query","name":"search_text","type":"string","required":false,"description":"Search all string fields for this value"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"manager_type_ids","type":"array","required":false,"description":"Filter by manager types IDs"},{"in":"query","name":"manager_type_active_toggle","type":"boolean","required":false,"description":"Filter by active manager types"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field. Options: manager_type_id, manager_type_name, manager_type_description, manager_type_active"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"}],"summary":"Retrieve all manager types","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerListManagerTypesResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter manager_type_ids","1002":"Invalid parameter manager_type_active_toggle","1003":"Invalid parameter search_text"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/subordinates/transfers/batch":{"post":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/subordinates/transfers/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageManagerTransfersBatchSchema"}}],"summary":"Transfer subordinates from one manager to another","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerTransfersBatchResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: {X}","1002":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/courses":{"get":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/courses","parameters":[{"in":"query","name":"user_id","type":"integer","required":false,"description":"Must be Subordinate ID of existing, active and not expired user, with at least 1 Active (confirmed or import) relation of any level with the current manager. When passed and if the user is already enrolled, &quot;User already enrolled in course&quot; will be returned in the &quot;locked_message&quot; field for given course."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search all string fields for this value"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"course_types","type":"array","required":false,"description":"Search by given course type (elearning, classroom)"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"course_ids","type":"array","required":false,"description":"Filter by the courses&#039; ID"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"language_codes","type":"array","required":false,"description":"Search by given language code"},{"in":"query","name":"show_suggested","type":"boolean","required":false,"description":"Whether to return suggested courses (in the first position)"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id. Options: id, name, description, code"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = аscending, desc = descending, default - asc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. Default to the platform setting for pagination"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"skill_codes","type":"array","required":false,"description":"Filter the results showing only content with certain skills"},{"in":"query","name":"include_locked","type":"boolean","required":false,"description":"TRUE by default. Include or exclude records where &quot;locked&quot; is TRUE. Can only be used when &#039;user_id&#039; is sent."}],"summary":"List manager courses","last_modified_date":"2025.05.13","description":"Only users with manager permission can call this API","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerListManagerCoursesResponse"}},"400":{"description":"General Error","error_codes":{"403":"Permission denied","1001":"Invalid parameter user_id","1002":"Invalid parameter search_text","1003":"Invalid parameter course_types","1004":"Invalid parameter language_codes","1005":"Invalid parameter show_suggested","1006":"User does not exist","1007":"User is inactive","1008":"User has expired"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/learningplans":{"get":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/learningplans","parameters":[{"in":"query","name":"user_id","type":"integer","required":false,"description":"Must be Subordinate ID of existing, active and not expired user, with at least 1 Active (confirmed or import) relation of any level with the current manager. When passed and if the user is already enrolled the item will not appear in the list."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search all string fields for this value"}],"summary":"List manager learning plans","last_modified_date":"2026.06.01","description":"Only users with manager permission can call this API <br />Only learning plans which are not for sale will be returned","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerListManagerLearningPlansResponse"}},"400":{"description":"General Error","error_codes":{"403":"Permission denied","1001":"Invalid parameter user_id","1002":"Invalid parameter search_text","1004":"User does not exist","1005":"User is inactive","1006":"User has expired"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/courses/enrollments/batch":{"post":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/courses/enrollments/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageManagerCourseEnrollBatchSchema"}}],"summary":"Batch enroll team members to courses","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerCourseEnrollBatchResponse"}},"400":{"description":"General Error","error_codes":{"403":"Permission denied","1001":"Invalid parameter: {X}","1002":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/managers/learningplans/enrollments/batch":{"post":{"tags":["Manager"],"operationId":"Manager./manage/v1/managers/learningplans/enrollments/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageManagerLearningplanEnrollBatchSchema"}}],"summary":"Batch enroll team members to learning plans","last_modified_date":"","description":"IF there are any errors related to the Additional Enrollment Fields, i.e invalid data structure for that param, incorrect values passed OR missing mandatory fields FOR certain course, we are NOT going to enroll the user neither to any of the courses or the LP itself","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageManagerLearningplanEnrollBatchResponse"}},"400":{"description":"General Error","error_codes":{"403":"Permission denied","1001":"Invalid parameter: {X}","1002":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/mobile/settings\r":{"get":{"tags":["Mobile"],"operationId":"Mobile./manage/v1/mobile/settings\r","parameters":[{"in":"query","name":"multidomain_id","type":"integer","required":false,"description":"ID of a multidomain for which to view the setting&#039;s value.\r"}],"summary":"Returns all mobile settings\r","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageMobileViewSettingsResponse"}},"400":{"description":"General Error","error_codes":{"1003":"Invalid domain ID\r"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Mobile"],"operationId":"Mobile./manage/v1/mobile/settings\r","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageMobileEditSettingsSchema"}}],"summary":"Updates basic launch information for mobile apps\r","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageMobileEditSettingsResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Could not save the setting. Reason: {error}\r"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/mobile/bootstrap":{"get":{"tags":["Mobile"],"operationId":"Mobile./manage/v1/mobile/bootstrap","parameters":[],"summary":"Returns basic launch information for mobile apps","last_modified_date":"2026-02-04","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageMobileBootstrapResponse"}},"500":{"description":"Internal server error"}}}},"/manage/v1/mobile/deeplink":{"post":{"tags":["Mobile"],"operationId":"Mobile./manage/v1/mobile/deeplink","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageMobileDeeplinkSchema"}}],"summary":"This endpoint will return a deep link used for mobile log in.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageMobileDeeplinkResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/multidomain":{"get":{"tags":["Multidomain"],"operationId":"Multidomain./manage/v1/multidomain","parameters":[{"in":"query","enum":["subdomain","subfolder","customdomain"],"name":"domain_type","type":"string","required":false,"description":"Allows to filter the multidomain by their type"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - name. Options: name, id"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - asc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 10, if value is -1 -&gt; all items are displayed"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"client_ids","type":"array","required":false,"description":"Limit the results to include data only for the specified client IDs"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to search in the name of the domains"},{"in":"query","name":"search_text_exclude_root","type":"boolean","required":false,"description":"Exclude root domain from search query"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"client_domains","type":"array","required":false,"description":"The list of domains to use to filter the results of the search. An empty string in the list will return the main domain"},{"in":"query","name":"include_disabled","type":"boolean","required":false,"description":"When true, disabled multidomains will be returned too (default - false)"}],"summary":"View all multidomain clients","last_modified_date":"2024.02.27","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageMultidomainIndexResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Multidomain App is not active","1002":"Invalid parameter type","1003":"Invalid domain_type parameter","1004":"Invalid client_domains parameter type","1005":"Invalid parameter include_disabled"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/notifications/external_notification\r":{"post":{"tags":["Notification"],"operationId":"Notification./manage/v1/notifications/external_notification\r","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageNotificationExternalNotificationSchema"}}],"summary":"Sends an external notification\r","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageNotificationExternalNotificationResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Please provide user ID, username or a UUID\r","1002":"Please provide session type\r","1003":"The user doesn't exist\r","1004":"The course doesn't exist\r","1005":"The session doesn't exist\r"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/oauth2/client":{"post":{"tags":["Oauth2"],"operationId":"Oauth2./manage/v1/oauth2/client","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageOauth2CreateClientSchema"}}],"summary":"Creates a new Oauth2 Client configuration","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOauth2CreateClientResponse"}},"400":{"description":"General Error","error_codes":{"1001":"- Invalid parameter","1002":"- Invalid grant type","1003":"- The provided client_id is not unique","1004":"- The public key provided is invalid","1005":"- Error while saving the client"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Oauth2"],"operationId":"Oauth2./manage/v1/oauth2/client","parameters":[{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - client_id. Possible values: client_id, app_name"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - asc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 50"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return cursor and prebuilt navigational _links. Default is 0"}],"summary":"Lists the OAuth2 Clients","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOauth2ListClientsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/oauth2/client/{id}":{"delete":{"tags":["Oauth2"],"operationId":"Oauth2./manage/v1/oauth2/client/{id}","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"alphanumerical name of the client"}],"summary":"Deletes an Oauth2 client","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOauth2DeleteClientResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter - id","1002":"Cannot delete OAuth2 client"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Oauth2"],"operationId":"Oauth2./manage/v1/oauth2/client/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageOauth2UpdateClientSchema"}},{"in":"path","name":"id","type":"string","required":true,"description":"Alphanumerical id of the OAuth2 client"}],"summary":"Updates a new Oauth2 Client configuration","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOauth2UpdateClientResponse"}},"400":{"description":"General Error","error_codes":{"1001":"- Invalid parameter","1002":"- Invalid grant type","1003":"- Cannot update the specified OAuth client","1004":"- The public key provided is invalid","1005":"- Error while saving the client"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/objectives/profile":{"put":{"tags":["Objectives"],"operationId":"Objectives./manage/v1/objectives/profile","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageObjectivesUpdateProfileSchema"}}],"summary":"Set user My Area Of Interest occupation and skills","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageObjectivesUpdateProfileResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Internal Server Error","1001":"Invalid occupation code property","1002":"Invalid occupation name property","1003":"Invalid occupation canonical code property","1004":"Invalid occupation canonical name property","1005":"Invalid occupation is_custom property","1111":"An error occurred while saving the occupation","2000":"Areas of improvement are required","2001":"Invalid area of improvement","2002":"You can define only x areas of improvement","2003":"Invalid area of improvement code property","2004":"Invalid area of improvement name property","2005":"Invalid area of improvement is_custom property","2006":"Invalid area of improvement is_suggested property","2007":"Invalid area of improvement expertise property","2008":"Invalid area of improvement target_expertise property.","2009":"You can define only x areas of improvement target expertise.","2222":"An error occurred while saving areas of improvement"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/opengraph":{"get":{"tags":["Opengraph"],"operationId":"Opengraph./manage/v1/opengraph","parameters":[{"in":"query","name":"url","type":"string","required":true,"description":"The URL of the page"}],"summary":"Fetch all Open Graph tags from a valid URL.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOpengraphListResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Parameter url is required","1001":"Please provide a valid URL.","1002":"Please provide a valid protocol for parameter url"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/orgchart":{"post":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageOrgchartCreateSchema"}}],"summary":"Create a new branch in the Organizational Chart Tree","last_modified_date":"","description":"Create a new branch in the Organizational Chart Tree.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartCreateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"No translations provided.","1002":"Please provide translation on system default language - {def lang}.","1003":"Invalid code.","1004":"Invalid parent id.","1005":"The new branch can't be saved","1006":"Error while saving new field node assignments"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart","parameters":[{"in":"query","name":"node_id","type":"integer","required":false,"description":"the id of the parent branch from which start listing child branches"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language for translating name of branches(browser code)"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search text in the branch title."},{"in":"query","enum":["1","2","3"],"name":"search_type","type":"integer","required":false,"description":"Define the search scope: 1: Will search in all branches, 2: Will search in the current branch direct children (it will work as 3 if flattened parameter is set to true), 3: Search in the current branch and its descendants"},{"in":"query","name":"get_actions","type":"boolean","required":false,"description":"Identify if the actions should be returned in the response, as of today not used anymore"},{"in":"query","name":"flattened","type":"boolean","required":false,"description":"Set to true if you want the complete subtree of the selected node. Default is false."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - title. Options: id, code, title"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - asc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 50"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default=1 (starting from Feb 20th 2018, the default will change to &quot;0&quot;)"},{"in":"query","name":"include_path","type":"boolean","required":false,"description":"Set to true to retrieve the full path for each branch in the response. Default = false"}],"summary":"List of branches of given or root level","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartIndexResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid branch idOrg."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/orgchart/{id}":{"delete":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageOrgchartDeleteSchema"}},{"in":"path","name":"id","type":"string","required":true,"description":"Internal branch ID (numeric) or alphanumeric branch code"}],"summary":"Deletes the branch.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter \"id\".","1002":"Invalid parameter \"id\".","1003":"Cannot delete node with users.","1005":"Branch which bought sub_record can not be deleted","1006":"Error while deleting node with id - {idOrg}","1007":"Branch code already exist.","1008":"You cannot delete a branch associated to a subdomain without first deleting the subdomain itself.","1009":"You cannot delete a branch associated if it's used in an automatic group."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/orgchart/{branch_id}":{"put":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart/{branch_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageOrgchartUpdateSchema"}},{"in":"path","name":"branch_id","type":"string","required":true,"description":"Internal branch ID (numeric) or alphanumeric branch code"}],"summary":"Update selected branch.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Please provide valid branch id.","1002":"Please provide translation on system default language - {default language}.","1003":"Database exception","1004":"Invalid code.","1007":"Branch code already exist."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart/{branch_id}","parameters":[{"in":"path","name":"branch_id","type":"string","required":true,"description":"Internal branch ID (numeric) or alphanumeric branch code"},{"in":"query","name":"use_secondary_identifier","type":"boolean","required":false,"description":"Interpret branch_id param as secondary identifier (i.e. alphanumeric branch code), default is false"},{"in":"query","name":"include_path","type":"boolean","required":false,"description":"If set to true return the branch name path. Any other value returns an empty path (default). NOTE: be aware that the operation of retrieving the path branches is heavy on the database, please set this parameter to true only if strictly necessary"}],"summary":"Get details of a selected branch.","last_modified_date":"2023.11.07","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartViewResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Branch does not exist"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/orgchart/{branch_id}/users\r":{"get":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart/{branch_id}/users\r","parameters":[{"in":"path","name":"branch_id","type":"string","required":true,"description":"Internal branch ID (numeric) or alphanumeric branch code\r"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default=0\r"},{"in":"query","name":"use_secondary_identifier","type":"boolean","required":false,"description":"Interpret branch_id param as secondary identifier (i.e. alphanumeric branch code). Default is false\r"},{"in":"query","name":"only_first_level","type":"integer","required":false,"description":"If this parameter is not provided then api will get also users in child branches\r"},{"in":"query","name":"exclude_invalid_users","type":"integer","required":false,"description":"If set to 1 then invalid or expired users will not be retrieved (default value is 0)\r"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - first_name. Options: username, first_name, status, level, email, last_access_date, expiration_date, language, email_validation_status\r"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc\r"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1\r"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 200\r"}],"summary":"Retrieve information about a branch's users.\r","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartGetUsersInBranchResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Please provide branch id.\r","1001":"Invalid branch id.\r"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/orgchart/assign_users":{"post":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart/assign_users","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageOrgchartAssignUsersSchema"}}],"summary":"Assigns a collection of user ids to the specified node.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartAssignUsersResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing or invalid required param \"id_org\".","1002":"Missing or invalid required param \"id_users\"."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/orgchart/{id}/move":{"post":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart/{id}/move","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageOrgchartMoveSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"Id of selected branch."}],"summary":"Move and org chart under a new parent node.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartMoveResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameter.","1002":"Invalid node id.","1003":"Cannot move non-leaf node.","1004":"Invalid parent id.","1005":"Failed to move node.","1006":"Current branch ID can not be equal to new parent branch ID."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/orgchart/{branch_id}/field_visibility":{"post":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart/{branch_id}/field_visibility","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageOrgchartAssignFieldSchema"}},{"in":"path","name":"branch_id","type":"integer","required":true,"description":"ID of the branch or ID of the group"}],"summary":"Assign user fields to branch/group","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartAssignFieldResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Group/Branch not found!","1002":"Missing parameter - user_fields.","1003":"user_fields must be array.","1004":"Something went wrong!"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/orgchart/code":{"post":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart/code","parameters":[],"summary":"Check for duplicate branch code","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartCheckBranchCodeResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/orgchart/batch":{"post":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageOrgchartBatchSchema"}}],"summary":"Batch import of branches.","last_modified_date":"2024.07.24","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartBatchResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameters items","1001":"Maximum number of records exceeded","2000":"Invalid value for parameter <parameter_name> - <invalid_value>"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageOrgchartBatchDeleteBranchesSchema"}}],"summary":"Batch deletion of branches","last_modified_date":"2023.08.29","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartBatchDeleteBranchesResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/orgchart/users/batch":{"delete":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart/users/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageOrgchartBatchRemoveUsersSchema"}}],"summary":"Batch remove members from branches","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartBatchRemoveUsersResponse"}},"400":{"description":"General Error","error_codes":{"1007":"Maximum number of records exceeded","1008":"Invalid parameters for an API call"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/orgchart/dropdown-options":{"get":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart/dropdown-options","parameters":[],"summary":"Returns branch codes associated with their translations","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartDropdownOptionsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/orgchart/importer_fields\r":{"get":{"tags":["Orgchart"],"operationId":"Orgchart./manage/v1/orgchart/importer_fields\r","parameters":[],"summary":"Returns list of mappable fields for the data importer\r","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageOrgchartImporterFieldsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/player/license":{"get":{"tags":["Player"],"operationId":"Player./manage/v1/player/license","parameters":[],"summary":"Get player license key","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePlayerGetLicenseResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/policy":{"post":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManagePolicyCreateSchema"}}],"summary":"Create Privacy Policy","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyCreateResponse"}},"400":{"description":"General Error","error_codes":{"9000":"Validation errors array"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy","parameters":[{"in":"query","name":"search_text","type":"string","required":false,"description":"Search text in the policy name."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - name. Options: id, name, last_updated"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - asc"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to search in id, name, default, multidomains, last_updated, version"},{"in":"query","name":"filters","type":"string","required":false,"description":"Serialized object containing list of filters and their options - ( field:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains} )"}],"summary":"Get list of all policies","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyIndexResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/policy/{id}":{"delete":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the policy to delete"}],"summary":"Delete a Privacy Policy","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1001":"The default policy cannot be deleted","1002":"Error while deleting policy with ID - {id}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/policy/{policy_id}":{"put":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy/{policy_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManagePolicyUpdateSchema"}},{"in":"path","name":"policy_id","type":"integer","required":true,"description":"The ID of the Policy"}],"summary":"Update a Privacy Policy","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyUpdateResponse"}},"400":{"description":"General Error","error_codes":{"9000":"Validation errors array"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/policy/{policy_id}/assignment":{"post":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy/{policy_id}/assignment","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManagePolicyAssignSchema"}},{"in":"path","name":"policy_id","type":"integer","required":true,"description":"The ID of the Policy"}],"summary":"Assign multidomains on policy","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyAssignResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter - policy_id.","1002":"Missing parameter - multidomain_ids.","1003":"Validation error messages"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy/{policy_id}/assignment","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManagePolicyUnassignSchema"}},{"in":"path","name":"policy_id","type":"integer","required":true,"description":"The ID of the Policy"}],"summary":"Unassign Policy from Multidomain(s)","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyUnassignResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter policy_id","1002":"Missing parameter multidomain_ids","1003":"Parameter multidomain_ids must be array","1004":"Please provide multidomain_ids","1005":"No valid policy_id provided","1006":"Invalid operation! You can not unassign from default Policy","1007":"Provided multidomain_ids are not assigned to this Policy","4000":"DB Problem"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy/{policy_id}/assignment","parameters":[{"in":"path","name":"policy_id","type":"integer","required":true,"description":"ID of the policy"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to search in name and domain of the multidomains."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - policy_associated_date. Options: name, domain_name, policy_associated_date"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - asc"}],"summary":"Assign a Policy - List","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyAssignListResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter - policy_id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/policy/track":{"post":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy/track","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManagePolicyTrackSchema"}}],"summary":"Create Tracking of Policy and Sub-Policies","last_modified_date":"2024.12.23","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyTrackResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Please provide Policy ID","1002":"Missing parameter multidomain_ids","1003":"Invalid policy_id","1004":"Invalid policy_id","1005":"Invalid parameter sub_policies","1006":"You have to accept all mandatory Sub-Policies","1008":"Invalid client_id","2000":"You have already accepted this Privacy Policy","3000":"DB error","5000":"DB error","4001":"Cannot update tracking of policy and sub-policies when impersonated by a Power User"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy/track","parameters":[{"in":"query","name":"user_id","type":"integer","required":false,"description":"Id of user for which must to find tracking. If not provided we use a current user who is a logged in the system."},{"in":"query","name":"subdomain_id","type":"integer","required":false,"description":"Id of subdomain for which must to find tracking. If not provided we use a current domain of system."},{"in":"query","name":"policy_version_id","type":"integer","required":false,"description":"Id of policy version for which must to find tracking. If not provided we use a last version id of policy by subdomain id or current domain of system."}],"summary":"View Tracking of Policy and Sub-Policies","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyViewTrackResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/policy/{policy_id}/versions/latest":{"get":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy/{policy_id}/versions/latest","parameters":[{"in":"path","name":"policy_id","type":"integer","required":true,"description":"The ID of the Policy"}],"summary":"Get policy by Id with latest version","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyLastVersionResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter - policy_id.","1003":"Validation error messages"}},"500":{"description":"Internal server error"}}}},"/manage/v1/policy/{policy_id}/versions":{"get":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy/{policy_id}/versions","parameters":[{"in":"path","name":"policy_id","type":"integer","required":true,"description":"The ID of the Policy"}],"summary":"Get list of all policy versions","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyGetVersionsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid Policy ID"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/policy/multidomains":{"get":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy/multidomains","parameters":[{"in":"query","name":"search_text","type":"string","required":false,"description":"Search text in the client name."},{"in":"query","name":"policy_id","type":"integer","required":false,"description":"Check if the clients are assigned to this policy"},{"in":"query","name":"get_only_assigned","type":"integer","required":false,"description":"Get the clients which are already assigned to the requested policy"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - name. Options: id, name"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - asc"}],"summary":"Get list of all clients","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyClientsResponse"}},"400":{"description":"General Error","error_codes":{"400":"Please provide a numeric policy_id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/policy/track/{track_id}":{"put":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy/track/{track_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManagePolicyUpdateTrackSchema"}},{"in":"path","name":"track_id","type":"integer","required":true,"description":"The ID of the Track"}],"summary":"Update Tracking of Policy and Sub-Policies","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyUpdateTrackResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Not exist tracking for current user and given policy version.","1002":"DB error","4001":"Cannot update tracking of policy and sub-policies when impersonated by a Power User"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/policy/current":{"get":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy/current","parameters":[{"in":"query","name":"client_id","type":"integer","required":false,"description":"A multidomain client ID"}],"summary":"Get Privacy Policy ID by domain","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyGetLastPolicyByDomainResponse"}},"500":{"description":"Internal server error"}}}},"/manage/v1/policy/track/check":{"get":{"tags":["Policy"],"operationId":"Policy./manage/v1/policy/track/check","parameters":[{"in":"query","name":"user_id","type":"integer","required":false,"description":"Id of user for which must to find tracking. If not provided we use a current user who is a logged in the system."},{"in":"query","name":"subdomain_id","type":"integer","required":false,"description":"Id of subdomain for which must to find tracking. If not provided we use a current domain of system."}],"summary":"Check if the logged user need to accept privacy policy","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManagePolicyCheckAcceptanceResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/site/bootstrap":{"get":{"tags":["Site"],"operationId":"Site./manage/v1/site/bootstrap","parameters":[{"in":"query","name":"theme","type":"string","required":false,"description":"The theme code to preview. If passed, the returned branding_elements will be loaded based on this value, rather than the active theme"}],"summary":"Returns base information: default platform language, active languages, active plugins, color scheme and etc.","last_modified_date":"2026-02-26","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageSiteBootstrapResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Given multidomain not active"}},"500":{"description":"Internal server error"}}}},"/manage/v1/site/translations":{"get":{"tags":["Site"],"operationId":"Site./manage/v1/site/translations","parameters":[{"in":"query","name":"lang_code","type":"string","required":true,"description":"Language code"}],"summary":"Get translation","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageSiteTranslationsResponse"}},"500":{"description":"Internal server error"}}}},"/manage/v1/site/translate":{"post":{"tags":["Site"],"operationId":"Site./manage/v1/site/translate","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageSiteTranslateSchema"}}],"summary":"Translates the passed array of phrases in all available languages","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageSiteTranslateResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Each phrase must be an object with \"category\" and \"phrase\" properties","1001":"\"category\" and \"phrase\" properties cannot be empty"}},"500":{"description":"Internal server error"}}}},"/manage/v1/site/helpDesk":{"post":{"tags":["Site"],"operationId":"Site./manage/v1/site/helpDesk","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageSiteHelpDeskSchema"}}],"summary":"Send Request to the sales or help team in the ERP","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageSiteHelpDeskResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/site/theme/{theme_code}\r":{"put":{"tags":["Site"],"operationId":"Site./manage/v1/site/theme/{theme_code}\r","parameters":[{"in":"path","name":"theme_code","type":"string","required":true,"description":"Identification code of the theme.\r"}],"summary":"Apply a theme by theme code\r","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageSiteThemeResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: theme_code\r","1002":"No such theme!\r","1003":"Could not apply theme\r"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/site/microservice":{"get":{"tags":["Site"],"operationId":"Site./manage/v1/site/microservice","parameters":[],"summary":"Returns the available microservices for the given LMS url","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageSiteMicroservicesResponse"}},"500":{"description":"Internal server error"}}}},"/manage/v1/site/google-auth":{"post":{"tags":["Site"],"operationId":"Site./manage/v1/site/google-auth","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageSiteGoogle-authSchema"}}],"summary":"Returns an OAuth2 access token in exchange for a Google Auth token","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageSiteGoogle-authResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Missing required google auth code","1001":"Invalid google auth code provided","1002":"Suspended or invalid user"}},"500":{"description":"Internal server error"}}}},"/manage/v1/site/helpdesk/settings":{"get":{"tags":["Site"],"operationId":"Site./manage/v1/site/helpdesk/settings","parameters":[],"summary":"List Help Desk settings","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageSiteGetHelpdeskSettingsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"ERP call failed with bad data structure"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/site/environment/status":{"get":{"tags":["Site"],"operationId":"Site./manage/v1/site/environment/status","parameters":[],"summary":"Retrieving Docebo environment status","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageSiteEnvironmentStatusResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Unable to retrieve environment status","1002":"Environment stats call failed with bad data structure","1003":"Environment stats call failed with error: Not a valid JSON response received"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/tags":{"post":{"tags":["Tags"],"operationId":"Tags./manage/v1/tags","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageTagsCreateSchema"}}],"summary":"Creates a new tag","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTagsCreateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter - tag"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Tags"],"operationId":"Tags./manage/v1/tags","parameters":[{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id. Options: name, id"},{"in":"query","name":"search_tag","type":"string","required":false,"description":"Search text in the tag title"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - asc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 10, if value is -1 -&gt; all items are displayed"}],"summary":"View all tags","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTagsListResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/tags/{id_tag}":{"delete":{"tags":["Tags"],"operationId":"Tags./manage/v1/tags/{id_tag}","parameters":[{"in":"path","name":"id_tag","type":"integer","required":true,"description":"Tag id"}],"summary":"Delete tag","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTagsDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Tag not found!","1002":"Tag was not Deleted!"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Tags"],"operationId":"Tags./manage/v1/tags/{id_tag}","parameters":[{"in":"path","name":"id_tag","type":"integer","required":true,"description":"ID of the tag"}],"summary":"View tag","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTagsViewResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Tag not found!"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/tags/blacklist":{"put":{"tags":["Tags"],"operationId":"Tags./manage/v1/tags/blacklist","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageTagsUpdateBlacklistSchema"}}],"summary":"Update the blacklisted tags","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTagsUpdateBlacklistResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter 'tags'","1002":"Error updating the blacklist"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Tags"],"operationId":"Tags./manage/v1/tags/blacklist","parameters":[],"summary":"Clear the blacklist","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTagsClearBlacklistResponse"}},"400":{"description":"General Error","error_codes":{"1003":"Error emptying the blacklist"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Tags"],"operationId":"Tags./manage/v1/tags/blacklist","parameters":[{"in":"query","name":"page","type":"integer","required":false,"description":"The page number. If isn&#039;t provided, 1 is the default"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The number of element returned in a single page. If isn&#039;t provided, 10 is the default"},{"in":"query","name":"search","type":"string","required":false,"description":"The search query, minimum length of 3. The search is performed basically with LIKE operator"}],"summary":"Retrieve all blacklisted tags","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTagsListBlacklistResponse"}},"400":{"description":"General Error","error_codes":{"1002":"The parameter search must be long at least 3 chars"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/termsandconditions":{"post":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageTermsandconditionsCreateSchema"}}],"summary":"Create a Terms & Conditions record","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsCreateResponse"}},"400":{"description":"General Error","error_codes":{"9000":"Validation errors array"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions","parameters":[{"in":"query","name":"search_text","type":"string","required":false,"description":"Search text in the T&amp;C record name."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - name. Options: id, name, last_updated"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - asc"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to search in id, name, default, multidomains, last_updated, version"},{"in":"query","name":"filters","type":"string","required":false,"description":"Serialized object containing list of filters and their options - ( field:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains} )"}],"summary":"Get list of all Terms & Conditions records","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsIndexResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/termsandconditions/{id}":{"delete":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the terms and conditions record to delete"}],"summary":"Delete a Terms & Conditions record","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1001":"The default terms and conditions cannot be deleted","1002":"Error while deleting terms and conditions record with ID - {id}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/termsandconditions/{tc_id}":{"put":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions/{tc_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageTermsandconditionsUpdateSchema"}},{"in":"path","name":"tc_id","type":"integer","required":true,"description":"The ID of the Terms &amp; Conditions record"}],"summary":"Update a Terms & Conditions record","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsUpdateResponse"}},"400":{"description":"General Error","error_codes":{"9000":"Validation errors array"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/termsandconditions/{tc_id}/assignment":{"post":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions/{tc_id}/assignment","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageTermsandconditionsAssignSchema"}},{"in":"path","name":"tc_id","type":"integer","required":true,"description":"The ID of the Terms &amp; Conditions"}],"summary":"Assign multidomains on terms and conditions","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsAssignResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter - tc_id.","1002":"Missing parameter - multidomain_ids.","1003":"Validation error messages"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions/{tc_id}/assignment","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageTermsandconditionsUnassignSchema"}},{"in":"path","name":"tc_id","type":"integer","required":true,"description":"The ID of the Terms &amp; Conditions record"}],"summary":"Unassign Terms & Conditions from Multidomain(s)","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsUnassignResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter tc_id","1002":"Missing parameter multidomain_ids","1003":"Parameter multidomain_ids must be array","1004":"Please provide multidomain_ids","1005":"No valid tc_id provided","1006":"Invalid operation! You can not unassign from the default Terms & Conditions","1007":"Provided multidomain_ids are not assigned to these Terms & Conditions","4000":"DB Problem"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions/{tc_id}/assignment","parameters":[{"in":"path","name":"tc_id","type":"integer","required":true,"description":"ID of the Terms &amp; Conditions record"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to search in name and domain of the multidomains."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - tc_associated_date. Options: name, domain_name, tc_associated_date"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - asc"}],"summary":"Assign Terms & Conditions - List","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsAssignListResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter - tc_id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/termsandconditions/track":{"post":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions/track","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageTermsandconditionsTrackSchema"}}],"summary":"Create a Tracking record for the Terms & Conditions","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsTrackResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Please provide Terms & Conditions record ID","1002":"Missing parameter multidomain_ids","1003":"Invalid tc_id","1004":"Invalid tc_id","2000":"You have already accepted these Terms & Conditions","3000":"DB error","5000":"DB error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions/track","parameters":[{"in":"query","name":"user_id","type":"integer","required":false,"description":"Id of user for which must to find tracking. If not provided we use a current user who is a logged in the system."},{"in":"query","name":"subdomain_id","type":"integer","required":false,"description":"Id of subdomain for which must to find tracking. If not provided we use a current domain of system."},{"in":"query","name":"tc_version_id","type":"integer","required":false,"description":"Id of T&amp;C version for which must to find tracking. If not provided we use a last version id of the T&amp;C by subdomain id or current domain of system."}],"summary":"View Tracking of a Terms & Conditions record","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsViewTrackResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/termsandconditions/{tc_id}/versions/latest":{"get":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions/{tc_id}/versions/latest","parameters":[{"in":"path","name":"tc_id","type":"integer","required":true,"description":"The ID of the terms and conditions record"}],"summary":"Get a terms and conditions record by Id with latest version","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsLastVersionResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter - tc_id.","1003":"Validation error messages"}},"500":{"description":"Internal server error"}}}},"/manage/v1/termsandconditions/{tc_id}/versions":{"get":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions/{tc_id}/versions","parameters":[{"in":"path","name":"tc_id","type":"integer","required":true,"description":"The ID of the Terms &amp; Conditions record"}],"summary":"Get list of all versions of a Terms & Conditions record","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsGetVersionsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid Terms & Conditions record ID"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/termsandconditions/multidomains":{"get":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions/multidomains","parameters":[{"in":"query","name":"search_text","type":"string","required":false,"description":"Search text in the client name."},{"in":"query","name":"tc_id","type":"integer","required":false,"description":"Check if the clients are assigned to this terms and conditions"},{"in":"query","name":"get_only_assigned","type":"integer","required":false,"description":"Get the clients which are already assigned to the requested terms and conditions"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - name. Options: id, name"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - asc"}],"summary":"Get list of all clients","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsClientsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/termsandconditions/track/{track_id}":{"put":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions/track/{track_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageTermsandconditionsUpdateTrackSchema"}},{"in":"path","name":"track_id","type":"integer","required":true,"description":"The ID of the Track"}],"summary":"Update the Tracking of a Terms & Conditions record","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsUpdateTrackResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Not exist tracking for current user and given terms and conditions version.","1002":"DB error","4001":"Cannot update the tracking of a terms & conditions record when impersonated by a Power User"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/termsandconditions/current":{"get":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions/current","parameters":[{"in":"query","name":"client_id","type":"integer","required":false,"description":"A multidomain client ID"}],"summary":"Get the Terms & Conditions record ID by domain","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsGetLastTcByDomainResponse"}},"500":{"description":"Internal server error"}}}},"/manage/v1/termsandconditions/track/check":{"get":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions/track/check","parameters":[{"in":"query","name":"user_id","type":"integer","required":false,"description":"Id of user for which must to find tracking. If not provided we use a current user who is a logged in the system."},{"in":"query","name":"subdomain_id","type":"integer","required":false,"description":"Id of subdomain for which must to find tracking. If not provided we use a current domain of system."}],"summary":"Check if the logged user need to accept the terms and conditions","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsCheckAcceptanceResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/termsandconditions/default":{"get":{"tags":["Termsandconditions"],"operationId":"Termsandconditions./manage/v1/termsandconditions/default","parameters":[],"summary":"Get the default Terms and Conditions","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTermsandconditionsGetDefaultResponse"}},"500":{"description":"Internal server error"}}}},"/manage/v1/theme/{theme_code}\r":{"delete":{"tags":["Theme"],"operationId":"Theme./manage/v1/theme/{theme_code}\r","parameters":[{"in":"path","name":"theme_code","type":"string","required":true,"description":"Identification code of the theme.\r"}],"summary":"Delete a theme\r","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageThemeDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: theme_code\r","1002":"No such theme!\r","1003":"Cannot delete built-in theme\r"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Theme"],"operationId":"Theme./manage/v1/theme/{theme_code}\r","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageThemeUpdateSchema"}},{"in":"path","name":"theme_code","type":"string","required":true,"description":"Identification code of the theme.\r"}],"summary":"Update a theme by theme code\r","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageThemeUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: theme_code\r","1002":"No such theme!\r","1003":"Could not save theme\r"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Theme"],"operationId":"Theme./manage/v1/theme/{theme_code}\r","parameters":[{"in":"path","name":"theme_code","type":"string","required":true,"description":"Identification code of the theme.\r"}],"summary":"View a theme by theme code\r","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageThemeViewResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: theme_code\r","1002":"No such theme!\r"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/theme\r":{"get":{"tags":["Theme"],"operationId":"Theme./manage/v1/theme\r","parameters":[],"summary":"View all themes\r","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageThemeIndexResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/theme/{theme_code}/variant/{id_multidomain}\r":{"put":{"tags":["Theme"],"operationId":"Theme./manage/v1/theme/{theme_code}/variant/{id_multidomain}\r","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageThemeUpdateVariantSchema"}},{"in":"path","name":"theme_code","type":"string","required":true,"description":"Identification code of the theme.\r"},{"in":"path","name":"id_multidomain","type":"integer","required":true,"description":"Identification number of the multidomain.\r"}],"summary":"Update or create a theme variant by theme code and multidomain id\r","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageThemeUpdateVariantResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter\r","1002":"No such theme!\r","1003":"No such multidomain\r","1004":"Could not save theme variant\r"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/trails":{"get":{"tags":["Trails"],"operationId":"Trails./manage/v1/trails","parameters":[{"in":"query","name":"start_time","type":"datetime","required":true,"description":"Sets the beginning of the range of time of the results, before end_time and current time. Accepted format is &quot;yyyy-MM-dd HH:mm:ss&quot;, UTC timezone"},{"in":"query","name":"end_time","type":"datetime","required":false,"description":"Sets the end of the range of time of the results, after start_time and defaulting to current time. Accepted format is &quot;yyyy-MM-dd HH:mm:ss&quot;, UTC timezone"},{"in":"query","name":"actor_id_user","type":"integer","required":false,"description":"Filters trails based on the internal unique ID of the user whose activity is being logged"},{"in":"query","name":"actor_ip_address","type":"string","required":false,"description":"Filters trails based on the Internet Protocol (IP) address of the user whose activity is being logged"},{"in":"query","name":"event_name","type":"string","required":false,"description":"Filters trails based on the name of the event"},{"in":"query","name":"target_id_user","type":"integer","required":false,"description":"Filters trails based on the internal unique ID of the user subject of the action"},{"in":"query","name":"target_id_course","type":"integer","required":false,"description":"Filters trails based on the internal unique ID of the course subject of the action"},{"in":"query","name":"target_id_entity","type":"integer","required":false,"description":"Filters trails based on the internal unique ID of the entity subject of the action (only applicable to audited entities different from users and courses)"},{"in":"query","name":"include_json_data","type":"boolean","required":false,"description":"Set to true to get the JSON data associated to audit trail. Default is false."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - trail_id. Options: timestamp, trail_id, event_name"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Request for a cursor, Default = 0"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 10"}],"summary":"Returns audit trail logs generated in a specific time span","last_modified_date":"","description":"A full list of events:https://www.docebo.com/wp-content/uploads/2015/07/Audit-Trail-API-Event-List.pdf","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTrailsIndexResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/2fa/apps/secrets":{"get":{"tags":["Twofactorauth"],"operationId":"Twofactorauth./manage/v1/2fa/apps/secrets","parameters":[],"summary":"Retrieve 2FA secret key","last_modified_date":"","description":"Only available when EsignatureApp is on and Authenticator App is selected from its settings","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTwofactorauthGetSecretsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"AuthenticatorApp already paired"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/2fa/apps/pairings":{"post":{"tags":["Twofactorauth"],"operationId":"Twofactorauth./manage/v1/2fa/apps/pairings","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageTwofactorauthPairingsSchema"}}],"summary":"Two-factor Authentication App pairing","last_modified_date":"","description":"Only available when EsignatureApp is on and Authenticator App is selected from its settings","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTwofactorauthPairingsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter 'otp'","1002":"Invalid parameter: otp","1003":"Invalid OTP","1004":"Unable to save secret"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/2fa/emails":{"post":{"tags":["Twofactorauth"],"operationId":"Twofactorauth./manage/v1/2fa/emails","parameters":[],"summary":"Two-factor authentication send OTP code by email","last_modified_date":"","description":"Only available when EsignatureApp is on and Email is selected from its settings","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTwofactorauthEmailsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Please, fill your email address and try again!","1002":"Unable to send notification emails"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/2fa/apps/recovery_codes":{"post":{"tags":["Twofactorauth"],"operationId":"Twofactorauth./manage/v1/2fa/apps/recovery_codes","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageTwofactorauthRegenerateRecoveryCodesSchema"}}],"summary":"Regenerate 2fa recovery code","last_modified_date":"","description":"Only available when EsignatureApp is on and Authenticator App is selected from its settings","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTwofactorauthRegenerateRecoveryCodesResponse"}},"400":{"description":"General Error","error_codes":{"1001":"AuthenticatorApp not paired","1002":"Unable to save recovery code","1003":"Invalid OTP","1004":"Invalid parameter: otp","1005":"Missing parameter 'otp'"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/2fa/verifications":{"post":{"tags":["Twofactorauth"],"operationId":"Twofactorauth./manage/v1/2fa/verifications","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageTwofactorauthVerificationsSchema"}}],"summary":"Verify Two-factor Authentication OTP code","last_modified_date":"","description":"Only available when EsignatureApp is on","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTwofactorauthVerificationsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter 'otp'","1002":"Invalid parameter: identifier","1003":"Invalid parameter: otp","1004":"Invalid OTP","1005":"Identifier not enabled"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/2fa/users/{user_id}/pairings\r":{"delete":{"tags":["Twofactorauth"],"operationId":"Twofactorauth./manage/v1/2fa/users/{user_id}/pairings\r","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageTwofactorauthDeletePairingSchema"}},{"in":"path","name":"user_id","type":"integer","required":true,"description":"ID of user\r"}],"summary":"Delete 2FA Secret or Code\r","last_modified_date":"","description":"Only available when EsignatureApp is on\r","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTwofactorauthDeletePairingResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter 'identifier'\r","1002":"Invalid parameter: identifier\r","1003":"User does not exist\r","1004":"Something went wrong, cannot unpair identifier\r","1005":"Identifier not enabled\r"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/2fa/apps/recovery_codes/verifications":{"post":{"tags":["Twofactorauth"],"operationId":"Twofactorauth./manage/v1/2fa/apps/recovery_codes/verifications","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageTwofactorauthVerifyRecoveryCodesSchema"}}],"summary":"Verify 2fa recovery code","last_modified_date":"","description":"Only available when EsignatureApp is on and Authenticator App is selected from its settings","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTwofactorauthVerifyRecoveryCodesResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter 'recovery_code'","1002":"Invalid parameter: recovery_code","1003":"AuthenticatorApp not paired","1004":"Invalid recovery_code","1005":"Unable to save recovery code"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/2fa/users/pairings":{"delete":{"tags":["Twofactorauth"],"operationId":"Twofactorauth./manage/v1/2fa/users/pairings","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageTwofactorauthDeleteUserPairingSchema"}}],"summary":"Delete 2FA Secret or Code of Signed-in user","last_modified_date":"","description":"Only available when EsignatureApp is on","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageTwofactorauthDeleteUserPairingResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing required parameter recovery_code","1002":"Invalid parameter: recovery_code","1003":"Identifier not enabled","1004":"AuthenticatorApp not paired","1005":"Invalid recovery_code","1006":"Something went wrong, cannot unpair identifier"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/unsplash":{"get":{"tags":["Unsplash"],"operationId":"Unsplash./manage/v1/unsplash","parameters":[{"in":"query","name":"search_text","type":"string","required":false,"description":"Search text for the photos"},{"in":"query","name":"page","type":"integer","required":false,"description":"Get specific page result. Default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Get certain number of items per page. Default 10"}],"summary":"List photos from Unsplash","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUnsplashIndexResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Operation failure"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/unsplash/{id}":{"put":{"tags":["Unsplash"],"operationId":"Unsplash./manage/v1/unsplash/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUnsplashFetchSchema"}},{"in":"path","name":"id","type":"string","required":true,"description":"Unsplash image ID"}],"summary":"Fetch an Unsplash image and uploading it to S3","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUnsplashFetchResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Operation failure"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/upload/presigned_url":{"get":{"tags":["Upload"],"operationId":"Upload./manage/v1/upload/presigned_url","parameters":[{"in":"query","name":"filename","type":"string","required":true,"description":"The name of the File"},{"in":"query","name":"mime","type":"string","required":true,"description":"The mimetype of the file being processed"},{"in":"query","name":"collection","type":"string","required":true,"description":"collection name"},{"in":"query","name":"subfolder","type":"string","required":false,"description":"sub-folder to place the file in"},{"in":"query","enum":["read","write"],"name":"operation","type":"string","required":false,"description":"Whether you need the presigned URL for writing (PUT HTTP method) or reading/displaying (GET HTTP method). Defaults to &quot;write&quot;"},{"in":"query","name":"object_type","type":"string","required":false,"description":"The context name for generating the presigned url"}],"summary":"Generate Amazon S3 Pre-Signed URL for given File","last_modified_date":"2023.11.08","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUploadPresignedUrlResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing required parameter: filename","1002":"Missing required parameter: mime","1003":"Invalid parameter: mime","1007":"Missing required parameter: collection","1008":"Invalid parameter: collection","1009":"Invalid parameter: object_type","1012":"Invalid parameter: subfolder","1013":"Invalid parameter: filename","1014":"Invalid filename extension for this collection","1015":"Invalid operation. Allowed modes: read, write","1016":"Invalid mime type for this collection","1017":"The mimetype provided is not valid. Must be one of {mime} for the given object_type: {object_type}"}},"500":{"description":"Internal server error"}}}},"/manage/v1/upload/post_policy":{"get":{"tags":["Upload"],"operationId":"Upload./manage/v1/upload/post_policy","parameters":[],"summary":"Returns a POST Policy for making authenticated requests using HTTP","last_modified_date":"","description":"The POST Policy (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-HTTPPOSTConstructPolicy.html) is needed by the rich textarea component in order to upload files to an S3 instance. ","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUploadPostPolicyResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/upload":{"delete":{"tags":["Upload"],"operationId":"Upload./manage/v1/upload","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUploadDeleteSchema"}}],"summary":"Delete File from Amazon S3","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUploadDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing required parameter: filename","1008":"Invalid paramter: collection","1012":"Invalid paramter: subfolder","1013":"Invalid paramter: filename"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user":{"post":{"tags":["User"],"operationId":"User./manage/v1/user","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserCreateSchema"}}],"summary":"Create user","last_modified_date":"2024.04.05","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserCreateResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Validation error messages"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["User"],"operationId":"User./manage/v1/user","parameters":[{"in":"query","name":"pending","type":"integer","required":false,"description":"Get &quot;pending&quot; users OR all others. Options: 0 - false, 1 - true. Default value: false"},{"in":"query","name":"branch_id","type":"integer","required":false,"description":"Filtering by branch ID"},{"in":"query","name":"selection_status","type":"integer","required":false,"description":"Branches with children or not. Options: 1 - without children, 2 - with children. Default: 1"},{"in":"query","name":"minimalistic","type":"boolean","required":false,"description":"If true, does not return some additional information in each user record. Use this for better performances. Default: false"},{"in":"query","name":"newsletter_optout","type":"boolean","required":false,"description":"If true, return only opt-out users and vice versa. Default: false."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - first_name. Options: none (no sorting), username, first_name, last_name, status, level, email, last_access_date, expiration_date, language, email_validation_status, manager_1 (where 1 is manager type ID), authenticatorapp_pair_date"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page (upper bound 200). Default value: uses value of the advanced setting &quot;Amount of elements to display in each page&quot;."},{"in":"query","name":"get_total_count","type":"integer","required":false,"description":"If 1 the count of found items will be returned. Options: 0, 1 default 0"},{"in":"query","name":"match_type","type":"string","required":false,"description":"should perform a full match for the username or partial match for the firstname, lastname, username and email altogether, using the &quot;search_text&quot; parameter, possible values (&quot;full&quot;, &quot;partial&quot;), default = &quot;partial&quot;"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to search in first name, last name, email and username of the users. To search for special characters we suggest to use a URL encoding, to be sure the characters will be correctly recognize (for example: user+name encoded user%2Bname)"},{"in":"query","name":"filters","type":"string","required":false,"description":"serialize object containing list of filters and their options. List of filters - ( code:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, sold_to:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, bundle_name:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, plan_name:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains} )"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"exclude","type":"array","required":false,"description":"List of user IDs to exclude from result"},{"in":"query","name":"exclude_power_users_and_super_admins","type":"integer","required":false,"description":"Exclude all power users and super admins from result. Default: disabled"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previosuly obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default=0"},{"in":"query","name":"slack_id","type":"string","required":false,"description":"Slack ID used to filter the result user"},{"in":"query","name":"active","type":"boolean","required":false,"description":"If true show only active not expired users"},{"in":"query","name":"search_additional_field_id","type":"integer","required":false,"description":"If given, filters users by the specified additional field."},{"in":"query","name":"search_additional_field_value","type":"string","required":false,"description":"The additional field value to filter users with. The additional field is indicated by &#039;search_additional_field_id&#039;."},{"in":"query","name":"not_paginated","type":"boolean","required":false,"description":"If true will return the results not paginated"},{"in":"query","name":"include_user","type":"boolean","required":false,"description":"If true will return the results with the current user; Default: false"},{"in":"query","name":"updated_from","type":"datetime","required":false,"description":"If provided, the API will return only users updated after the given datetime (in yyyy-MM-dd hh:mm:ss format)"},{"in":"query","name":"get_currently_logged_users_count","type":"boolean","required":false,"description":"If true the count of found items will be returned. Default false"},{"in":"query","name":"use_starts_with","type":"boolean","required":false,"description":"If true, the text search on the firstname, lastname, username and email fields uses the &quot;starts with&quot; logic instead of the default &quot;contains&quot; logic. IMPORTANT NOTE: when set to true, only the fields firstname, lastname, username and email are searched."}],"summary":"Returns list of Users","last_modified_date":"2026.02.10","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserIndexResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/delete":{"delete":{"tags":["User"],"operationId":"User./manage/v1/user/delete","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserDeleteSchema"}}],"summary":"Deletes an user","last_modified_date":"","description":"When called outside the platform UI (e.g. via Postman, Swagger, or DST JWT), the","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserDeleteResponse"}},"400":{"description":"General Error","error_codes":{"4000":"Invalid deletion data","4001":"Unsuccessful backup of users for deletion","4002":"Unsuccessful deleted users","4003":"Invalid parameter, count exceeds threshold limit"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/{id}":{"put":{"tags":["User"],"operationId":"User./manage/v1/user/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserUpdateSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"Id of selected user."}],"summary":"Updates an existing user with the provided account information","last_modified_date":"2024.07.23","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserUpdateResponse"}},"400":{"description":"General Error","error_codes":{"400":"Can't update the password as a normal user","403":"Can't update one or more fields due to a permission error","1002":"Validation error messages","1003":"Validation error messages","1004":"User does not exist error message","1005":"This account is used by Docebo's Help Desk team error message","4001":"Cannot update account information when impersonated by a Power User"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/{user_id}":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/{user_id}","parameters":[{"in":"path","name":"user_id","type":"integer","required":true,"description":"ID of the user"}],"summary":"View a User's info","last_modified_date":"2024.04.05","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserViewResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid user_id","1001":"User does not exist"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/list":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/list","parameters":[{"in":"query","name":"branch_ids","type":"array","required":false,"description":"Filter the results to only these branch IDs (and their descendants). NOTE: this parameter can&#039;t be set in the api browser page, a direct call can be made using a query string similar to this: (base-url)/manage/v1/user/list?branch_ids[0][id]=1&amp;branch_ids[0][include_descendants]=true"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"group_ids","type":"array","required":false,"description":"Filter the results by users that are members of the group IDs"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"user_ids","type":"array","required":false,"description":"User IDs for which we want to retrieve metadata/fields"},{"in":"query","name":"expand","type":"string","required":false,"description":"Comma separated list of &#039;fields&#039; which should be included in the API response for each item. Future use cases might introduce support for other fields that can be returned. For now the available fields are : id, username, firstname, lastname, email, uuid and avatar. Default value: id"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 20"},{"in":"query","name":"include_inactive","type":"boolean","required":false,"description":"Include inactive users"},{"in":"query","name":"active","type":"boolean","required":false,"description":"If true show only active not expired users"},{"in":"query","name":"start_from","type":"integer","required":false,"description":"If provided should return all users with id bigger than provided integer value. Default 0."}],"summary":"Get array of users with predefined selection fields","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserListResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/login":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/login","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserLoginSchema"}}],"summary":"Generate access token for user, by provided username and password","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserLoginResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Could not initialize OAuth2 server.","1002":"Missing parameter \"username\".","1003":"Missing parameter \"password\".","1004":"Wrong credentials provided.","1005":"Blocked for 10 minutes.","1006":"Platform has expired.","1007":"Your new account is currently being reviewed by the platform Admin. Please try again later.","1008":"Invalid parameter client_timezone"}},"500":{"description":"Internal server error"}}}},"/manage/v1/user/session":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/session","parameters":[{"in":"query","name":"referral_id","type":"string","required":false,"description":"Referral ID of a content partner"},{"in":"query","name":"theme","type":"string","required":false,"description":"The theme code to preview. If passed, the returned branding_elements will be loaded based on this value, rather than the active theme"}],"summary":"Get specific information about currently logged user.","last_modified_date":"2024.09.27","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserSessionResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/logout":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/logout","parameters":[],"summary":"Invalidate user token","last_modified_date":"","description":"Invalidate the token passed to the endpoint","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserLogoutResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Could not log out"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/password":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/password","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserPasswordSchema"}}],"summary":"Change user password","last_modified_date":"","description":"When the API is called with action \"set_new_password\", the password will be changed for the authorized user and the \"current_password\" attribute is required.<br />When the API is called with action \"send_link\", the API generates the reset token and sends an email to the user.<br />When the API is called with action \"reset\", the API does the actual writing of the password.<br />When the API is called with action \"validate_reset_token\", the API check whether the user and token exist or not and if the token has expired.<br />","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserPasswordResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Please provide the required parameters","1002":"Please provide username or email","1003":"Please make sure to enter a username or an email that is of an existing user","1004":"This user has been deactivated, or his active status has expired.","1005":"Activation code not valid","1006":"Please make sure to enter a username or an email that is of an existing user","1007":"Message for not success password strength check","1008":"Failed to change the password for unknown reason","1009":"Error while processing the requested operation","1010":"User is not logged in","1011":"The password you entered is not your current one.","1012":"The password must be different from the last {0} used passwords.","1013":"User is not associated with this multidomain","1014":"Invalid username or security code","1015":"Too many attempts on password recovery","4001":"Cannot change password when impersonated by a Power User"}},"500":{"description":"Internal server error"}}}},"/manage/v1/user/register":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/register","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserRegisterSchema"}}],"summary":"User registration","last_modified_date":"2024.04.05","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserRegisterResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Validation error messages","5002":"Privacy policy validation error"}},"500":{"description":"Internal server error"}}}},"/manage/v1/user/keep_alive":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/keep_alive","parameters":[],"summary":"Keep user session alive","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserKeepAliveResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/{id_user}/settings":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/{id_user}/settings","parameters":[{"in":"path","name":"id_user","type":"integer","required":true,"description":"ID of user to get settings"}],"summary":"Get setting information about specific user.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserGetUserSettingsResponse"}},"400":{"description":"General Error","error_codes":{"401":"User not logged","1002":"User with this id not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"post":{"tags":["User"],"operationId":"User./manage/v1/user/{id_user}/settings","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserSetUserSettingsSchema"}},{"in":"path","name":"id_user","type":"integer","required":true,"description":"ID of user to save settings"}],"summary":"Set setting information about specific user.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserSetUserSettingsResponse"}},"400":{"description":"General Error","error_codes":{"400":"Bad request","401":"User not logged","1002":"User with this id not found","1003":"Invalid parameter - id_user.","1004":"Invalid parameter - settings.","4001":"Cannot set setting information when impersonated by a Power User"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/confirm_email":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/confirm_email","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserConfirmEmailSchema"}}],"summary":"Registration confirmation email","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserConfirmEmailResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Please provide the required parameters","1002":"Confirm registration error message"}},"500":{"description":"Internal server error"}}}},"/manage/v1/user/temp_details/{id_user}":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/temp_details/{id_user}","parameters":[{"in":"path","name":"id_user","type":"integer","required":true,"description":"ID of user"}],"summary":"Get information from temporary user.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserTempDetailsResponse"}},"400":{"description":"General Error","error_codes":{"400":"Bad request","1002":"Invalid parameter - user_id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/change_status":{"put":{"tags":["User"],"operationId":"User./manage/v1/user/change_status","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserChangeStatusSchema"}}],"summary":"Updates an user status","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserChangeStatusResponse"}},"400":{"description":"General Error","error_codes":{"2000":"Please provided user_ids","2001":"Please provided status","2002":"Invalid status"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/mass_edit":{"put":{"tags":["User"],"operationId":"User./manage/v1/user/mass_edit","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserMassEditSchema"}}],"summary":"Updates existing users with the provided account information","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserMassEditResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Validation error messages","1003":"Validation error messages","1004":"User doesn't exists"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/add_to_branch":{"put":{"tags":["User"],"operationId":"User./manage/v1/user/add_to_branch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserAddToBranchSchema"}}],"summary":"Adds users to branches","last_modified_date":"","description":"This API would not be working for platforms created after 16/10/2019.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserAddToBranchResponse"}},"400":{"description":"General Error","error_codes":{"2000":"Invalid branch_ids","2001":"Invalid user_ids","2002":"No valid user_ids provided","2003":"No valid branch_ids provided","2004":"No valid data provided","2005":"DB problem"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/remove_from_branch":{"put":{"tags":["User"],"operationId":"User./manage/v1/user/remove_from_branch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserRemoveFromBranchSchema"}}],"summary":"Removes users from branches","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserRemoveFromBranchResponse"}},"400":{"description":"General Error","error_codes":{"2000":"Invalid branch_ids","2001":"Invalid user_ids","2002":"No valid user_ids provided","2003":"No valid branch_ids provided","2004":"Operation Remove is not allowed on the root branch","2005":"Branch [branch_id] does not have user(s) [user_ids] assigned to it"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/move_to_branch":{"put":{"tags":["User"],"operationId":"User./manage/v1/user/move_to_branch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserMoveToBranchSchema"}}],"summary":"Move users from one branch to another branch","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserMoveToBranchResponse"}},"400":{"description":"General Error","error_codes":{"2000":"Invalid branch_ids","2001":"Invalid user_ids","2002":"No valid user_ids provided (None of the User IDs is present in the db)","2003":"No valid branch_ids provided (None of the Branch IDs is present in the db)","2004":"No valid data provided (Some/All the users are already assigned to the given branches)","2005":"DB problem","2006":"You don't have permission to move users to a branch to which you are not assigned","2007":"Invalid parameter: branch ids"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/approve":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/approve","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserApproveUserSchema"}}],"summary":"Approve temporary users","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserApproveUserResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Temporary user not found! ","1002":"A user with the username \"username\" already exists.","1003":"Something went wrong.","1004":"Please provide user ID/s"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/reject":{"delete":{"tags":["User"],"operationId":"User./manage/v1/user/reject","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserRejectUserSchema"}}],"summary":"Reject temporary user","last_modified_date":"2023.10.24","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserRejectUserResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Temporary user not found!","1002":"Something went wrong."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/check_validity":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/check_validity","parameters":[{"in":"query","name":"userid","type":"string","required":false,"description":"Username"},{"in":"query","name":"email","type":"string","required":false,"description":"Email"},{"in":"query","name":"uuid","type":"string","required":false,"description":"UUID"}],"summary":"Check if given username is free","last_modified_date":"2023.02.20","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserCheckValidityResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/{id}/resend":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/{id}/resend","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"Id of selected user."}],"summary":"Resend registration email to a pending user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserResendResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Validation error messages"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/importer_fields":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/importer_fields","parameters":[],"summary":"Returns list of mappable fields for the data importer","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserImporterFieldsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/export":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/export","parameters":[{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"user_ids","type":"array","required":true,"description":"User IDs to be exported"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"additional_field_ids","type":"array","required":false,"description":"Additional fields IDs to be included in export"},{"in":"query","name":"user_id","type":"boolean","required":false,"description":"If user ID must be included in export"},{"in":"query","name":"username","type":"boolean","required":false,"description":"If username must be included in export"},{"in":"query","name":"first_name","type":"boolean","required":false,"description":"If user first name must be included in export"},{"in":"query","name":"last_name","type":"boolean","required":false,"description":"If user last name must be included in export"},{"in":"query","name":"email","type":"boolean","required":false,"description":"If user email must be included in export"},{"in":"query","name":"uuid","type":"boolean","required":false,"description":"If user uuid must be included in export"},{"in":"query","name":"is_manager","type":"boolean","required":false,"description":"If user is a manager must be included in export"},{"in":"query","name":"creation_date","type":"boolean","required":false,"description":"If user creation date must be included in export"},{"in":"query","name":"expiration_date","type":"boolean","required":false,"description":"If user expiration date must be included in export"},{"in":"query","name":"email_validation_status","type":"boolean","required":false,"description":"If user email validation status must be included in export"},{"in":"query","name":"last_access_date","type":"boolean","required":false,"description":"If user last access date must be included in export"},{"in":"query","name":"language","type":"boolean","required":false,"description":"If language must be included in export"},{"in":"query","name":"include_header","type":"integer","required":false,"description":"Include or NOT naming of columns in csv/xls file"},{"in":"query","name":"export_format","type":"string","required":false,"description":"Format of exported file csv/xls file. Options: &quot;csv&quot; or &quot;xls&quot;. Default: &quot;xls&quot;"},{"in":"query","name":"delimiter","type":"string","required":false,"description":"Delimiter for exported csv file/ Default: &quot;,&quot;"},{"in":"query","name":"level","type":"boolean","required":false,"description":"If user level must be included in export"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"managers","type":"array","required":false,"description":"List of Manager Types IDs to be exported"},{"in":"query","name":"send_notification","type":"boolean","required":false,"description":"If user send notification must be included in export"},{"in":"query","name":"authenticatorapp_paired","type":"boolean","required":false,"description":"If user has paired authenticator app. The API accepts this parameter only if EsignatureApp is activated, enabled and AuthenticatorApp setting is checked"}],"summary":"Export users","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserExportResponse"}},"400":{"description":"General Error","error_codes":{"2000":"Please provide user_ids","2001":"Please provide at least one field (Users fields or Additional fields)","2002":"Invalid parameter: authenticatorapp_paired"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/batch":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserBatchImportUserSchema"}}],"summary":"Batch import users","last_modified_date":"2024.07.24","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserBatchImportUserResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Maximum number of records exceeded","1002":"No default destination branch selected","1003":"Invalid default destination branch","1004":"Invalid destination branch option set","1005":"Invalid value for option","1006":"Required option not set","1007":"Non-numeric value set for destination_branch"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/quick_registration":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/quick_registration","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserQuickRegistrationSchema"}}],"summary":"User \"Quick\" registration (only by providing email)","last_modified_date":"2022.05.11","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserQuickRegistrationResponse"}},"400":{"description":"General Error","error_codes":{"3000":"Please accept Privacy Policy","3001":"Please provide email","3002":"Email validation error","3003":"Please provide valid email","4000":"Save validation error messages"}},"500":{"description":"Internal server error"}}}},"/manage/v1/user/send_notification":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/send_notification","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserSendNotificationSchema"}}],"summary":"Raise event for sending notification \"UserCreatedByAdmin\"","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserSendNotificationResponse"}},"400":{"description":"General Error","error_codes":{"2001":"Please provide user_ids","2002":"Some users have already received this notification"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/{user_id}/domains":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/{user_id}/domains","parameters":[{"in":"path","name":"user_id","type":"integer","required":true,"description":"The user id"}],"summary":"Retrieve the list of domains available for the given user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserGetUserDomainsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/{user_id}/merge/{user_id_2}":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/{user_id}/merge/{user_id_2}","parameters":[{"in":"path","name":"user_id","type":"integer","required":true,"description":"ID of the source user"},{"in":"path","name":"user_id_2","type":"integer","required":true,"description":"ID of the destination user"}],"summary":"Retrieve merge users detailed information included first chunk of enrollments, subscriptions, badges, transactions","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserDetailsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Destination user must be different from the source user!","1002":"Source user not found.","1003":"Source user can't be super admin or power user!","1004":"Destination user not found.","1005":"Destination user can't be super admin or power user!"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["User"],"operationId":"User./manage/v1/user/{user_id}/merge/{user_id_2}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserMergeUsersSchema"}},{"in":"path","name":"user_id","type":"integer","required":true,"description":"ID of the source user"},{"in":"path","name":"user_id_2","type":"integer","required":true,"description":"ID of the destination user"}],"summary":"Merge the data from one user to another","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserMergeUsersResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Destination user must be different from the source user!","1002":"Source user not found.","1003":"Source user can't be super admin or power user!","1004":"Destination user not found.","1005":"Destination user can't be super admin or power user!","1006":"Something went wrong!"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/{user_id}/merge/{user_id_2}/enrollments":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/{user_id}/merge/{user_id_2}/enrollments","parameters":[{"in":"path","name":"user_id","type":"integer","required":true,"description":"ID of the source user"},{"in":"path","name":"user_id_2","type":"integer","required":true,"description":"ID of the destination user"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id. Options: id, course_name"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 200"}],"summary":"Retrieve all course enrollments for users to merge","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserListEnrollmentsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Destination user must be different from the source user!","1002":"Source user not found.","1003":"Source user can't be super admin or power user!","1004":"Destination user not found.","1005":"Destination user can't be super admin or power user!"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/{user_id}/merge/{user_id_2}/badges":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/{user_id}/merge/{user_id_2}/badges","parameters":[{"in":"path","name":"user_id","type":"integer","required":true,"description":"ID of the source user"},{"in":"path","name":"user_id_2","type":"integer","required":true,"description":"ID of the destination user"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id. Options: id, badge_name"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 200"}],"summary":"List merge users badges","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserListBadgesResponse"}},"400":{"description":"General Error","error_codes":{"1000":"GamificationApp app is not activated!","1001":"Destination user must be different from the source user!","1002":"Source user not found.","1003":"Source user can't be super admin or power user!","1004":"Destination user not found.","1005":"Destination user can't be super admin or power user!"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/{user_id}/merge/{user_id_2}/transactions":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/{user_id}/merge/{user_id_2}/transactions","parameters":[{"in":"path","name":"user_id","type":"integer","required":true,"description":"ID of the source user"},{"in":"path","name":"user_id_2","type":"integer","required":true,"description":"ID of the destination user"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id. Options: id, date_creation"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 200"}],"summary":"List merge users transactions","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserListTransactionsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Destination user must be different from the source user!","1002":"Source user not found.","1003":"Source user can't be super admin or power user!","1004":"Destination user not found.","1005":"Destination user can't be super admin or power user!"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/{user_id}/merge/{user_id_2}/subscriptions":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/{user_id}/merge/{user_id_2}/subscriptions","parameters":[{"in":"path","name":"user_id","type":"integer","required":true,"description":"ID of the source user"},{"in":"path","name":"user_id_2","type":"integer","required":true,"description":"ID of the destination user"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id. Options: id, bundle_name"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 200"}],"summary":"Retrieve all subscriptions for users to merge","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserListSubscriptionsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Destination user must be different from the source user!","1002":"Source user not found.","1003":"Source user can't be super admin or power user!","1004":"Destination user not found.","1005":"Destination user can't be super admin or power user!"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/{manager_id}/subordinates":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/{manager_id}/subordinates","parameters":[{"in":"path","name":"manager_id","type":"integer","required":true,"description":"ID of manager to get subordinates"},{"in":"query","name":"hierarchy","type":"integer","required":false,"description":"Type of manager (1 for Direct manager, other codes reserved for future improvements). Default - 1"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by id, username, name, or email of user. Default - id"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 200"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"}],"summary":"Retrieves all the subordinates of a Manager","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserGetSubordinatesResponse"}},"400":{"description":"General Error","error_codes":{"1601":"Invalid parameter - manager_id.","1602":"Invalid parameter - hierarchy."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/managers":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/managers","parameters":[{"in":"query","name":"search_text","type":"string","required":false,"description":"Search all string fields for this value"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"relation_ids","type":"array","required":false,"description":"Filter by ids of the manager subordinate relation records"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"manager_ids","type":"array","required":false,"description":"Filter by ids of the managers"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"manager_type_ids","type":"array","required":false,"description":"Filter by ids of the manager types"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"manager_type_statuses","type":"array","required":false,"description":"Filter by statuses Possible values (&#039;confirmed&#039;, &#039;not_confirmed&#039;, &#039;pending&#039;, &#039;imported&#039;)"}],"summary":"List of all the managers for the current user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserMyManagersResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter search_text","1002":"Invalid parameter relation_ids","1003":"Invalid parameter manager_ids","1004":"Invalid parameter manager_type_ids","1005":"Invalid parameter manager_type_statuses"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/newsletter":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/newsletter","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserNewsletterSchema"}}],"summary":"Opt-out from newsletter delivery","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserNewsletterResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Please provide the required parameters"}},"500":{"description":"Internal server error"}}}},"/manage/v1/users/events/download":{"get":{"tags":["User"],"operationId":"User./manage/v1/users/events/download","parameters":[{"in":"query","name":"id","type":"integer","required":false,"description":"The user ID. If not set, it&#039;s the logged-in user&#039;s ID."},{"in":"query","name":"token","type":"string","required":false,"description":"The hash for the user."},{"in":"query","name":"start_date","type":"string","required":false,"description":"Filter events after this date. Default: 1900-01-01"},{"in":"query","name":"end_date","type":"string","required":false,"description":"Filter events before this date. Default: 9999-12-31"}],"summary":"Get events filtered by user, range of date and category","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserDownloadEventsResponse"}},"400":{"description":"General Error","error_codes":{"1100":"Invalid user_id","1200":"Empty start_date (not activated now)","1201":"Invalid start_date format","1202":"Empty end_date (not activated now)","1203":"Invalid end_date format","1204":"Invalid end_date before start_date","1300":"Invalid token"}},"500":{"description":"Internal server error"}}}},"/manage/v1/user/batch_delete":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/batch_delete","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserBatchDeleteSchema"}}],"summary":"Batch delete users","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserBatchDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid deletion data","4003":"Invalid parameter, count exceeds threshold limit"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/activities":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/activities","parameters":[{"in":"query","name":"id_user","type":"integer","required":false,"description":"ID of the user. If not provided - current logged user will be used"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"activities","type":"array","required":true,"description":"Array contains what activity should be returned. ( For example: &#039;sessions&#039;, &#039;enrollments&#039;, &#039;course_enrollments&#039;, &#039;best_score_in_classroom&#039; )"},{"in":"query","enum":["all","year","month","week"],"name":"timeframe","type":"string","required":true,"description":"Time range for activity statistic"}],"summary":"Get user activities information like number of visited session per month, enrollments per month","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserActivitiesResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/levels":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/levels","parameters":[],"summary":"Retrieve information about the currently available levels within the platform","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserLevelsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/send_mail":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/send_mail","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserSendMailSchema"}}],"summary":"Send message to user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserSendMailResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter: {X}","1002":"Invalid email. Please insert an email address that complies with the email security settings criteria configured in Domain Management"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/{user_id}/groups":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/{user_id}/groups","parameters":[{"in":"path","name":"user_id","type":"string","required":true,"description":"Id of the user, or its internal alphanumerical name or email"},{"in":"query","name":"use_secondary_identifier","type":"boolean","required":false,"description":"Interpret id param as secondary identifier (i.e. alphanumeric user name or email). Default is false."},{"in":"query","name":"language","type":"string","required":false,"description":"translation language for organization chart folders (if not specified, default language is used)"}],"summary":"Groups and folders are returned in separate arrays","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserGetGroupsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid user specification"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/menu":{"get":{"tags":["User"],"operationId":"User./manage/v1/user/menu","parameters":[],"summary":"Get navigation menu","last_modified_date":"2026.01.07","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserMenuResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/export-certificates-data":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/export-certificates-data","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserExportCertificatesDataSchema"}}],"summary":"Launches a job to export users data related to certificates, returns the id of the job which will generate all files needed.","last_modified_date":"2025.04.23","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserExportCertificatesDataResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing required parameter: {X}","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user/menu/favorite/{page_id}":{"post":{"tags":["User"],"operationId":"User./manage/v1/user/menu/favorite/{page_id}","parameters":[{"in":"path","name":"page_id","type":"string","required":true,"description":"Page id to insert as favorite"}],"summary":"Add a page to favorites","last_modified_date":"2025.12.23","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserAddMenuFavoriteResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Unexpected error while inserting favorite","1010":"Invalid parameter: page_id","1020":"Max favorites reached: 200"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["User"],"operationId":"User./manage/v1/user/menu/favorite/{page_id}","parameters":[{"in":"path","name":"page_id","type":"string","required":true,"description":"Page id to remove from favorites"}],"summary":"Delete a page from favorites","last_modified_date":"2025.12.23","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserRemoveMenuFavoriteResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Unexpected error while deleting favorite","1010":"Invalid parameter: page_id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/user_fields":{"post":{"tags":["Userfield"],"operationId":"Userfield./manage/v1/user_fields","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserfieldCreateSchema"}}],"summary":"Create user field","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserfieldCreateResponse"}},"400":{"description":"General Error","error_codes":{"1100":"You don't have permissions for this action.","1101":"Missing parameter - type.","1102":"Invalid parameter - type.","1103":"Missing parameter - translations.","1104":"Please provide translation on system default language.","1105":"Missing parameter - dropdown_options.","1106":"Invalid parameter - dropdown_options.","1107":"Parameters 'url, field_name, iframe_height' are mandatory for field type 'iframe'","1112":"The iframe field type cannot be mandatory","1013":"Cannot have more than <MORE_USER_DROPDOWN_OPTIONS_LIMIT> options for a field of type 'dropdown'"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Userfield"],"operationId":"Userfield./manage/v1/user_fields","parameters":[{"in":"query","name":"branch_ids","type":"array","required":false,"description":"Filter user additional fields by branch - it applies field visibility by branch. Will be merged with the &quot;branch_codes&quot; parameter"},{"in":"query","name":"branch_codes","type":"array","required":false,"description":"Filter user additional fields by branch - it applies field visibility by branch. Will be merged with the &quot;branch_ids&quot; parameter"},{"in":"query","name":"user_id","type":"integer","required":false,"description":"Filter user additional fields by user ID. If  it is passed and branch_ids is not not passed, the branches of requested user will be taken."},{"in":"query","name":"as_array","type":"integer","required":false,"description":"If it is not passed the responce will be simplified paginated list. If it is passed the responce will contains fully filled list (drop down with options, filled countries, etc.)"},{"in":"query","name":"skip_all","type":"integer","required":false,"description":"Set this parameter to 1 in cases when the condition is to return empty array if the requested branch has no visibility set, instead of an array with all fields."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search text in the user fields properties"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id. Options: title, id"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 10"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"in":"query","name":"multidomain","type":"integer","required":false,"description":"If 1 and no folder was send it will check also for the multidomain specific folder assigned fields. Options: 0, 1 default 0"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previosuly obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default=0"}],"summary":"Retrieves the list of user additional fields, filtered on input parameters","last_modified_date":"","description":"All filter parameters are optional. If filter parameters are provided operation is OR for user_field_title and AND among other parameters","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserfieldIndexResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Please provide valid branch id.","1200":"Invalid parameter - lang.","1002":"Invalid parameter type"}},"500":{"description":"Internal server error"}}}},"/manage/v1/user_fields/{field_id}":{"delete":{"tags":["Userfield"],"operationId":"Userfield./manage/v1/user_fields/{field_id}","parameters":[{"in":"path","name":"field_id","type":"integer","required":true,"description":"Id of selected field."}],"summary":"Deletes one user field","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserfieldDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1090":"Invalid parameter - id.","1002":"Cannot delete a system field"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Userfield"],"operationId":"Userfield./manage/v1/user_fields/{field_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/ManageUserfieldUpdateSchema"}},{"in":"path","name":"field_id","type":"integer","required":true,"description":"Id of selected field."}],"summary":"Update user fields","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserfieldUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Additional field with id: idNum doesn\\'t exist.","1003":"Please provide field name","1107":"Parameter url is mandatory for field type 'iframe'","1108":"Parameter field_name is mandatory for field type 'iframe'","1109":"Parameter iframe_height is mandatory for field type 'iframe'","1111":"Invalid parameter iframe_height","1012":"It is not possible to edit this field","1013":"Cannot have more than <MORE_USER_DROPDOWN_OPTIONS_LIMIT> options for a field of type 'dropdown'","1014":"Dropdown options {X} deletion not possible. The following automatic groups are using it: {Y}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Userfield"],"operationId":"Userfield./manage/v1/user_fields/{field_id}","parameters":[{"in":"path","name":"field_id","type":"integer","required":true,"description":"Id of selected field."}],"summary":"Get User addtional filds info","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageUserfieldViewResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Additional field with id 7777 doesn't exist"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/manage/v1/workforce/skills":{"get":{"tags":["Workforce"],"operationId":"Workforce./manage/v1/workforce/skills","parameters":[{"in":"query","name":"search","type":"string","required":false,"description":"Search term"},{"in":"query","name":"occupation_code","type":"string","required":false,"description":"Occupation Code"},{"in":"query","name":"size","type":"integer","required":false,"description":"Max Number of returning item. (default 20)"},{"in":"query","name":"skip_skillgroup","type":"boolean","required":false,"description":"If passed, skillgroup filter will be ignored. Available to SuperAdmins only. Default=false"}],"summary":"Search a skill from Workforce service","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/ManageWorkforceSearchSkillResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}}},"securityDefinitions":{"docebo_oauth":{"type":"oauth2","flow":"implicit","tokenUrl":"/oauth2/token","authorizationUrl":"/oauth2/authorize","scopes":{"api":"Common scope, used by the whole API"}}},"security":[{"docebo_oauth":["api"]}],"definitions":{"localizable":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the localizable object. This controls whether or not the value or values property below will be populated.","collectionFormat":"brackets","enum":["single_value","multi_lang"]},"value":{"type":"string","description":"The scalar value of this localizable object, used for all languages. Only populated when \"type=single_value\"."},"values":{"type":"object","description":"A lang_code=>value structured object with the different localized names of the item, in each language, available within the platform."}}},"ManageAuth0LoginSchema":{"type":"object","required":["token","type"],"properties":{"token":{"type":"string","description":"token, returned from Auth0"},"type":{"type":"string","description":"type of the login, can be &#039;host_page&#039; or &#039;embed&#039;"},"profile":{"type":"string","description":"user profile, returned from Auth0, if any /only when &quot;type&quot; is &quot;embed&quot;/"}}},"ManageAuth0LoginResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageAuth0LoginData","description":"Array of info for each category"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageAuth0LoginData":{"required":["userId","url"],"properties":{"userId":{"type":"integer","description":"user id"},"url":{"type":"string","description":"redirect url after login"}}},"ManageAuth0SettingsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageAuth0SettingsData","description":"Array of info for Auth0 settings"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageAuth0SettingsData":{"required":["id","id_multidomain","client_id","domain","audience","username_attr","user_provisioning_update","sso_login_button","login_behavior","logout","logout_url","fields","lock_provisioned_user_fields"],"properties":{"id":{"type":"integer","description":""},"id_multidomain":{"type":"integer","description":""},"client_id":{"type":"string","description":""},"user_provisioning":{"type":"integer","description":"Only available for superadministrators."},"domain":{"type":"string","description":""},"audience":{"type":"string","description":""},"username_attr":{"type":"string","description":"Only available for superadministrators."},"user_provisioning_update":{"type":"integer","description":"Only available for superadministrators."},"sso_login_button":{"type":"integer","description":""},"login_behavior":{"type":"string","description":""},"logout":{"type":"integer","description":""},"logout_url":{"type":"string","description":""},"fields":{"type":"string","description":"Only available for superadministrators."},"lock_provisioned_user_fields":{"type":"integer","description":"Only available for superadministrators."}}},"ManageCentralrepoGetCategoriesResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageCentralrepoGetCategoriesData","description":"Array of info for each category"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageCentralrepoGetCategoriesData":{"required":["items","extra_data"],"properties":{"items":{"type":"array","description":"Array containing CLOR category information","items":{"$ref":"#/definitions/ManageCentralrepoGetCategoriesItems"}},"extra_data":{"type":"array","description":"Array containing the information of the root category","items":{"$ref":"#/definitions/ManageCentralrepoGetCategoriesExtraData"}}}},"ManageCentralrepoGetCategoriesItems":{"required":["id","title","count"],"properties":{"id":{"type":"string","description":"Stringified category ID"},"title":{"type":"string","description":"Category title"},"action":{"type":"array","description":"May contain allowed actions on this element","items":{"$ref":"#/definitions/ManageCentralrepoGetCategoriesAction"}},"count":{"type":"integer","description":"Total number of categories"}}},"ManageCentralrepoGetCategoriesAction":{"required":["has_children"],"properties":{"has_children":{"type":"boolean","description":"Tells if this category contains child categories"},"icon":{"type":"string","description":"May contain an icon path"},"color":{"type":"string","description":"May contain a color code"},"tooltip":{"type":"string","description":"May contain a tooltip"}}},"ManageCentralrepoGetCategoriesExtraData":{"required":["id","title"],"properties":{"id":{"type":"string","description":"Stringified category ID"},"title":{"type":"string","description":"Category title"},"actions":{"type":"array","description":"May contain allowed actions on this element","items":{"$ref":"#/definitions/ManageCentralrepoGetCategoriesActions"}}}},"ManageCentralrepoGetCategoriesActions":{"required":["has_children"],"properties":{"has_children":{"type":"boolean","description":"Tells if this category contains child categories"},"icon":{"type":"string","description":"May contain an icon path"},"color":{"type":"string","description":"May contain a color code"},"tooltip":{"type":"string","description":"May contain a tooltip"}}},"ManageCentralrepoGetImportedObjectsData":{"properties":{"provider_id":{"type":"array","description":"Internal ID for the CSP","items":{"$ref":"#/definitions/ManageCentralrepoGetImportedObjectsProviderId"}}}},"ManageCentralrepoGetImportedObjectsResponse":{"properties":{"data":{"$ref":"#/definitions/ManageCentralrepoGetImportedObjectsData","description":"Main response"},"version":{"type":"string","required":"required","description":"Current API version"}},"required":["version"]},"ManageCentralrepoGetImportedObjectsProviderId":{"required":["id","title","provider"],"properties":{"id":{"type":"string","description":"Id of the imported object"},"title":{"type":"string","description":"Course title"},"url":{"type":"array","description":"LTI Launch URL","items":{"$ref":"#/definitions/ManageCentralrepoGetImportedObjectsUrl"}},"provider":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageCentralrepoGetImportedObjectsProvider"}}}},"ManageCentralrepoGetImportedObjectsUrl":{},"ManageCentralrepoGetImportedObjectsProvider":{},"ManageChannelsUpdateSchema":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"Channel description"}}},"ManageChannelsUpdateResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageChannelsUpdateData","description":"ID of updated record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageChannelsUpdateLinks"}}}},"ManageChannelsUpdateData":{"required":["items"],"properties":{"items":{"$ref":"#/definitions/ManageChannelsUpdateItems","description":"array"}}},"ManageChannelsUpdateItems":{"required":["id","lang","name","description"],"properties":{"id":{"type":"integer","description":"ID of the channel"},"lang":{"type":"string","description":"Language of the channel"},"name":{"type":"string","description":"Name of the channel"},"description":{"type":"string","description":"Description of the channel"}}},"ManageChannelsUpdateLinks":{},"ManageChannelsViewChannelsToUserResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageChannelsViewChannelsToUserData","description":"Return response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/ManageChannelsViewChannelsToUserLinks"}}}},"ManageChannelsViewChannelsToUserData":{"required":["items","count","cursor","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"List of channels","items":{"$ref":"#/definitions/ManageChannelsViewChannelsToUserItems"}},"count":{"type":"integer","description":"Total number of items returned"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of items existing"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageChannelsViewChannelsToUserSort"}}}},"ManageChannelsViewChannelsToUserItems":{"required":["id","name","created","ordering","avatar","thumbnail","upload_permission"],"properties":{"id":{"type":"string","description":"The channel ID"},"name":{"type":"string","description":"The channel name"},"created":{"type":"string","description":"The channel date of creation"},"ordering":{"type":"string","description":"The channel position"},"avatar":{"type":"string","description":"Preferably to use thumbnail instead; Channel avatar&#039;s properties, separated with | ex: #000|#FFF|fa-500px --&gt; first is background color, second is icon color, third is icon name."},"thumbnail":{"$ref":"#/definitions/ManageChannelsViewChannelsToUserThumbnail","description":"Returns the channel thumbnail in the form of object"},"can_upload":{"type":"boolean","description":"Whether the current user can upload to channel"},"upload_permission":{"type":"string","description":"The upload permission. Possible value: [&#039;everyone&#039;, &#039;everyone_with_pr&#039;, &#039;experts_only&#039;]"},"is_expert":{"type":"boolean","description":"If the current user is expert of the channel"},"users_count":{"type":"integer","description":"Total count of users of the channel"}}},"ManageChannelsViewChannelsToUserThumbnail":{"required":["background","color","icon"],"properties":{"background":{"type":"string","description":"Channel thumbnail background color"},"color":{"type":"string","description":"Channel thumbnail icon color"},"icon":{"type":"string","description":"Channel thumbnail icon name"}}},"ManageChannelsViewChannelsToUserSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageChannelsViewChannelsToUserLinks":{},"ManageClickjackingToggleStatusSchema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Set to true to enable the clickjacking protection. Set to false to disable it."}}},"ManageClickjackingToggleStatusResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageClickjackingToggleStatusData","description":"Success or failure, with optional error message"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageClickjackingToggleStatusLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageClickjackingToggleStatusData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure"}}},"ManageClickjackingToggleStatusLinks":{},"ManageClickjackingViewStatusResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageClickjackingViewStatusData","description":"The clickjacking status"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageClickjackingViewStatusLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageClickjackingViewStatusData":{"required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"The clickjacking enabled status"}}},"ManageClickjackingViewStatusLinks":{},"ManageClickjackingWhitelistResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageClickjackingWhitelistData","description":"List of whitelisted domains"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageClickjackingWhitelistLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageClickjackingWhitelistData":{"required":["domains"],"properties":{"domains":{"type":"array","description":"Array of domains","items":{"type":"string"}}}},"ManageClickjackingWhitelistLinks":{},"ManageClickjackingDeleteWhitelistSchema":{"type":"object","properties":{"whitelist":{"type":"array","description":"The list of domains to remove from the whitelist. If omitted, the entire whitelist is cleared.","items":{"type":"string"}}}},"ManageClickjackingDeleteWhitelistResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageClickjackingDeleteWhitelistData","description":"Success or failure to delete the whitelisted domains"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageClickjackingDeleteWhitelistLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageClickjackingDeleteWhitelistData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure"}}},"ManageClickjackingDeleteWhitelistLinks":{},"ManageClickjackingSetWhitelistSchema":{"type":"object","required":["whitelist"],"properties":{"whitelist":{"type":"array","description":"The list of domains to whitelist. An empty array clears the whitelist.","items":{"type":"string"}}}},"ManageClickjackingSetWhitelistResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageClickjackingSetWhitelistData","description":"Success or failure, with optional error message"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageClickjackingSetWhitelistLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageClickjackingSetWhitelistData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure"}}},"ManageClickjackingSetWhitelistLinks":{},"ManageClickjackingUpdateWhitelistSchema":{"type":"object","required":["whitelist"],"properties":{"whitelist":{"type":"array","description":"The list of domains to add to whitelist.","items":{"type":"string"}}}},"ManageClickjackingUpdateWhitelistResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageClickjackingUpdateWhitelistData","description":"Success or failure, with optional error message"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageClickjackingUpdateWhitelistLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageClickjackingUpdateWhitelistData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure"}}},"ManageClickjackingUpdateWhitelistLinks":{},"ManageContentpartnerfieldsCreateSchema":{"type":"object","required":["type","translations"],"properties":{"type":{"type":"string","description":"User field type. Options: date, dropdown, textfield, textarea, etc"},"translations":{"$ref":"#/definitions/ManageContentpartnerfieldsCreateTranslations","description":"Array of translations, the system default language translation is mandatory"},"mandatory":{"type":"integer","description":"Mandatory - 1 or Not mandatory - 0. Default - 0"},"invisible_to_user":{"type":"integer","description":"User field is visible for users - 0 or not visible - 1. Default - 0"},"customizable":{"type":"boolean","description":"Whether the field is customizable or not. Accepts &#039;on&#039;, &#039;On&#039;, &#039;ON&#039;, &#039;off&#039;, &#039;Off&#039;, &#039;OFF&#039;, &#039;yes&#039;, &#039;Yes&#039;, &#039;YES&#039;, &#039;no&#039;, &#039;No&#039;, &#039;NO&#039;, 0, 1, &#039;0&#039;, &#039;1&#039;, &#039;true&#039;, &#039;True&#039;, &#039;TRUE&#039;, &#039;false&#039;, &#039;False&#039;, &#039;FALSE&#039;"},"settings":{"$ref":"#/definitions/ManageContentpartnerfieldsCreateSettings","description":"Settings - it&#039;s reqired if field type is &#039;iframe&#039;"},"dropdown_options":{"type":"array","description":"Array of dropdown options. If type of user field is dropdown, this parameter becomes required","items":{"$ref":"#/definitions/ManageContentpartnerfieldsCreateDropdownOptions"}}}},"ManageContentpartnerfieldsCreateTranslations":{"required":["__language_code__"],"properties":{"__language_code__":{"type":"string","description":"The key is code of the language or all - the value is title. For example en, all"}}},"ManageContentpartnerfieldsCreateSettings":{"required":["url","field_name"],"properties":{"url":{"type":"string","description":"Url - it&#039;s required if field type is &#039;iframe&#039;"},"field_name":{"type":"string","description":"Field name - it&#039;s reqired if field type is &#039;iframe&#039;"}}},"ManageContentpartnerfieldsCreateDropdownOptions":{"required":["translations"],"properties":{"translations":{"$ref":"#/definitions/ManageContentpartnerfieldsCreateTranslationsL2","description":"Array of translations, the system default language translation is mandatory"}}},"ManageContentpartnerfieldsCreateTranslationsL2":{"required":["language_code"],"properties":{"language_code":{"type":"string","description":"The key is the language or all - the value is title. For example english, all"}}},"ManageContentpartnerfieldsCreateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageContentpartnerfieldsCreateData","description":"ID of the created record"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageContentpartnerfieldsCreateData":{"required":["user_field_id"],"properties":{"user_field_id":{"type":"integer","description":"The internal ID for the newly created user field"}}},"ManageContentpartnerfieldsDeleteResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageContentpartnerfieldsDeleteData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageContentpartnerfieldsDeleteData":{"required":["errors","deleted"],"properties":{"errors":{"$ref":"#/definitions/ManageContentpartnerfieldsDeleteErrors","description":"Errors during process"},"deleted":{"type":"string","description":"ID of the successfully deleted item"}}},"ManageContentpartnerfieldsDeleteErrors":{"required":["message"],"properties":{"message":{"type":"integer","description":"Process that generated an error"}}},"ManageContentpartnerfieldsIndexResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageContentpartnerfieldsIndexData","description":"List of all retrieved user fields"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageContentpartnerfieldsIndexLinks","description":"Links to pages"}}},"ManageContentpartnerfieldsIndexData":{"required":["items"],"properties":{"items":{"type":"array","description":"Array of user fields info objects","items":{"$ref":"#/definitions/ManageContentpartnerfieldsIndexItems"}}}},"ManageContentpartnerfieldsIndexItems":{"required":["id_field","type","mandatory","invisible_to_user","sequence","title","settings","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"id_field":{"type":"integer","description":"ID of the user field"},"type":{"type":"string","description":"Type of the user field"},"mandatory":{"type":"string","description":"User field mandatory"},"invisible_to_user":{"type":"string","description":"Visible to user field"},"sequence":{"type":"integer","description":"User field order"},"title":{"type":"string","description":"User field title in the selected language"},"inherited":{"type":"boolean","description":"If this field is inherited from parent branch or branches"},"settings":{"type":"array","description":"List of settings","items":{"$ref":"#/definitions/ManageContentpartnerfieldsIndexSettings"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items returned. Returned if get_total_count parameter is 1"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageContentpartnerfieldsIndexSort"}}}},"ManageContentpartnerfieldsIndexSettings":{},"ManageContentpartnerfieldsIndexSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageContentpartnerfieldsIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageContentpartnerfieldsUpdateSchema":{"type":"object","properties":{"mandatory":{"type":"integer","description":"1 or 0."},"invisible_to_user":{"type":"integer","description":"1 or 0."},"sequence":{"type":"integer","description":"if not provided set as last"},"customizable":{"type":"boolean","description":"Whether the field is customizable or not. Accepts &#039;on&#039;, &#039;On&#039;, &#039;ON&#039;, &#039;off&#039;, &#039;Off&#039;, &#039;OFF&#039;, &#039;yes&#039;, &#039;Yes&#039;, &#039;YES&#039;, &#039;no&#039;, &#039;No&#039;, &#039;NO&#039;, 0, 1, &#039;0&#039;, &#039;1&#039;, &#039;true&#039;, &#039;True&#039;, &#039;TRUE&#039;, &#039;false&#039;, &#039;False&#039;, &#039;FALSE&#039;"},"settings":{"$ref":"#/definitions/ManageContentpartnerfieldsUpdateSettings","description":"Settings"},"translations":{"$ref":"#/definitions/ManageContentpartnerfieldsUpdateTranslations","description":"Array of translations, the system default language translation is mandatory"}}},"ManageContentpartnerfieldsUpdateSettings":{"properties":{"url":{"type":"string","description":"Url"},"field_name":{"type":"string","description":"Field name"}}},"ManageContentpartnerfieldsUpdateTranslations":{"required":["language_code"],"properties":{"language_code":{"type":"string","description":"The key is code of the language or all - the value is title. For example en, all"}}},"ManageContentpartnerfieldsUpdateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageContentpartnerfieldsUpdateData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageContentpartnerfieldsUpdateData":{"required":["field_id"],"properties":{"field_id":{"type":"integer","description":"Id of user field."},"error_messages":{"type":"array","description":"List of errors.","items":{"$ref":"#/definitions/ManageContentpartnerfieldsUpdateErrorMessages"}}}},"ManageContentpartnerfieldsUpdateErrorMessages":{},"ManageContentpartnerfieldsViewResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageContentpartnerfieldsViewData","description":"List of all user fields properties"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageContentpartnerfieldsViewData":{"required":["type","mandatory","invisible_to_user","settings"],"properties":{"type":{"type":"string","description":"Type of the user field"},"mandatory":{"type":"integer","description":"Is field mandatory"},"invisible_to_user":{"type":"integer","description":"Is field invisible to user"},"settings":{"type":"array","description":"List of settings","items":{"$ref":"#/definitions/ManageContentpartnerfieldsViewSettings"}}}},"ManageContentpartnerfieldsViewSettings":{"required":["translations"],"properties":{"translations":{"$ref":"#/definitions/ManageContentpartnerfieldsViewTranslations","description":"Translation of the user field"},"dropdown_options":{"$ref":"#/definitions/ManageContentpartnerfieldsViewDropdownOptions","description":"Translation of dropdown option"}}},"ManageContentpartnerfieldsViewTranslations":{"required":["__translation__"],"properties":{"__translation__":{"type":"string","description":"The key is language code the value is translation"}}},"ManageContentpartnerfieldsViewDropdownOptions":{"required":["option_id","__translations__"],"properties":{"option_id":{"type":"string","description":"Option ID"},"__translations__":{"type":"string","description":"The key is language code the value is translation"}}},"ManageContentpartnersDeleteResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageContentpartnersDeleteData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageContentpartnersDeleteData":{"required":["deleted_partner"],"properties":{"deleted_partner":{"type":"integer","description":"ID of the successfully deleted item"}}},"ManageContentpartnersUpdateSchema":{"type":"object","properties":{"status_only":{"type":"boolean","description":"If this is TRUE then only the status of the content partner is updated. Example: { status: true, active: 1 } (making it activated)"},"name":{"$ref":"#/definitions/ManageContentpartnersUpdateName","description":"Multi-lang field for the name of Content Partner"},"description":{"$ref":"#/definitions/ManageContentpartnersUpdateDescription","description":"Multi-lang field for the description of Content Partner"},"active":{"type":"boolean","description":"Is the content partner is activated"},"affiliate_code":{"type":"string","description":"Code for redemption of the affiliate price when buying a product"},"logo":{"type":"string","description":"Name of the file"},"code":{"type":"string","description":"Content partner code"},"city":{"type":"string","description":"Billing information City"},"country":{"type":"string","description":"Country Code (&quot;BG&quot;, &quot;EN&quot;, &quot;IT&quot;, ...)"},"state":{"type":"string","description":"State"},"address":{"type":"string","description":"Full address of the content partner"},"email":{"type":"string","description":"Valid email address"},"phone":{"type":"string","description":"Phone number"},"enable_affiliate":{"type":"boolean","description":"Enable the affiliate"},"discount":{"type":"integer","description":"Discount price"},"course_visible":{"type":"boolean","description":"Show content partner&#039;s banner in course player page"},"catalog_visible":{"type":"boolean","description":"Show content partner&#039;s banner in the catalog page"},"website":{"type":"string","description":"Valid website address"},"referral_id":{"type":"string","description":"ID of the referral"},"additional_fields":{"$ref":"#/definitions/ManageContentpartnersUpdateAdditionalFields","description":"Success or failure"},"updated_by":{"type":"integer","description":"ID of the operating user"}},"required":["discount"]},"ManageContentpartnersUpdateName":{"required":["type"],"properties":{"type":{"type":"string","description":"Type of the multi-lang (&quot;single_value&quot;, &quot;multi_value&quot;)"},"value":{"type":"string","description":"This is filled when type = &#039;single_value&#039;. Accepts HTML tag attributes"},"values":{"$ref":"#/definitions/ManageContentpartnersUpdateValues","description":"Filled when type = &#039;multi_lang&#039;. accepts key : value pair ( {language: &quot;translation&quot;} )"}}},"ManageContentpartnersUpdateValues":{},"ManageContentpartnersUpdateDescription":{"required":["type"],"properties":{"type":{"type":"string","description":"Type of the multi-lang (&quot;single_value&quot;, &quot;multi_value&quot;)"},"value":{"type":"string","description":"This is filled when type = &#039;single_value&#039;. Accepts HTML tag attributes"},"values":{"$ref":"#/definitions/ManageContentpartnersUpdateValuesL2","description":"Filled when type = &#039;multi_lang&#039;. accepts key : value pair ( {language: &quot;translation&quot;} )"}}},"ManageContentpartnersUpdateValuesL2":{},"ManageContentpartnersUpdateAdditionalFields":{"required":["id"],"properties":{"id":{"type":"string","description":"Multiple additional fields may be added. The value may be an integer (e.g. for Dropdown additional fields) or string (Text additional field, Textarea additional field)"}}},"ManageContentpartnersUpdateResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure to update content partner with error messages (optional)","items":{"$ref":"#/definitions/ManageContentpartnersUpdateData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageContentpartnersUpdateData":{"required":["id"],"properties":{"id":{"type":"string","description":"The ID of the updated content partner"},"referral_id":{"type":"string","description":"ID of the referral"},"code":{"type":"string","description":"Content partner code"},"name":{"$ref":"#/definitions/ManageContentpartnersUpdateNameL2","description":"Multi-lang field for the name of Content Partner"}}},"ManageContentpartnersUpdateNameL2":{"required":["type"],"properties":{"type":{"type":"string","description":"Type of the multi-lang (&quot;single_value&quot;, &quot;multi_value&quot;)"},"value":{"type":"string","description":"This is filled when type = &#039;single_value&#039;. Accepts HTML tag attributes"},"values":{"$ref":"#/definitions/ManageContentpartnersUpdateValuesL3","description":"Filled when type = &#039;multi_lang&#039;. accepts key : value pair ( {language: &quot;translation&quot;} )"},"description":{"$ref":"#/definitions/ManageContentpartnersUpdateDescriptionL2","description":"Multi-lang field for the description of Content Partner"}}},"ManageContentpartnersUpdateValuesL3":{},"ManageContentpartnersUpdateDescriptionL2":{"required":["type"],"properties":{"type":{"type":"string","description":"Type of the multi-lang (&quot;single_value&quot;, &quot;multi_value&quot;)"},"value":{"type":"string","description":"This is filled when type = &#039;single_value&#039;. Accepts HTML tag attributes"},"values":{"$ref":"#/definitions/ManageContentpartnersUpdateValuesL4","description":"Filled when type = &#039;multi_lang&#039;. accepts key : value pair ( {language: &quot;translation&quot;} )"},"logo":{"type":"string","description":"Name of the file"},"city":{"type":"string","description":"Billing information City"},"country":{"type":"string","description":"Country Code (&quot;BG&quot;, &quot;EN&quot;, &quot;IT&quot;, ...)"},"state":{"type":"string","description":"State"},"address":{"type":"string","description":"Full address of the content partner"},"phone":{"type":"string","description":"Phone number"},"email":{"type":"string","description":"Valid email address"},"website":{"type":"string","description":"Valid website address"},"affiliate_code":{"type":"string","description":"Code for redemption of the affiliate price when buying a product"},"enable_affiliate":{"type":"boolean","description":"Enable the affiliate"},"catalog_visible":{"type":"boolean","description":"Show content partner&#039;s banner in the catalog page"},"course_visible":{"type":"boolean","description":"Show content partner&#039;s banner in course player page"},"active":{"type":"boolean","description":"Is the content partner is activated"},"updated_by":{"type":"integer","description":"ID of the operating user"},"updated_at":{"type":"string","description":"Return the timestamp of the update"}}},"ManageContentpartnersUpdateValuesL4":{},"ManageContentpartnersViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Content partner data","items":{"$ref":"#/definitions/ManageContentpartnersViewData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageContentpartnersViewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageContentpartnersViewData":{"required":["id","code","name","description","logo","address","country","city","state","phone","email","website","discount","affiliate_code","enable_affiliate","catalog_visible","course_visible","active","updated_at","updated_by","referral_id"],"properties":{"id":{"type":"integer","description":"Internal ID"},"code":{"type":"string","description":"Code of the partner"},"name":{"type":"string","description":"Name of the partner"},"description":{"type":"string","description":"Description of the partner"},"logo":{"type":"string","description":"Logo URL"},"address":{"type":"string","description":"Address of the partner"},"country":{"type":"string","description":"Country of partner"},"city":{"type":"string","description":"City of the partner"},"state":{"type":"string","description":"State of the partner"},"phone":{"type":"string","description":"Phone number of the partner"},"email":{"type":"string","description":"Email address of the partner"},"website":{"type":"string","description":"Web address of the partner"},"discount":{"type":"integer","description":"The amount of discount set to this partner"},"affiliate_code":{"type":"string","description":"Affiliate code"},"enable_affiliate":{"type":"integer","description":"Enable Affiliate Code; 0 - disabled; 1- enabled"},"catalog_visible":{"type":"integer","description":"Flag if the partner content is visible in the catalogs; 0 - not visible; 1- visible"},"course_visible":{"type":"boolean","description":"Flag if the partner content is visible in Course"},"active":{"type":"integer","description":"Flag if the Content partner is currently active in the platform; 0 - not active; 1- active"},"updated_at":{"type":"string","description":"Last date when Content partner information was updated"},"updated_by":{"type":"integer","description":"User ID who last updated the information"},"referral_id":{"type":"string","description":"Referral ID"}}},"ManageContentpartnersViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/ManageContentpartnersViewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ManageContentpartnersViewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ManageContentpartnersViewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ManageContentpartnersViewLast","description":"Link to the last page"}}},"ManageContentpartnersViewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"ManageContentpartnersViewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"ManageContentpartnersViewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"ManageContentpartnersViewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"ManageContentpartnersListResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageContentpartnersListData","description":"Response success or failure to find users"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageContentpartnersListData":{"required":["content_partner"],"properties":{"content_partner":{"$ref":"#/definitions/ManageContentpartnersListContentPartner","description":"Return content partner"}}},"ManageContentpartnersListContentPartner":{"required":["id","name","description"],"properties":{"id":{"type":"integer","description":"ID of the row"},"code":{"type":"string","description":"CODE of the content partner"},"name":{"type":"string","description":"The Content Partner name"},"description":{"type":"string","description":"The Content Partner description"},"logo":{"type":"string","description":"The affiliate user ID"},"country":{"type":"string","description":"Country of the Content Partner"},"city":{"type":"string","description":"City of the Content Partner"},"street":{"type":"string","description":"Street of the Content Partner"},"state":{"type":"string","description":"State of the Content Partner"},"email":{"type":"string","description":"Email of the Content Partner"}}},"ManageContentpartnersCoursesResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageContentpartnersCoursesData","description":"Response success or failure to find users"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageContentpartnersCoursesData":{"required":["courses"],"properties":{"courses":{"$ref":"#/definitions/ManageContentpartnersCoursesCourses","description":"Return content partner courses"}}},"ManageContentpartnersCoursesCourses":{"required":["id","partner_name","code"],"properties":{"id":{"type":"integer","description":"ID of the row"},"partner_name":{"type":"string","description":"The Course name"},"code":{"type":"integer","description":"The course code"}}},"ManageContentpartnersAffiliatesResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageContentpartnersAffiliatesData","description":"Response success or failure to find users"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageContentpartnersAffiliatesData":{"required":["affiliates"],"properties":{"affiliates":{"$ref":"#/definitions/ManageContentpartnersAffiliatesAffiliates","description":"Return content partner affiliates"}}},"ManageContentpartnersAffiliatesAffiliates":{"required":["id","partner_name","affiliate_since","user_id","user_name","first_name","last_name","group_id","group_name","branch_id","branch_name","selection_status","affiliate_type"],"properties":{"id":{"type":"integer","description":"ID of the row"},"partner_name":{"type":"string","description":"The Content Partner name"},"affiliate_since":{"type":"string","format":"date","description":"When the user/group/branch became an affiliate of the partner"},"user_id":{"type":"integer","description":"The affiliate user ID"},"user_name":{"type":"string","description":"The affiliate username"},"first_name":{"type":"string","description":"The affiliate first name"},"last_name":{"type":"string","description":"The affiliate last name"},"group_id":{"type":"integer","description":"The affiliate group ID"},"group_name":{"type":"string","description":"The affiliate group name"},"branch_id":{"type":"integer","description":"The affiliate branch ID"},"branch_name":{"type":"string","description":"The affiliate branch name"},"selection_status":{"type":"integer","description":"The affiliate branch selection status (branch / branch + descendants)"},"affiliate_type":{"type":"string","description":"The affiliate type. One of &quot;user&quot;/&quot;group&quot;/&quot;branch&quot;"}}},"ManageContentpartnersCreateAffiliatesSchema":{"type":"object","properties":{"user_ids":{"type":"array","description":"User IDs (integers)","items":{"$ref":"#/definitions/ManageContentpartnersCreateAffiliatesUserIds"}},"group_ids":{"type":"array","description":"Group IDs (integers)","items":{"$ref":"#/definitions/ManageContentpartnersCreateAffiliatesGroupIds"}},"branch_ids":{"$ref":"#/definitions/ManageContentpartnersCreateAffiliatesBranchIds","description":"Branch IDs =&gt; selection types (integer =&gt; integer)"}}},"ManageContentpartnersCreateAffiliatesUserIds":{},"ManageContentpartnersCreateAffiliatesGroupIds":{},"ManageContentpartnersCreateAffiliatesBranchIds":{},"ManageContentpartnersCreateAffiliatesResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/ManageContentpartnersCreateAffiliatesData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageContentpartnersCreateAffiliatesData":{"required":["success","inserted_records_count"],"properties":{"success":{"type":"boolean","description":"Success or failure to assign the user affiliations"},"inserted_records_count":{"type":"integer","description":"The number of records created"}}},"ManageContentpartnersDeleteAffiliatesResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/ManageContentpartnersDeleteAffiliatesData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageContentpartnersDeleteAffiliatesData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure to delete the user affiliations"}}},"ManageContentpartnersAddAffiliateCodeSchema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"Content Partners affiliate code"}}},"ManageContentpartnersAddAffiliateCodeResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/ManageContentpartnersAddAffiliateCodeData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageContentpartnersAddAffiliateCodeData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure to assign the partner affiliations"}}},"ManageContentpartnersListUserAffiliationsResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/ManageContentpartnersListUserAffiliationsData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageContentpartnersListUserAffiliationsData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure to assign the partner affiliations"}}},"ManageContentpartnersDeleteUserAffiliationResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/ManageContentpartnersDeleteUserAffiliationData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageContentpartnersDeleteUserAffiliationData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure to delete the partner affiliation"}}},"ManageCsmDetailsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Response.","items":{"$ref":"#/definitions/ManageCsmDetailsData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources.","items":{"$ref":"#/definitions/ManageCsmDetailsLinks"}}}},"ManageCsmDetailsData":{"required":["is_available","threshold_value","categories","priorities","user_email"],"properties":{"is_available":{"type":"boolean","description":"Whether the service is available."},"threshold_value":{"type":"integer","description":"The threshold value."},"categories":{"type":"array","description":"The categories.","items":{"$ref":"#/definitions/ManageCsmDetailsCategories"}},"priorities":{"type":"array","description":"The priorities.","items":{"$ref":"#/definitions/ManageCsmDetailsPriorities"}},"user_email":{"type":"string","description":"Email of the user."}}},"ManageCsmDetailsCategories":{"required":["id","description"],"properties":{"id":{"type":"integer","description":"The category id."},"description":{"type":"string","description":"The category description."}}},"ManageCsmDetailsPriorities":{"required":["id","description"],"properties":{"id":{"type":"integer","description":"The priority id."},"description":{"type":"string","description":"The priority description."}}},"ManageCsmDetailsLinks":{},"ManageCsmContact-requestsSchema":{"type":"object","required":["category","priority","user_email","message"],"properties":{"category":{"type":"integer","description":"The selected category. (Possible values: ids of category parameter returned by /manage/v1/csm/details)"},"priority":{"type":"integer","description":"The selected priority. (Possible values: ids of priority parameter returned by /manage/v1/csm/details)"},"user_email":{"type":"string","description":"The email of the user."},"message":{"type":"string","description":"The message body of the email."}}},"ManageCsmContact-requestsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageCsmContact-requestsData","description":"Response."},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources.","items":{"$ref":"#/definitions/ManageCsmContact-requestsLinks"}}}},"ManageCsmContact-requestsData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the processed email."}}},"ManageCsmContact-requestsLinks":{},"ManageEsignatureGetSettingsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEsignatureGetSettingsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEsignatureGetSettingsData":{"required":["enabled","auth_types"],"properties":{"enabled":{"type":"boolean","description":"Whether E-Signature is enabled"},"auth_types":{"type":"array","description":"An array of E-Signature auth types objects","items":{"$ref":"#/definitions/ManageEsignatureGetSettingsAuthTypes"}},"last_updated":{"$ref":"#/definitions/ManageEsignatureGetSettingsLastUpdated","description":"An object containing information for the last user who updated the settings. NOTE: This param is returned only when the user exists"}}},"ManageEsignatureGetSettingsAuthTypes":{"required":["enabled","type"],"properties":{"enabled":{"type":"boolean","description":"Whether the auth type is enabled"},"type":{"description":"E-Signature auth type","enum":["email","authenticatorapp"],"type":"string"},"code_ttl":{"type":"integer","description":"The TTL of the OTP in seconds. Only available for the email type authentication"}}},"ManageEsignatureGetSettingsLastUpdated":{"required":["datetime","username","firstname","lastname","avatar"],"properties":{"datetime":{"type":"string","format":"date","description":"The datetime when the settings were last updated (in format yyyy-MM-dd HH:mm:ss)"},"username":{"type":"string","description":"The username of the user who updated the settings"},"firstname":{"type":"string","description":"The first name of the user who updated the settings"},"lastname":{"type":"string","description":"The last name of the user who updated the settings"},"avatar":{"type":"string","description":"The avatar URL of the user who updated the settings"}}},"ManageEsignatureSaveSettingsSchema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether E-Signature is enabled"},"auth_types":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageEsignatureSaveSettingsAuthTypes"}}}},"ManageEsignatureSaveSettingsAuthTypes":{"required":["enabled","type"],"properties":{"enabled":{"type":"boolean","description":"Whether the E-Signature auth type is enabled"},"type":{"description":"E-Signature auth type","enum":["email","authenticatorapp"],"type":"string"},"code_ttl":{"type":"integer","description":"The TTL of the OTP in seconds. Only available for the email type authentication. Accept values between 120 and 7200."}}},"ManageEnrollmentrulesIndexActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesIndexActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageEnrollmentrulesIndexActionLinks"}}}},"ManageEnrollmentrulesIndexActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules","items":{"$ref":"#/definitions/ManageEnrollmentrulesIndexActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"ManageEnrollmentrulesIndexActionItems":{"required":["enrollment_rule_id","title","code","rule_type","notifications","notification_ids","active_status"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The ID of the Enrollment Rules"},"title":{"type":"string","description":"The name of the Enrollment Rules"},"code":{"type":"string","description":"The code of the Enrollment Rules"},"rule_type":{"type":"string","description":"The combination of audience_type_from/enroll_to which define the rule"},"branch_ids":{"type":"array","description":"The list of the branch ids if the rule_type audience_type_from is set to branch","items":{"$ref":"#/definitions/ManageEnrollmentrulesIndexActionBranchIds"}},"groups":{"type":"integer","description":"The number of groups"},"group_ids":{"type":"array","description":"The list of the group ids if the rule_type audience_type_from is set to group","items":{"type":"int"}},"courses":{"type":"integer","description":"The number of courses"},"course_ids":{"type":"array","description":"The list of the course ids if the rule_type enroll_to is set to course","items":{"type":"int"}},"plans":{"type":"integer","description":"The number learning plans"},"lp_ids":{"type":"array","description":"The list of the group ids if the rule_type enroll_to is set to lp","items":{"type":"int"}},"notifications":{"type":"integer","description":"The number of notifications"},"notification_ids":{"type":"array","description":"The list of the notification ids. The value is array(string) when release/weekly/paas/notifications and release/weekly/paas/notifications-enable-triggers toggles are ON","items":{"type":"int"}},"active_status":{"type":"boolean","description":"The active status of the Enrollment Rule"},"updated_at":{"type":"string","description":"The time of last update of the Enrollment Rule UTC format yyyy-mm-dd hh:ii:ss or null"}}},"ManageEnrollmentrulesIndexActionBranchIds":{"required":["branch_id","selection_status"],"properties":{"branch_id":{"type":"integer","description":"the id of the branch"},"selection_status":{"type":"integer","description":"the selection level of the branch. 1 means only the branch_id while 2 means the branch_id and all its children."}}},"ManageEnrollmentrulesIndexActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageEnrollmentrulesViewActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesViewActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentrulesViewActionData":{"required":["enrollment_rule_id","title","code","rule_type","notifications","notification_ids","active_status"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The ID of the Enrollment Rules"},"title":{"type":"string","description":"The name of the Enrollment Rules"},"code":{"type":"string","description":"The code of the Enrollment Rules"},"date_begin_validity":{"type":"string","description":"validity start date/time UTC format yyyy-mm-dd hh:ii:ss or null"},"date_expire_validity":{"type":"string","description":"validity expiration date/time UTC format yyyy-mm-dd hh:ii:ss or null"},"rule_type":{"type":"string","description":"The combination of audience_type_from/enroll_to which define the rule"},"branches":{"type":"integer","description":"The number of selected branches"},"branch_ids":{"type":"array","description":"The list of the branch ids if the rule_type audience_type_from is set to branch","items":{"$ref":"#/definitions/ManageEnrollmentrulesViewActionBranchIds"}},"groups":{"type":"integer","description":"The number of selected groups"},"group_ids":{"type":"array","description":"The list of the group ids if the rule_type audience_type_from is set to group","items":{"type":"int"}},"courses":{"type":"integer","description":"The number of selected courses"},"course_ids":{"type":"array","description":"The list of the course ids if the rule_type enroll_to is set to course","items":{"type":"int"}},"plans":{"type":"integer","description":"The number of selected learning plans"},"lp_ids":{"type":"array","description":"The list of the group ids if the rule_type enroll_to is set to lp","items":{"type":"int"}},"notifications":{"type":"integer","description":"The number of selected notifications"},"notification_ids":{"type":"array","description":"The list of the notification ids. The value is array(string) when release/weekly/paas/notifications and release/weekly/paas/notifications-enable-triggers toggles are ON","items":{"type":"int"}},"active_status":{"type":"boolean","description":"The active status of the Enrollment Rule"},"updated_at":{"type":"string","description":"The time of last update of the Enrollment Rule UTC format yyyy-mm-dd hh:ii:ss or null"},"assignment_type":{"description":"Enrollment assignment type for the user. This field is returned only when this enrollment attribute is configured in the platform advanced settings. The possible values are: Mandatory,Required, Recommended, Optional.","enum":["string"],"type":"string"}}},"ManageEnrollmentrulesViewActionBranchIds":{"required":["branch_id","selection_status"],"properties":{"branch_id":{"type":"integer","description":"the id of the branch"},"selection_status":{"type":"integer","description":"the selection level of the branch. 1 means only the branch_id while 2 means the branch_id and all its children."}}},"ManageEnrollmentrulesCreateActionSchema":{"type":"object","required":["title","audience_type_from","enroll_to"],"properties":{"title":{"type":"string","description":"the title of the enrollment rule"},"code":{"type":"string","description":"the code of the enrollment rule"},"audience_type_from":{"type":"string","description":"The audience type for the enrollment rule. Accepted values: group, branch"},"enroll_to":{"type":"string","description":"The destination type where user will be enrolled in. Accepted values: course, lp"}}},"ManageEnrollmentrulesCreateActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesCreateActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentrulesCreateActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the newly created enrollment rule"},"success":{"type":"boolean","description":"Success or failure"}}},"ManageEnrollmentrulesUpdateActionSchema":{"type":"object","required":["title","active_status"],"properties":{"title":{"type":"string","description":"the title of the enrollment rule"},"code":{"type":"string","description":"the code of the enrollment rule"},"date_begin_validity":{"type":"string","description":"validity start date/time UTC format yyyy-mm-dd hh:ii:ss or null"},"date_expire_validity":{"type":"string","description":"validity expiration date/time UTC format yyyy-mm-dd hh:ii:ss or null"},"active_status":{"type":"boolean","description":"the active_status to be applied to the Enrollment Rule"},"assignment_type":{"description":"Enrollment assignment type for the user. This field is taken in input only when this enrollment attribute is configured in the platform advanced settings. Accepted values: Mandatory, Required, Recommended, Optional.","enum":["string"],"type":"string"}}},"ManageEnrollmentrulesUpdateActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesUpdateActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentrulesUpdateActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageEnrollmentrulesUpdateStatusActionSchema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"the activation status of the enrollment rule"}}},"ManageEnrollmentrulesUpdateStatusActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesUpdateStatusActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentrulesUpdateStatusActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageEnrollmentrulesUpdateBranchActionSchema":{"type":"object","required":["branches"],"properties":{"branches":{"type":"array","description":"the branches to be applied to the Enrollment Rule","items":{"$ref":"#/definitions/ManageEnrollmentrulesUpdateBranchActionBranches"}}}},"ManageEnrollmentrulesUpdateBranchActionBranches":{"required":["branch_id","selection_status"],"properties":{"branch_id":{"type":"integer","description":"the id of the branch"},"selection_status":{"type":"integer","description":"the selection level of the branch. Accepted values: 1, 2. 1 means only the branch_id while 2 means the branch_id and all its children, if any"}}},"ManageEnrollmentrulesUpdateBranchActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesUpdateBranchActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentrulesUpdateBranchActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageEnrollmentrulesUpdateCourseActionSchema":{"type":"object","required":["course_ids"],"properties":{"course_ids":{"type":"array","description":"the courses to be applied to the Enrollment Rule","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"Select all resources to associate to the Enrollment Rule. Default: False"},"search_text":{"type":"string","description":"Search resources by text. Default: null"},"incremental_update":{"type":"boolean","description":"The previous association will not be deleted, instead the new elements will be added. Default: False"}}},"ManageEnrollmentrulesUpdateCourseActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesUpdateCourseActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentrulesUpdateCourseActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageEnrollmentrulesUpdateGroupActionSchema":{"type":"object","required":["group_ids"],"properties":{"group_ids":{"type":"array","description":"the groups to be applied to the Enrollment Rule","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"Select all resources to associate to the Enrollment Rule. Default: False"},"search_text":{"type":"string","description":"Search resources by text. Default: null"},"incremental_update":{"type":"boolean","description":"The previous association will not be deleted, instead the new elements will be added. Default: False"}}},"ManageEnrollmentrulesUpdateGroupActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesUpdateGroupActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentrulesUpdateGroupActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageEnrollmentrulesUpdateLpActionSchema":{"type":"object","required":["learning_plan_ids"],"properties":{"learning_plan_ids":{"type":"array","description":"the learning plans to be applied to the Enrollment Rule","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"Select all resources to associate to the Enrollment Rule. Default: False"},"search_text":{"type":"string","description":"Search resources by text. Default: null"},"incremental_update":{"type":"boolean","description":"The previous association will not be deleted, instead the new elements will be added. Default: False"}}},"ManageEnrollmentrulesUpdateLpActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesUpdateLpActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentrulesUpdateLpActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageEnrollmentrulesDeleteActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesDeleteActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentrulesDeleteActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"id of the rule deleted"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageEnrollmentrulesIndexBranchActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesIndexBranchActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageEnrollmentrulesIndexBranchActionLinks"}}}},"ManageEnrollmentrulesIndexBranchActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules","items":{"$ref":"#/definitions/ManageEnrollmentrulesIndexBranchActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"ManageEnrollmentrulesIndexBranchActionItems":{"required":["id","code","title","selection_status","route"],"properties":{"id":{"type":"integer","description":"The ID of the Enrollment Rules"},"code":{"type":"string","description":"The name of the Enrollment Rules"},"title":{"type":"string","description":"The code of the Enrollment Rules"},"selection_status":{"type":"integer","description":"the selection level of the branch. Accepted values: 1, 2. 1 means only the branch_id while 2 means the branch_id and all its children, if any"},"route":{"type":"string","description":"Branch route, from root to branch item"}}},"ManageEnrollmentrulesIndexBranchActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageEnrollmentrulesIndexCourseActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesIndexCourseActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageEnrollmentrulesIndexCourseActionLinks"}}}},"ManageEnrollmentrulesIndexCourseActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules","items":{"$ref":"#/definitions/ManageEnrollmentrulesIndexCourseActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"ManageEnrollmentrulesIndexCourseActionItems":{"required":["id","code","title"],"properties":{"id":{"type":"integer","description":"The ID of the Enrollment Rules"},"code":{"type":"string","description":"The name of the Enrollment Rules"},"title":{"type":"string","description":"The code of the Enrollment Rules"}}},"ManageEnrollmentrulesIndexCourseActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageEnrollmentrulesIndexLpActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesIndexLpActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageEnrollmentrulesIndexLpActionLinks"}}}},"ManageEnrollmentrulesIndexLpActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size","sort"],"properties":{"items":{"type":"array","description":"The list of Learning Plans","items":{"$ref":"#/definitions/ManageEnrollmentrulesIndexLpActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"An array of applied sorting fields","items":{"$ref":"#/definitions/ManageEnrollmentrulesIndexLpActionSort"}}}},"ManageEnrollmentrulesIndexLpActionItems":{"required":["id","code","title"],"properties":{"id":{"type":"string","description":"The ID of the Learning Plan"},"code":{"type":"string","description":"The name of the Learning Plan"},"title":{"type":"string","description":"The code of the Learning Plan"},"type":{"type":"string","description":"The type of the Learning Plan. Can be Learning Plan or Certification. The attribute is returned only when the release/weekly/new-certification-1-private-beta toggle is ON"}}},"ManageEnrollmentrulesIndexLpActionSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"The sorting field name"},"sort_dir":{"type":"string","description":"The sorting direction."}}},"ManageEnrollmentrulesIndexLpActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageEnrollmentrulesIndexGroupActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesIndexGroupActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageEnrollmentrulesIndexGroupActionLinks"}}}},"ManageEnrollmentrulesIndexGroupActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules Group Items","items":{"$ref":"#/definitions/ManageEnrollmentrulesIndexGroupActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageEnrollmentrulesIndexGroupActionSort"}}}},"ManageEnrollmentrulesIndexGroupActionItems":{"required":["id","title","description"],"properties":{"id":{"type":"integer","description":"The ID of the Enrollment Rules Group Item"},"title":{"type":"string","description":"The code of the Enrollment Rules Group Item"},"description":{"type":"string","description":"The description of the Enrollment Rules Group Item"}}},"ManageEnrollmentrulesIndexGroupActionSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["title","id","description"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["desc","asc"],"type":"string"}}},"ManageEnrollmentrulesIndexGroupActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageEnrollmentrulesListCourseActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesListCourseActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageEnrollmentrulesListCourseActionLinks"}}}},"ManageEnrollmentrulesListCourseActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules","items":{"$ref":"#/definitions/ManageEnrollmentrulesListCourseActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"ManageEnrollmentrulesListCourseActionItems":{"required":["id","code","title"],"properties":{"id":{"type":"integer","description":"The ID of the Enrollment Rules"},"code":{"type":"string","description":"The name of the Enrollment Rules"},"title":{"type":"string","description":"The code of the Enrollment Rules"}}},"ManageEnrollmentrulesListCourseActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageEnrollmentrulesListLpActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesListLpActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageEnrollmentrulesListLpActionLinks"}}}},"ManageEnrollmentrulesListLpActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Learning Plans","items":{"$ref":"#/definitions/ManageEnrollmentrulesListLpActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"ManageEnrollmentrulesListLpActionItems":{"required":["id","code","title"],"properties":{"id":{"type":"string","description":"The ID of the Learning Plan"},"code":{"type":"string","description":"The name of the Learning Plan"},"title":{"type":"string","description":"The code of the Learning Plan"},"type":{"type":"string","description":"The type of the Learning Plan. Can be Learning Plan or Certification. The attribute is returned only when the release/weekly/new-certification-1-private-beta toggle is ON"}}},"ManageEnrollmentrulesListLpActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageEnrollmentrulesListGroupActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesListGroupActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageEnrollmentrulesListGroupActionLinks"}}}},"ManageEnrollmentrulesListGroupActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules Group Items","items":{"$ref":"#/definitions/ManageEnrollmentrulesListGroupActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageEnrollmentrulesListGroupActionSort"}}}},"ManageEnrollmentrulesListGroupActionItems":{"required":["id","title","description"],"properties":{"id":{"type":"integer","description":"The ID of the Enrollment Rules Group Item"},"title":{"type":"string","description":"The code of the Enrollment Rules Group Item"},"description":{"type":"string","description":"The description of the Enrollment Rules Group Item"}}},"ManageEnrollmentrulesListGroupActionSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["title","id","description"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["desc","asc"],"type":"string"}}},"ManageEnrollmentrulesListGroupActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageEnrollmentrulesListNotificationActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesListNotificationActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageEnrollmentrulesListNotificationActionLinks"}}}},"ManageEnrollmentrulesListNotificationActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules Notification Items","items":{"$ref":"#/definitions/ManageEnrollmentrulesListNotificationActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"ManageEnrollmentrulesListNotificationActionItems":{"required":["id","title","type","type_translation","recipient","active"],"properties":{"id":{"type":"integer","description":"The ID of the Enrollment Rules Notification Item"},"title":{"type":"string","description":"The code of the Enrollment Rules Notification Item"},"type":{"type":"string","description":"The type of the Notification - Type Code"},"type_translation":{"type":"string","description":"The type of the Notification - Translation"},"recipient":{"type":"string","description":"The recipient of the Notification"},"active":{"type":"boolean","description":"If true, the notification is active, false otherwise"}}},"ManageEnrollmentrulesListNotificationActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageEnrollmentrulesDeleteCourseActionSchema":{"type":"object","required":["course_ids"],"properties":{"course_ids":{"type":"array","description":"the courses to be deleted from the Enrollment Rule","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"select all resources filtered by search text (if passed) - Default: false"},"search_text":{"type":"string","description":"search text to filter resources in case of select_all - Default: no value"}}},"ManageEnrollmentrulesDeleteCourseActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesDeleteCourseActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentrulesDeleteCourseActionData":{"required":["enrollment_rule_id","success","delete_count"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"},"delete_count":{"type":"integer","description":"how many items were deleted"}}},"ManageEnrollmentrulesDeleteLpActionSchema":{"type":"object","required":["learning_plan_ids"],"properties":{"learning_plan_ids":{"type":"array","description":"the learning plans to be applied to the Enrollment Rule","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"select all resources filtered by search text (if passed) - Default: false"},"search_text":{"type":"string","description":"search text to filter resources in case of select_all - Default: no value"}}},"ManageEnrollmentrulesDeleteLpActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesDeleteLpActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentrulesDeleteLpActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageEnrollmentrulesDeleteGroupActionSchema":{"type":"object","required":["group_ids"],"properties":{"group_ids":{"type":"array","description":"the groups to be deleted from the Enrollment Rule","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"select all resources filtered by search text (if passed) - Default: false"},"search_text":{"type":"string","description":"search text to filter resources in case of select_all - Default: no value"}}},"ManageEnrollmentrulesDeleteGroupActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesDeleteGroupActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentrulesDeleteGroupActionData":{"required":["enrollment_rule_id","success","delete_count"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"},"delete_count":{"type":"integer","description":"how many items were deleted"}}},"ManageEnrollmentrulesDeleteBranchesActionSchema":{"type":"object","properties":{"branch_ids":{"type":"array","description":"the branchs to be deleted from the Enrollment Rule","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"select all resources filtered by search text (if passed) - Default: false"},"search_text":{"type":"string","description":"search text to filter resources in case of select_all - Default: no value"}}},"ManageEnrollmentrulesDeleteBranchesActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentrulesDeleteBranchesActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentrulesDeleteBranchesActionData":{"required":["enrollment_rule_id","success","delete_count"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"},"delete_count":{"type":"integer","description":"how many items were deleted"}}},"ManageEnrollmentruleslogsIndexActionResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentruleslogsIndexActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageEnrollmentruleslogsIndexActionLinks"}}}},"ManageEnrollmentruleslogsIndexActionData":{"required":["items"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules","items":{"$ref":"#/definitions/ManageEnrollmentruleslogsIndexActionItems"}}}},"ManageEnrollmentruleslogsIndexActionItems":{"required":["enroll_log_id","date_created","type","name","items_count","rollback_count","rollback_status"],"properties":{"enroll_log_id":{"type":"integer","description":"Log Id"},"date_created":{"type":"string","description":"Log date of creation"},"type":{"type":"string","description":"Rule Type liked to Log"},"name":{"type":"string","description":"Rule Name"},"items_count":{"type":"integer","description":"Number of log items associated to the log - aka the number of courses or lp in which the user had been enrolled"},"rollback_count":{"type":"integer","description":"Number of log items that had rollback"},"rollback_status":{"type":"integer","description":"0 - No rollback done, 1 - Partial rollback, 2 - Full Rollback, 3 - Rollback in Progress"},"user":{"$ref":"#/definitions/ManageEnrollmentruleslogsIndexActionUser","description":"The user summary information"}}},"ManageEnrollmentruleslogsIndexActionUser":{"required":["idst"],"properties":{"idst":{"type":"integer","description":"The user idst"},"firstname":{"type":"string","description":"The user firstname"},"lastname":{"type":"string","description":"The user lastname"},"email":{"type":"string","description":"The user email"},"userid":{"type":"string","description":"The username"}}},"ManageEnrollmentruleslogsIndexActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageEnrollmentruleslogsViewActionResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentruleslogsViewActionData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageEnrollmentruleslogsViewActionLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageEnrollmentruleslogsViewActionData":{"required":["type","name","items_count"],"properties":{"type":{"type":"string","description":"The Enrollment Log Type"},"name":{"type":"string","description":"The Enrollment Log Name"},"items_count":{"type":"integer","description":"The Enrollment Log Items assigned to the Log"},"user":{"$ref":"#/definitions/ManageEnrollmentruleslogsViewActionUser","description":"The user summary information"}}},"ManageEnrollmentruleslogsViewActionUser":{"required":["idst"],"properties":{"idst":{"type":"integer","description":"The user idst"},"firstname":{"type":"string","description":"The user firstname"},"lastname":{"type":"string","description":"The user lastname"},"email":{"type":"string","description":"The user email"}}},"ManageEnrollmentruleslogsViewActionLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/ManageEnrollmentruleslogsViewActionSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ManageEnrollmentruleslogsViewActionGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ManageEnrollmentruleslogsViewActionFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ManageEnrollmentruleslogsViewActionLast","description":"Link to the last page"}}},"ManageEnrollmentruleslogsViewActionSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"ManageEnrollmentruleslogsViewActionGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"ManageEnrollmentruleslogsViewActionFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"ManageEnrollmentruleslogsViewActionLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"ManageEnrollmentruleslogsViewLogItemsActionResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentruleslogsViewLogItemsActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageEnrollmentruleslogsViewLogItemsActionLinks"}}}},"ManageEnrollmentruleslogsViewLogItemsActionData":{"required":["items"],"properties":{"items":{"type":"array","description":"The list of logs items","items":{"$ref":"#/definitions/ManageEnrollmentruleslogsViewLogItemsActionItems"}}}},"ManageEnrollmentruleslogsViewLogItemsActionItems":{"required":["log_item_id","item_id","rollback"],"properties":{"log_item_id":{"type":"integer","description":"Log Item id"},"item_id":{"type":"integer","description":"The course or learning plan in which the user is enrolled"},"code":{"type":"string","description":"The course or learning plan code"},"name":{"type":"string","description":"The course or learning plan name"},"rollback":{"type":"boolean","description":"Rollback status - 1 the rollback has been done, 0 the rollback has not been done yet"}}},"ManageEnrollmentruleslogsViewLogItemsActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageEnrollmentruleslogsRollbackActionSchema":{"type":"object","properties":{"un_enroll_courses":{"type":"boolean","description":"If rollback a learning plan, rollback the courses too"},"avoid_in_progress":{"type":"boolean","description":"If rollback a learning plan, avoid the in progress courses"},"avoid_completed":{"type":"boolean","description":"If rollback a learning plan, avoid the completed courses"}}},"ManageEnrollmentruleslogsRollbackActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentruleslogsRollbackActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentruleslogsRollbackActionData":{"required":["success","background"],"properties":{"success":{"type":"boolean","description":"If true, the operation was successful"},"message":{"type":"string","description":"Additional information"},"background":{"type":"boolean","description":"If true, the operation generated a background job"}}},"ManageEnrollmentruleslogsRollbackItemActionSchema":{"type":"object","properties":{"un_enroll_courses":{"type":"boolean","description":"If rollback a learning plan, rollback the courses too"},"avoid_in_progress":{"type":"boolean","description":"If rollback a learning plan, avoid the in progress courses"},"avoid_completed":{"type":"boolean","description":"If rollback a learning plan, avoid the completed courses"}}},"ManageEnrollmentruleslogsMassiveRollbackActionSchema":{"type":"object","properties":{"search_text":{"type":"string","description":"Search string to filter enrollment rules to rollback."},"rule_type":{"type":"string","description":"Search logs for rule type to rollback"},"rule_log_from":{"type":"string","description":"Search logs from time to rollback"},"rule_log_to":{"type":"string","description":"Search logs to time to rollback"},"select_all":{"description":"Select all rule logs that match the criteria: 0 no, 1 - yes. Default 0. Anything else will be considered as 1","enum":["0","1"],"type":"integer"},"un_enroll_courses":{"type":"boolean","description":"If rollback a learning plan, rollback the courses too"},"avoid_in_progress":{"type":"boolean","description":"If rollback a learning plan, avoid the in progress courses"},"avoid_completed":{"type":"boolean","description":"If rollback a learning plan, avoid the completed courses"},"enroll_log_ids":{"type":"array","description":"IDs of Enroll Log to be Rollback.","items":{"type":"integer"}}},"required":["enroll_log_ids"]},"ManageEnrollmentruleslogsMassiveRollbackActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentruleslogsMassiveRollbackActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentruleslogsMassiveRollbackActionData":{"required":["success","background"],"properties":{"success":{"type":"boolean","description":"If true, the operation was successful"},"message":{"type":"string","description":"Additional informations"},"background":{"type":"boolean","description":"If true, the operation generated a background job"}}},"ManageEnrollmentfieldCreateSchema":{"type":"object","required":["type","translations"],"properties":{"type":{"type":"integer","description":"Enrollment field type. Options: 1- date, 2 - dropdown, 3 - free_text, 4 - textarea"},"translations":{"$ref":"#/definitions/ManageEnrollmentfieldCreateTranslations","description":"Array of translations, the system default language translation is mandatory"},"mandatory":{"type":"integer","description":"Mandatory - 1 or Not mandatory - 0. Default - 1"},"courses":{"type":"array","description":"Create enrollment field for certain courses. Default - all","items":{"type":"integer"}},"visible_to_user":{"type":"integer","description":"Enrollment field is visible for users - 1 or not visible - 0. Default - 1"},"dropdown_options":{"type":"array","description":"Array of dropdown options. If type of enrollment field is dropdown, this parameter becomes required","items":{"$ref":"#/definitions/ManageEnrollmentfieldCreateDropdownOptions"}}}},"ManageEnrollmentfieldCreateTranslations":{"required":["__language_code__"],"properties":{"__language_code__":{"type":"string","description":"The key is code of the language or all - the value is title. For example en, all"}}},"ManageEnrollmentfieldCreateDropdownOptions":{"required":["translations"],"properties":{"translations":{"$ref":"#/definitions/ManageEnrollmentfieldCreateTranslationsL2","description":"Array of translations, the system default language translation is mandatory"}}},"ManageEnrollmentfieldCreateTranslationsL2":{"required":["language_code"],"properties":{"language_code":{"type":"string","description":"The key is code of the language or all - the value is title. For example en, all"}}},"ManageEnrollmentfieldCreateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentfieldCreateData","description":"ID of the created record"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentfieldCreateData":{"required":["enrollment_field_id"],"properties":{"enrollment_field_id":{"type":"integer","description":"The internal ID for the newly created enrollment field"},"enrollment_field_options":{"type":"array","description":"The internal IDs for the newly created enrollment field options. Visible if field type is dropdown","items":{"type":"integer"}}}},"ManageEnrollmentfieldDeleteResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentfieldDeleteData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentfieldDeleteData":{"required":["errors","deleted"],"properties":{"errors":{"$ref":"#/definitions/ManageEnrollmentfieldDeleteErrors","description":"Errors during process"},"deleted":{"type":"string","description":"ID of the successfully deleted item"}}},"ManageEnrollmentfieldDeleteErrors":{"required":["message"],"properties":{"message":{"type":"integer","description":"Process that generated an error"}}},"ManageEnrollmentfieldUpdateSchema":{"type":"object","properties":{"mandatory":{"type":"integer","description":"1 or 0."},"courses":{"type":"array","description":"","items":{"type":"integer"}},"visible_to_user":{"type":"integer","description":"1 or 0."},"sequence":{"type":"integer","description":"if not provided set as last"},"translations":{"$ref":"#/definitions/ManageEnrollmentfieldUpdateTranslations","description":"Array of translations, the system default language translation is mandatory"},"dropdown_options":{"type":"array","description":"Array of objects containing dropdown options. If type is dropdown this parameter becomes required","items":{"$ref":"#/definitions/ManageEnrollmentfieldUpdateDropdownOptions"}}},"required":["courses"]},"ManageEnrollmentfieldUpdateTranslations":{"required":["language_code"],"properties":{"language_code":{"type":"string","description":"The key is code of the language or all - the value is title. For example en, all"}}},"ManageEnrollmentfieldUpdateDropdownOptions":{"properties":{"option_id":{"type":"integer","description":"Id of selected dropdown option."},"sequence":{"type":"integer","description":"if not provided set as last"},"translations":{"$ref":"#/definitions/ManageEnrollmentfieldUpdateTranslationsL2","description":"Array of translations, the system default language translation is mandatory"}},"required":["translations"]},"ManageEnrollmentfieldUpdateTranslationsL2":{"required":["language_code"],"properties":{"language_code":{"type":"string","description":"The key is code of the language or all - the value is title. For example en, all"}}},"ManageEnrollmentfieldUpdateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentfieldUpdateData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentfieldUpdateData":{"required":["field_id"],"properties":{"field_id":{"type":"integer","description":"Id of enrollment field."},"error_messages":{"type":"array","description":"List of errors.","items":{"$ref":"#/definitions/ManageEnrollmentfieldUpdateErrorMessages"}}}},"ManageEnrollmentfieldUpdateErrorMessages":{"properties":{"updated_option_ids":{"type":"array","description":"List of updated ids.","items":{"$ref":"#/definitions/ManageEnrollmentfieldUpdateUpdatedOptionIds"}}}},"ManageEnrollmentfieldUpdateUpdatedOptionIds":{},"ManageEnrollmentfieldListResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentfieldListData","description":"List of all retrieved enrollment fields"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageEnrollmentfieldListLinks","description":"Links to pages"}}},"ManageEnrollmentfieldListData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of enrollment fields info objects","items":{"$ref":"#/definitions/ManageEnrollmentfieldListItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageEnrollmentfieldListSort"}}}},"ManageEnrollmentfieldListItems":{"required":["id","type","mandatory","courses","visible_to_user","sequence","title"],"properties":{"id":{"type":"integer","description":"ID of the enrollment field"},"type":{"type":"string","description":"Type of the enrollment field"},"mandatory":{"type":"string","description":"Enrollment field mandatory"},"courses":{"type":"string","description":"Enrollment field courses"},"visible_to_user":{"type":"string","description":"Visible to user field"},"sequence":{"type":"string","description":"Enrollment field order"},"title":{"type":"string","description":"Enrollment field title in the selected language"}}},"ManageEnrollmentfieldListSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageEnrollmentfieldListLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageEnrollmentfieldMultipleDeleteSchema":{"type":"object","required":["field_ids"],"properties":{"field_ids":{"type":"array","description":"Ids of selected fields.","items":{"type":"integer"}}}},"ManageEnrollmentfieldMultipleDeleteResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageEnrollmentfieldMultipleDeleteData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageEnrollmentfieldMultipleDeleteData":{"required":["errors","deleted"],"properties":{"errors":{"$ref":"#/definitions/ManageEnrollmentfieldMultipleDeleteErrors","description":"Errors during process"},"deleted":{"type":"string","description":"ID of the successfully deleted item"}}},"ManageEnrollmentfieldMultipleDeleteErrors":{"required":["message"],"properties":{"message":{"type":"integer","description":"Process that generated an error"}}},"ManageErpUrlResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageErpUrlData","description":"Response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageErpUrlData":{"required":["url"],"properties":{"url":{"type":"string","description":"The full SSO absolute EPR URL, with all the authentications params appended"}}},"ManageExternaluserAssociateExternalUsersSchema":{"type":"object","required":["userdata"],"properties":{"userdata":{"type":"array","description":"list of users to be associated","items":{"$ref":"#/definitions/ManageExternaluserAssociateExternalUsersUserdata"}},"from_email":{"type":"boolean","description":"specify if json data uses email to define users or not (Default value is true)"}}},"ManageExternaluserAssociateExternalUsersUserdata":{"properties":{"ext_user":{"type":"string","description":"External user ID"},"ext_user_type":{"type":"string","description":"External identification tpe"},"userid":{"type":"string","description":"Docebo login name"},"email":{"type":"string","description":"The email assigned to the user in the LMS (will be used for lookup if &#039;from_email&#039; is set to true)"},"idst":{"type":"integer","description":"Internal Docebo ID"}}},"ManageExternaluserAssociateExternalUsersResponse":{"required":["sync","version"],"properties":{"sync":{"type":"array","description":"for every user to be associated, a result data is provided","items":{"$ref":"#/definitions/ManageExternaluserAssociateExternalUsersSync"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageExternaluserAssociateExternalUsersSync":{"required":["idst","username"],"properties":{"idst":{"type":"integer","description":"ID of the synched user"},"username":{"type":"string","description":"Username of the synched user"}}},"ManageFeatureIndexResponse":{"required":["data","version","version"],"properties":{"data":{"$ref":"#/definitions/ManageFeatureIndexData","description":"List of all retrieved feature toggles"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageFeatureIndexLinks"}}}},"ManageFeatureIndexData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"$ref":"#/definitions/ManageFeatureIndexItems","description":"Array of feature toggle objects"},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageFeatureIndexSort"}}}},"ManageFeatureIndexItems":{"required":["name","enabled","description"],"properties":{"name":{"type":"string","description":"Name of the feature toggle"},"enabled":{"type":"boolean","description":"True if the toggle is enabled, false otherwise"},"description":{"type":"string","description":"Description of the feature toggle"}}},"ManageFeatureIndexSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageFeatureIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageFeatureToggleSchema":{"type":"object","required":["is_enabled"],"properties":{"is_enabled":{"type":"boolean","description":"Status of the feature toggle(s). Set to true to switch the feature(s) on, false otherwise."}}},"ManageFeatureToggleResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageFeatureToggleData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageFeatureToggleData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"true if the request has been successful"}}},"ManageFeatureoptinIndexResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageFeatureoptinIndexData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageFeatureoptinIndexData":{"required":["items"],"properties":{"items":{"type":"array","description":"List of opt-in features available in db and code","items":{"$ref":"#/definitions/ManageFeatureoptinIndexItems"}}}},"ManageFeatureoptinIndexItems":{},"ManageFeatureoptinUpdateSchema":{"type":"object","required":["activation_status"],"properties":{"activation_status":{"type":"string","description":"New activation status"}}},"ManageFeatureoptinUpdateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageFeatureoptinUpdateData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageFeatureoptinUpdateData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"False if updateActivationStatus throws an exception"}}},"ManageFeatureoptinUpdateFeatureSchema":{"type":"object","properties":{"title":{"type":"string","description":"Feature title"},"description":{"type":"string","description":"Feature description"},"availability_date":{"type":"string","description":"Availability date"},"knowledge_base_link":{"type":"string","description":"Knowledge base link"},"metadata":{"type":"string","description":"Feature metadata"}}},"ManageFeatureoptinUpdateFeatureResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageFeatureoptinUpdateFeatureData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageFeatureoptinUpdateFeatureData":{"required":["success"],"properties":{"success":{"type":"boolean","description":""}}},"ManageGamificationSummaryResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageGamificationSummaryData","description":"Response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ManageGamificationSummaryLinks"}}}},"ManageGamificationSummaryData":{"required":["badges","points","leaderboards","recent_badges"],"properties":{"badges":{"type":"integer","description":"Number of badges assigned to this user"},"points":{"type":"integer","description":"Number of points accumulated by this user"},"coins":{"type":"integer","description":"Coins gained by this user (only populated if reward_show_active = true)"},"leaderboards":{"type":"array","description":"Array of 0 or more Leaderboard objects representing all leaderboards visible to this user","items":{"$ref":"#/definitions/ManageGamificationSummaryLeaderboards"}},"recent_badges":{"type":"array","description":"List of icons of the latest badges assigned to the user","items":{"type":"string"}}}},"ManageGamificationSummaryLeaderboards":{"required":["id","title","title_translations","positions"],"properties":{"id":{"type":"integer","description":"The ID of the leaderboard"},"title":{"type":"string","description":"The localized name of the leaderboard"},"title_translations":{"type":"array","description":"Translations for the name of the leaderboard","items":{"$ref":"#/definitions/ManageGamificationSummaryTitleTranslations"}},"positions":{"type":"array","description":"Array of positions of the current leaderboard","items":{"$ref":"#/definitions/ManageGamificationSummaryPositions"}}}},"ManageGamificationSummaryTitleTranslations":{"required":["lang_code","name"],"properties":{"lang_code":{"type":"string","description":"Language code of the translation"},"name":{"type":"string","description":"Translation string"}}},"ManageGamificationSummaryPositions":{"required":["position","points","last_assign","id_user","percentage","is_me","user"],"properties":{"position":{"type":"integer","description":"The numeric rank of the current user(e.g. &quot;6&quot;, &quot;7&quot;, &quot;8&quot;)"},"points":{"type":"integer","description":"Number of points for this position (e.g. 2130)"},"last_assign":{"type":"string","format":"date","description":"Datetime of last assigned badge in yyyy-MM-dd HH:mm:ss format"},"id_user":{"type":"string","description":"User id"},"percentage":{"type":"integer","description":"Percentage value"},"is_me":{"type":"boolean","description":"Whether the current position if that of the logged in user"},"user":{"$ref":"#/definitions/ManageGamificationSummaryUser","description":"The user attributes"}}},"ManageGamificationSummaryUser":{"required":["firstname","lastname","username","avatar"],"properties":{"firstname":{"type":"string","description":"Firstname"},"lastname":{"type":"string","description":"Lastname"},"username":{"type":"string","description":"Username"},"avatar":{"type":"string","description":"The avatar image URL"}}},"ManageGamificationSummaryLinks":{},"ManageGamificationRewardRequestsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageGamificationRewardRequestsData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageGamificationRewardRequestsData":{"required":["items"],"properties":{"items":{"type":"array","description":"List of gamification reward requests","items":{"$ref":"#/definitions/ManageGamificationRewardRequestsItems"}}}},"ManageGamificationRewardRequestsItems":{"required":["id_transaction","reward_name","request_date","status","lastname","username","email"],"properties":{"id_transaction":{"type":"integer","description":"ID of the request"},"reward_name":{"type":"string","description":"Name of the reward"},"request_date":{"type":"string","description":"Request datetime"},"status":{"description":"Status of the request","enum":["approved","rejected","waiting","canceled"],"type":"string"},"firstname":{"type":"string","description":"First name of the user"},"lastname":{"type":"string","description":"Last name of the user"},"username":{"type":"string","description":"Username of the user"},"email":{"type":"string","description":"Email of the user"}}},"ManageGamificationBadgesResponse":{"required":["data","version","version","version","extra_data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageGamificationBadgesData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"$ref":"#/definitions/ManageGamificationBadgesExtraData","description":""},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/ManageGamificationBadgesLinks"}}}},"ManageGamificationBadgesData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"User assigned badges","items":{"$ref":"#/definitions/ManageGamificationBadgesItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageGamificationBadgesSort"}}}},"ManageGamificationBadgesItems":{"required":["id_badge","id_user","total_score","issued_on","badge_icon","badge_icon_original","badge_name","badge_description","total_badges_count","is_shareable"],"properties":{"id_badge":{"type":"integer","description":"Internal ID of the badge"},"id_user":{"type":"integer","description":"Internal ID of the user"},"total_score":{"type":"integer","description":"Total score, that user receive from the unique badge"},"issued_on":{"type":"string","description":"Last issued date of the unique badge"},"badge_icon":{"type":"string","description":"URL of the badge icon"},"badge_icon_original":{"type":"string","description":"URL of the badge icon in original size"},"badge_name":{"type":"string","description":"Localized name of the badge"},"badge_description":{"type":"string","description":"Localized description of the badge"},"total_badges_count":{"type":"integer","description":"Number of assignments of this badge"},"is_shareable":{"type":"boolean","description":"True if badge is shareable"}}},"ManageGamificationBadgesSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageGamificationBadgesExtraData":{"required":["total_points","not_awarded_count","wallet_total_points"],"properties":{"total_points":{"type":"integer","description":"Number of user total points from badges"},"not_awarded_count":{"type":"integer","description":"Number of badges, that user has not awarded yet."},"wallet_total_points":{"type":"integer","description":"Number of user total points from wallet."}}},"ManageGamificationBadgesLinks":{},"ManageGamificationLeaderboardsResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageGamificationLeaderboardsData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageGamificationLeaderboardsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageGamificationLeaderboardsData":{"required":["items","count","cursor","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Leaderboard data","items":{"$ref":"#/definitions/ManageGamificationLeaderboardsItems"}},"count":{"type":"integer","description":"Total number of items returned"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageGamificationLeaderboardsSort"}}}},"ManageGamificationLeaderboardsItems":{"required":["id_board","name","is_active","default","is_visible","anonymity"],"properties":{"id_board":{"type":"integer","description":"Internal ID of the board"},"name":{"type":"string","description":"Localized name of the board"},"is_active":{"type":"boolean","description":"Status of the board"},"default":{"type":"boolean","description":"Is the board the default one of the LMS (including all users)"},"is_visible":{"type":"boolean","description":"Is board visible to the requested user"},"anonymity":{"type":"boolean","description":"If this field is true, a user can see only his position, not the name of the other users"},"visible_by":{"$ref":"#/definitions/ManageGamificationLeaderboardsVisibleBy","description":"Leaderboard users visibility"},"positions":{"type":"array","description":"Positions of the users in the board, ordered by position.","items":{"$ref":"#/definitions/ManageGamificationLeaderboardsPositions"}},"my_position":{"$ref":"#/definitions/ManageGamificationLeaderboardsMyPosition","description":"Requested user position in the board"}}},"ManageGamificationLeaderboardsVisibleBy":{"required":["selection"],"properties":{"selection":{"description":"Type of visibility","enum":["all","segment_branch","custom"],"type":"string"},"groups":{"type":"array","description":"Defines which group is included","items":{"type":"integer"}},"branches":{"type":"array","description":"Defines which branches are included and what its tree parameter are","items":{"$ref":"#/definitions/ManageGamificationLeaderboardsBranches"}}}},"ManageGamificationLeaderboardsBranches":{"required":["id","lev","iLeft","iRight","include_descendants"],"properties":{"id":{"type":"integer","description":"Branch ID"},"lev":{"type":"integer","description":"Branch level in the hierarchical tree"},"iLeft":{"type":"integer","description":"Left value for the hierarchical tree"},"iRight":{"type":"integer","description":"Right value for the hierarchical tree"},"include_descendants":{"type":"boolean","description":"True if descendant branches are included, false otherwise"}}},"ManageGamificationLeaderboardsPositions":{"required":["points","last_assign","id_user","userid","is_me","user","percentage","position"],"properties":{"points":{"type":"integer","description":"Total points of the user"},"last_assign":{"type":"string","description":"Last assigned badge date"},"id_user":{"type":"integer","description":"Internal ID of the user"},"userid":{"type":"string","description":"Unique ID of the user"},"is_me":{"type":"boolean","description":"Is this user is requested one"},"user":{"$ref":"#/definitions/ManageGamificationLeaderboardsUser","description":"User data"},"percentage":{"type":"integer","description":"Percentage of points compared to the first in the leaderboard"},"position":{"type":"integer","description":"Position of the user in the board"}}},"ManageGamificationLeaderboardsUser":{"properties":{"firstname":{"type":"string","description":"First name of the user"},"lastname":{"type":"string","description":"Last name of the user"},"username":{"type":"string","description":"Username"},"avatar":{"type":"string","description":"URL of the user&#039;s avatar"}},"required":["username"]},"ManageGamificationLeaderboardsMyPosition":{"required":["points","is_me","user","percentage","position"],"properties":{"points":{"type":"integer","description":"Total points of the requested user"},"last_assign":{"type":"string","description":"Last assigned badge date"},"id_user":{"type":"integer","description":"Internal ID of the requested user"},"userid":{"type":"string","description":"Unique ID of the user"},"is_me":{"type":"boolean","description":"Is this user is requested one"},"user":{"$ref":"#/definitions/ManageGamificationLeaderboardsUserL2","description":"User data"},"percentage":{"type":"integer","description":"Percentage of points compared to the first in the leaderboard"},"position":{"type":"integer","description":"Position of the requested user in the board"}}},"ManageGamificationLeaderboardsUserL2":{"properties":{"firstname":{"type":"string","description":"First name of the requested user"},"lastname":{"type":"string","description":"Last name of the requested user"},"username":{"type":"string","description":"Username"},"avatar":{"type":"string","description":"URL of the requested user&#039;s avatar"}},"required":["username"]},"ManageGamificationLeaderboardsSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["code","name","type","is_public"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"ManageGamificationLeaderboardsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/ManageGamificationLeaderboardsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ManageGamificationLeaderboardsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ManageGamificationLeaderboardsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ManageGamificationLeaderboardsLast","description":"Link to the last page"}}},"ManageGamificationLeaderboardsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"ManageGamificationLeaderboardsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"ManageGamificationLeaderboardsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"ManageGamificationLeaderboardsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"ManageGamificationContestsResponse":{"required":["data","version","version"],"properties":{"data":{"$ref":"#/definitions/ManageGamificationContestsData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"type":"array","description":"Additional upcoming contests","items":{"$ref":"#/definitions/ManageGamificationContestsExtraData"}}}},"ManageGamificationContestsData":{"required":["items"],"properties":{"items":{"type":"array","description":"Contests","items":{"$ref":"#/definitions/ManageGamificationContestsItems"}}}},"ManageGamificationContestsItems":{"required":["id","from_date","to_date","timezone","goal","name","description","rank"],"properties":{"id":{"type":"integer","description":"Internal ID of the contest"},"from_date":{"type":"string","description":"Contest start date"},"to_date":{"type":"string","description":"Contest end date"},"timezone":{"type":"string","description":"Contest timezone"},"goal":{"type":"string","description":"Localized goal name"},"name":{"type":"string","description":"Contest name"},"description":{"type":"string","description":"Contest description"},"rank":{"type":"integer","description":"Rank of the user, e.g. 1,2,3"},"id_badge":{"type":"integer","description":"Internal ID of the badge"},"score":{"type":"integer","description":"Points of the badge/reward"},"icon":{"type":"string","description":"URL of the badge/reward"}}},"ManageGamificationContestsExtraData":{"required":["name","from_date","to_date","timezone"],"properties":{"name":{"type":"string","description":"Localized name of the contest"},"from_date":{"type":"string","description":"Contest start date"},"to_date":{"type":"string","description":"Contest end date"},"timezone":{"type":"string","description":"Contest timezone"}}},"ManageGamificationUpdateStatusSchema":{"type":"object","required":["status"],"properties":{"status":{"description":"A new status of the request","enum":["approved","rejected","pending"],"type":"string"}}},"ManageGamificationUpdateStatusResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageGamificationUpdateStatusData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageGamificationUpdateStatusData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation: true - success; false - error"}}},"ManageGamificationSendMessageSchema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Message body (can contain HTML)"}}},"ManageGamificationSendMessageResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageGamificationSendMessageData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageGamificationSendMessageData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"}}},"ManageGlobalsearchSearchResponse":{"required":["data","version","_links"],"properties":{"data":{"$ref":"#/definitions/ManageGlobalsearchSearchData","description":"List of all retrieved Elastic search tabs"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"type":"null"}}}},"ManageGlobalsearchSearchData":{"required":["results"],"properties":{"results":{"type":"array","description":"Array of searched results","items":{"$ref":"#/definitions/ManageGlobalsearchSearchResults"}}}},"ManageGlobalsearchSearchResults":{"properties":{"course_type":{"type":"string","description":"Type fo the course - elearning,..."},"is_user_enrolled":{"type":"integer","description":"If the user is enrolled in a course/plan/..."},"id":{"type":"integer","description":"Id of the result item"},"type":{"type":"string","description":"Type of the result item"},"index":{"type":"string","description":"Domain"},"score":{"type":"number","format":"float","description":"Hit relevancy"},"uri":{"type":"string","description":"Url of the result item"},"title":{"type":"string","description":"Title of the result item"},"duration":{"type":"integer","description":"Duration of the result item"},"rating":{"type":"number","format":"float","description":"Rating of the result item"},"is_new":{"type":"boolean","description":"Status is new of the result item"},"actions":{"type":"array","description":"Actions of the result item","items":{"type":"null"}},"type_id":{"type":"string","description":"Possible values: my-course, my-lp, asset, playlist, learning-object"},"image":{"type":"string","description":"Image of the result item"},"epriority":{"description":"Enrollment priority for the user. It can be null.","enum":["mandatory","required","recommended","optional"],"type":"string"},"item_language":{"type":"string","description":"The item language"},"item_language_label":{"type":"string","description":"The item language label"},"lang_code":{"type":"string","description":"Course default language browser code information. Only available when the multi-language feature is on."},"multi_languages":{"type":"array","description":"Course multi-language information. Only available for E-learning courses when the multi-language feature is on.","items":{"$ref":"#/definitions/ManageGlobalsearchSearchMultiLanguages"}},"has_embedding":{"type":"boolean","description":"Whether the item has embedding data. Default: false"},"other_fields":{"type":"array","description":"Actions of the item","items":{"$ref":"#/definitions/ManageGlobalsearchSearchOtherFields"}},"document":{"$ref":"#/definitions/ManageGlobalsearchSearchDocument","description":"Document of the item"}},"required":["id","type","index","score","uri","title","duration","rating","is_new","actions","type_id","image","other_fields"]},"ManageGlobalsearchSearchMultiLanguages":{"required":["code","name","browser_code"],"properties":{"code":{"type":"string","description":"Code of the course language"},"name":{"type":"string","description":"Name of the course language"},"browser_code":{"type":"string","description":"Browser code (2 characters) of the course language"}}},"ManageGlobalsearchSearchOtherFields":{"properties":{"status_id":{"type":"string","description":"The user status identifier (i.e. &quot;subscribed&quot;, &quot;in_progress&quot;, &quot;completed&quot;)"},"status_label":{"type":"string","description":"The localized status label to display"},"courses_count":{"type":"integer","description":"he number of courses in the learning plan"},"can_enter":{"type":"boolean","description":"Whether clicking on the item is allowed. Default = true"},"can_enter_reason":{"type":"string","description":"If can_enter is true, this contains the message to display in the tooltip when you click/tap on the lock overlay or on the &quot;?&quot; icon in the bottom right corner. Default = empty"},"expiration_date":{"type":"string","description":"The MYSQL UTC expiration date for this enrollment/course. It must be formatted to display the &quot;15 days left&quot; red message"},"language":{"type":"string","description":"The item language"},"language_label":{"type":"string","description":"The item language label"},"level":{"type":"string","description":"The user level inside the course"},"type":{"type":"string","description":"The type of course. Possible values: elearning, classroom"},"is_watched":{"type":"boolean","description":"Whether the asset was watched by the user"},"status":{"type":"integer","description":"The asset status"},"is_private":{"type":"boolean","description":"Private asset or not"},"views":{"type":"integer","description":"how many times the asset was viewed"},"publish_date":{"type":"string","description":"Publication date of asset"},"assets_count":{"type":"integer","description":"The number of assets in the playlist"},"slug_name":{"type":"string","description":"Slug name of the item"},"course_title":{"type":"string","description":"Course title of the learning object"},"course_type":{"type":"string","description":"Course type where learning object is located"}}},"ManageGlobalsearchSearchDocument":{"properties":{"url":{"type":"string","description":"Url of the document"},"skill_names":{"type":"array","description":"Skill names of the document","items":{"$ref":"#/definitions/ManageGlobalsearchSearchSkillNames"}}}},"ManageGlobalsearchSearchSkillNames":{"properties":{"skill_codes":{"type":"array","description":"Skill codes of the document","items":{"$ref":"#/definitions/ManageGlobalsearchSearchSkillCodes"}},"metadata":{"$ref":"#/definitions/ManageGlobalsearchSearchMetadata","description":"Question metadata"},"owner":{"$ref":"#/definitions/ManageGlobalsearchSearchOwner","description":"Return owner of question object"},"related":{"$ref":"#/definitions/ManageGlobalsearchSearchRelated","description":"Return asset or learning organization or channel object"},"tags":{"type":"array","description":"Array of question tags","items":{"$ref":"#/definitions/ManageGlobalsearchSearchTags"}},"best":{"$ref":"#/definitions/ManageGlobalsearchSearchBest","description":"Question best answer"}}},"ManageGlobalsearchSearchSkillCodes":{},"ManageGlobalsearchSearchMetadata":{"properties":{"created_at":{"type":"string","description":"Question date of creation"},"views":{"type":"integer","description":"Question views"},"answers":{"type":"integer","description":"Total number of question answers"},"new_answers":{"type":"integer","description":"Total number of question new answers"},"is_following":{"type":"boolean","description":"Question flag - is following"},"is_new":{"type":"boolean","description":"Question flag - is new"},"read_only":{"type":"boolean","description":"Can answer flag"},"is_related":{"type":"boolean","description":"Is this question have relation to an asset or learning object or channel"},"related_kind":{"type":"string","description":"Type of relation - coach_share or learning_object or channel"},"have_best":{"type":"boolean","description":"If question have best answer - true, otherwise - false"},"have_last":{"type":"boolean","description":"If question have last answer - true, otherwise - false"}}},"ManageGlobalsearchSearchOwner":{"properties":{"id":{"type":"integer","description":"ID of the owner"},"short_name":{"type":"string","description":"Short name of the owner"},"full_name":{"type":"string","description":"Full name of the owner"},"avatar":{"type":"string","description":"Avatar of the owner"},"uuid":{"type":"string","description":"UUID of the owner"}}},"ManageGlobalsearchSearchRelated":{"properties":{"id":{"type":"integer","description":"ID of the asset"},"title":{"type":"string","description":"Asset title"},"description":{"type":"string","description":"Asset description"},"date_created":{"type":"string","description":"Asset date of creation"},"kind":{"$ref":"#/definitions/ManageGlobalsearchSearchKind","description":"Return type of asset object"},"info":{"$ref":"#/definitions/ManageGlobalsearchSearchInfo","description":"Return asset information object"},"thumbnail":{"$ref":"#/definitions/ManageGlobalsearchSearchThumbnail","description":"Return thumbnail of asset object"},"owner":{"$ref":"#/definitions/ManageGlobalsearchSearchOwnerL2","description":"Return owner of asset object"}}},"ManageGlobalsearchSearchKind":{"required":["type"],"properties":{"type":{"type":"integer","description":"Asset type code"},"general":{"type":"string","description":"Basic type of asset"},"sub":{"type":"string","description":"Sub - type of asset"}}},"ManageGlobalsearchSearchInfo":{"properties":{"duration":{"type":"string","description":"Duration of asset"},"duration_unit":{"type":"string","description":"Duration unit of asset"},"history":{"$ref":"#/definitions/ManageGlobalsearchSearchHistory","description":"History of asset"}}},"ManageGlobalsearchSearchHistory":{"properties":{"published":{"$ref":"#/definitions/ManageGlobalsearchSearchPublished","description":"Published history of asset"},"last_edit":{"$ref":"#/definitions/ManageGlobalsearchSearchLastEdit","description":"Last edit history of asset"},"edit":{"$ref":"#/definitions/ManageGlobalsearchSearchEdit","description":"Edit history of asset"}}},"ManageGlobalsearchSearchPublished":{"properties":{"id":{"type":"integer","description":"ID of asset"},"full_name":{"type":"string","description":"Full Name of publisher"},"short_name":{"type":"string","description":"Short Name of publisher"},"avatar":{"type":"string","description":"Avatar of publisher"},"created_at":{"type":"string","description":"Publication Date"}}},"ManageGlobalsearchSearchLastEdit":{"properties":{"id":{"type":"integer","description":"ID of asset"},"full_name":{"type":"string","description":"Full Name of last editor of asset"},"short_name":{"type":"string","description":"Short Name of last editor of asset"},"avatar":{"type":"string","description":"Avatar of last editor of asset"},"created_at":{"type":"string","description":"Date of last edit"}}},"ManageGlobalsearchSearchEdit":{"properties":{"id":{"type":"integer","description":"ID of asset"},"full_name":{"type":"string","description":"Full Name of editor of asset"},"short_name":{"type":"string","description":"Short Name of editor of asset"},"avatar":{"type":"string","description":"Avatar of editor of asset"},"created_at":{"type":"string","description":"Date of edit"}}},"ManageGlobalsearchSearchThumbnail":{"properties":{"small":{"type":"string","description":"Small thumbnail of asset"},"video":{"type":"string","description":"Video thumbnail of asset"},"original":{"type":"string","description":"Original thumbnail of asset"},"carousel":{"type":"string","description":"Carousel of asset"}}},"ManageGlobalsearchSearchOwnerL2":{"properties":{"id":{"type":"integer","description":"ID of the owner"},"short_name":{"type":"string","description":"Short name of the owner"},"full_name":{"type":"string","description":"Full name of the owner"},"avatar":{"type":"string","description":"Avatar of the owner"},"uuid":{"type":"string","description":"UUID of the owner"},"is_expert":{"type":"boolean","description":"Is this expert to channel or not"}}},"ManageGlobalsearchSearchTags":{"properties":{"id":{"type":"integer","description":"ID of the tag"},"name":{"type":"string","description":"Name of the tag"}}},"ManageGlobalsearchSearchBest":{"properties":{"id":{"$ref":"#/definitions/ManageGlobalsearchSearchId","description":"Best answer id"}}},"ManageGlobalsearchSearchId":{"properties":{"title":{"$ref":"#/definitions/ManageGlobalsearchSearchTitle","description":"Best answer title"},"last":{"$ref":"#/definitions/ManageGlobalsearchSearchLast","description":"Question last answer"}}},"ManageGlobalsearchSearchTitle":{"properties":{"is_best":{"type":"boolean","description":"Is best answer"},"read_only":{"type":"boolean","description":"Is read only for this user"},"created_at":{"type":"string","description":"Answer date of creation"},"rating":{"$ref":"#/definitions/ManageGlobalsearchSearchRating","description":"Best answer rating"},"owner":{"$ref":"#/definitions/ManageGlobalsearchSearchOwnerL3","description":"Return owner of best answer object"}}},"ManageGlobalsearchSearchRating":{"properties":{"likes":{"type":"integer","description":"Best answer likes"},"dislikes":{"type":"integer","description":"Best answer dislikes"}}},"ManageGlobalsearchSearchOwnerL3":{"properties":{"id":{"type":"integer","description":"ID of the owner"},"short_name":{"type":"string","description":"Short name of the owner"},"full_name":{"type":"string","description":"Full name of the owner"},"avatar":{"type":"string","description":"Avatar of the owner"},"uuid":{"type":"string","description":"UUID of the owner"}}},"ManageGlobalsearchSearchLast":{"required":["id"],"properties":{"id":{"$ref":"#/definitions/ManageGlobalsearchSearchIdL2","description":"Last answer id"}}},"ManageGlobalsearchSearchIdL2":{"required":["title"],"properties":{"title":{"$ref":"#/definitions/ManageGlobalsearchSearchTitleL2","description":"Last answer title"},"sub_items":{"type":"array","description":"Array of question answers","items":{"$ref":"#/definitions/ManageGlobalsearchSearchSubItems"}}}},"ManageGlobalsearchSearchTitleL2":{"required":["is_best","read_only","created_at","rating","owner"],"properties":{"is_best":{"type":"boolean","description":"Is best answer"},"read_only":{"type":"boolean","description":"Is read only for this user"},"created_at":{"type":"string","description":"Answer date of creation"},"rating":{"$ref":"#/definitions/ManageGlobalsearchSearchRatingL2","description":"Last answer rating"},"owner":{"$ref":"#/definitions/ManageGlobalsearchSearchOwnerL4","description":"Return owner of last answer object"}}},"ManageGlobalsearchSearchRatingL2":{"required":["likes","dislikes"],"properties":{"likes":{"type":"integer","description":"Last answer likes"},"dislikes":{"type":"integer","description":"Last answer dislikes"}}},"ManageGlobalsearchSearchOwnerL4":{"required":["id","short_name","full_name","avatar"],"properties":{"id":{"type":"integer","description":"ID of the owner"},"short_name":{"type":"string","description":"Short name of the owner"},"full_name":{"type":"string","description":"Full name of the owner"},"avatar":{"type":"string","description":"Avatar of the owner"},"uuid":{"type":"string","description":"UUID of the owner"}}},"ManageGlobalsearchSearchSubItems":{"required":["id","suggestions","next_from","end_of_results","grand_total","recent_searches"],"properties":{"id":{"$ref":"#/definitions/ManageGlobalsearchSearchIdL3","description":"Answer id"},"highlight":{"$ref":"#/definitions/ManageGlobalsearchSearchHighlight","description":"Highlighted search terms in the content"},"ecommerce":{"$ref":"#/definitions/ManageGlobalsearchSearchEcommerce","description":"The ecommerce pricing system"},"suggestions":{"type":"array","description":"Return playlist objects","items":{"type":"null"}},"next_from":{"type":"integer","description":"Next index to start from, in case of pagination"},"end_of_results":{"type":"boolean","description":"True if the current page is the last page"},"grand_total":{"type":"integer","description":"Total number of items FOUND (not returned, but FOUND on ES)"},"recent_searches":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageGlobalsearchSearchRecentSearches"}}}},"ManageGlobalsearchSearchIdL3":{"required":["title"],"properties":{"title":{"$ref":"#/definitions/ManageGlobalsearchSearchTitleL3","description":"Answer title"}}},"ManageGlobalsearchSearchTitleL3":{"required":["is_best","read_only","created_at","rating","owner"],"properties":{"is_best":{"type":"boolean","description":"Is best answer"},"read_only":{"type":"boolean","description":"Is read only for this user"},"created_at":{"type":"string","description":"Answer date of creation"},"rating":{"$ref":"#/definitions/ManageGlobalsearchSearchRatingL3","description":"Answer rating"},"owner":{"$ref":"#/definitions/ManageGlobalsearchSearchOwnerL5","description":"Return owner of answer object"}}},"ManageGlobalsearchSearchRatingL3":{"required":["likes","dislikes"],"properties":{"likes":{"type":"integer","description":"Answer likes"},"dislikes":{"type":"integer","description":"Answer dislikes"}}},"ManageGlobalsearchSearchOwnerL5":{"required":["id","short_name","full_name","avatar","is_expert"],"properties":{"id":{"type":"integer","description":"ID of the owner"},"short_name":{"type":"string","description":"Short name of the owner"},"full_name":{"type":"string","description":"Full name of the owner"},"avatar":{"type":"string","description":"Avatar of the owner"},"uuid":{"type":"string","description":"UUID of the owner"},"is_expert":{"type":"boolean","description":"Is this user is Expert to channel"}}},"ManageGlobalsearchSearchHighlight":{},"ManageGlobalsearchSearchEcommerce":{"properties":{"sold_individually":{"type":"boolean","description":"Whether the content can be sold individually or not"},"price":{"type":"string","description":"The price from the external pricing system"},"discounted_price":{"type":"string","description":"The discounted price from the external pricing system"},"currency":{"type":"string","description":"The currency from the external pricing system"},"currency_symbol":{"type":"string","description":"The currency symbol from the external pricing system"},"currency_extended_name":{"type":"string","description":"The currency from the external pricing system"},"alternative_purchase_options":{"$ref":"#/definitions/ManageGlobalsearchSearchAlternativePurchaseOptions","description":""}},"required":["price","currency","currency_symbol","currency_extended_name"]},"ManageGlobalsearchSearchAlternativePurchaseOptions":{"properties":{"subscription_plans_resume_page_url":{"type":"string","description":"The redirect url as alternative purchase"}}},"ManageGlobalsearchSearchRecentSearches":{},"ManageGlobalsearchInitialResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageGlobalsearchInitialData","description":"List of all retrieved Elastic search tabs"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageGlobalsearchInitialData":{"required":["tabs"],"properties":{"tabs":{"$ref":"#/definitions/ManageGlobalsearchInitialTabs","description":"Return playlist objects"}}},"ManageGlobalsearchInitialTabs":{"required":["title","count","filters","group"],"properties":{"title":{"type":"string","description":"Title of the tab"},"count":{"type":"integer","description":"Total count of tab items"},"filters":{"$ref":"#/definitions/ManageGlobalsearchInitialFilters","description":"Filters for this tab. It is returned empty when there are no applicable filters. The content depends on the specific tab"},"group":{"type":"integer","description":"ID of the tab"},"classroom_filters":{"$ref":"#/definitions/ManageGlobalsearchInitialClassroomFilters","description":"Additional fields filter for ILT sessions. It is returned only when it is possible to filter by this additional field. The content depends on the available fields"}}},"ManageGlobalsearchInitialFilters":{},"ManageGlobalsearchInitialClassroomFilters":{},"ManageImporterCreatePresetSchema":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"User defined name for the preset"},"type":{"type":"string","description":"Category the preset belongs to"},"datasource_params":{"$ref":"#/definitions/ManageImporterCreatePresetDatasourceParams","description":"A JS object containing type specific parameters for the datasource (eg: &#039;csv_delimiter&#039;, &#039;csv_charset&#039;,...)"},"options":{"$ref":"#/definitions/ManageImporterCreatePresetOptions","description":"A JS object containing type specific import options (eg: &quot;update_users&quot;, &quot;target_branch&quot;,...)"},"mapping":{"type":"array","description":"A 0-based array of field identifiers representing the fields mapped to each column (e.g. [&quot;firstname&quot;, &quot;field_1&quot;, &quot;password&quot;...])","items":{"type":"string"}}}},"ManageImporterCreatePresetDatasourceParams":{},"ManageImporterCreatePresetOptions":{},"ManageImporterCreatePresetResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageImporterCreatePresetData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageImporterCreatePresetData":{"required":["preset_id"],"properties":{"preset_id":{"type":"integer","description":"The internal ID for the new preset."}}},"ManageImporterViewPresetsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageImporterViewPresetsData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageImporterViewPresetsData":{"required":["presets"],"properties":{"presets":{"type":"array","description":"The matching presets for the selected type and current user","items":{"$ref":"#/definitions/ManageImporterViewPresetsPresets"}}}},"ManageImporterViewPresetsPresets":{"required":["id","name"],"properties":{"id":{"type":"integer","description":"Internal preset ID"},"name":{"type":"string","description":"User defined name for the preset"},"datasource_params":{"$ref":"#/definitions/ManageImporterViewPresetsDatasourceParams","description":"A JS object containing type specific parameters for the datasource (eg: &quot;csv_delimiter&quot;, &quot;csv_charset&quot;,...)"},"options":{"$ref":"#/definitions/ManageImporterViewPresetsOptions","description":"A JS object containing type specific import options (eg: &quot;update_users&quot;, &quot;target_branch&quot;,...)"},"mapping":{"type":"array","description":"A 0-based array of field identifiers representing the fields mapped to each column (e.g. [&quot;firstname&quot;, &quot;field_1&quot;, &quot;password&quot;...])","items":{"type":"string"}}}},"ManageImporterViewPresetsDatasourceParams":{},"ManageImporterViewPresetsOptions":{},"ManageImporterUpdatePresetSchema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"User defined name for the preset"},"datasource_params":{"$ref":"#/definitions/ManageImporterUpdatePresetDatasourceParams","description":"A JS object containing type specific parameters for the datasource (eg: &quot;csv_delimiter&quot;, &quot;csv_charset&quot;,...)"},"options":{"$ref":"#/definitions/ManageImporterUpdatePresetOptions","description":"A JS object containing type specific import options (eg: &quot;update_users&quot;, &quot;target_branch&quot;,...)"},"mapping":{"type":"array","description":"A 0-based array of field identifiers representing the fields mapped to each column (e.g. [&quot;firstname&quot;, &quot;field_1&quot;, &quot;password&quot;...])","items":{"type":"string"}}}},"ManageImporterUpdatePresetDatasourceParams":{},"ManageImporterUpdatePresetOptions":{},"ManageImporterUpdatePresetResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageImporterUpdatePresetData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageImporterUpdatePresetData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Returns true when no issue has been encountered."}}},"ManageImporterDeletePresetResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageImporterDeletePresetData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageImporterDeletePresetData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Returns true when no issue has been encountered."}}},"ManageImporterGetCsvSampleDataResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageImporterGetCsvSampleDataData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageImporterGetCsvSampleDataData":{"required":["count"],"properties":{"count":{"type":"integer","description":"The number of records in the CSV file"},"columns":{"type":"array","description":"If skip_first_row is true, contains the values of the first row","items":{"$ref":"#/definitions/ManageImporterGetCsvSampleDataColumns"}}}},"ManageImporterGetCsvSampleDataColumns":{"required":["samples"],"properties":{"samples":{"type":"array","description":"Contains the first 3 rows of the file","items":{"$ref":"#/definitions/ManageImporterGetCsvSampleDataSamples"}}}},"ManageImporterGetCsvSampleDataSamples":{},"ManageImporterDownloadCsvSampleResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageImporterDownloadCsvSampleData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageImporterDownloadCsvSampleData":{"required":["url"],"properties":{"url":{"type":"string","description":"URL of the CSV File in Amazon S3"}}},"ManageJobCreateSchema":{"type":"object","required":["name","endpoint","method","type","data_source"],"properties":{"name":{"type":"string","description":"Job title (e.g. &quot;Importing users from CSV&quot;)"},"endpoint":{"type":"string","description":"The endpoint of the batch API that will process each chunk of records and return errors &amp; output (e.g. &quot;/manage/v1/user/batch&quot;)"},"method":{"description":"The HTTP method to use when calling the &quot;endpoint&quot;","enum":["GET","POST","PUT","DELETE"],"type":"string"},"chunk_size":{"type":"integer","description":"The maximum size of the chunk that the endpoint accepts. If not provided, it defaults to 100"},"type":{"description":"The type of data source","enum":["importer","api","polling"],"type":"string"},"data_source":{"$ref":"#/definitions/ManageJobCreateDataSource","description":"An object containing data source configuration params specific of the data_source type, Check implementation notes."},"notify":{"type":"boolean","description":"Whether the job executor should send a notification to the author when the job is completed state. Default: true"},"hidden":{"type":"boolean","description":"Hides the background job from the list. Default: false"},"notify_email":{"type":"string","description":"Notifications will be sent to this email, if it&#039;s empty they will be sent to the user that created the background job"},"notify_type":{"description":"The transport used for notification. Default: email","enum":["email","inbox","email_and_inbox"],"type":"string"},"include_data_source_in_log_file":{"type":"boolean","description":"If true, in case of errors the source data will be added to logs."}}},"ManageJobCreateDataSource":{},"ManageJobCreateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageJobCreateData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageJobCreateData":{"required":["job_descriptor"],"properties":{"job_descriptor":{"$ref":"#/definitions/ManageJobCreateJobDescriptor","description":"Job descriptor record containing information about the newly created job."}}},"ManageJobCreateJobDescriptor":{"required":["name","hash","author_id","author_name","date_created","last_update","domain","processed_records","total","errors","log_file","status","notify","notify_email","notify_type"],"properties":{"name":{"type":"string","description":"The Name of the job."},"hash":{"type":"string","description":"The UUID of the job."},"author_id":{"type":"integer","description":"The user ID who created this job."},"author_name":{"type":"string","description":"The name of the user that created this job."},"date_created":{"type":"string","format":"date","description":"The MYSQL UTC datetime of when the job was created."},"last_update":{"type":"string","format":"date","description":"The MYSQL UTC datetime of when the job was last updated."},"domain":{"type":"string","description":"The LMS domain from where the job was posted."},"processed_records":{"type":"integer","description":"The number of processed records by the current job."},"total":{"type":"integer","description":"The total amount of records calculated for this job. If job type is &quot;importer&quot; the value will be empty."},"errors":{"type":"integer","description":"How many errors were raised so far during the process."},"log_file":{"type":"string","description":"The UUID of the job."},"status":{"description":"The current status of the job.","enum":["queued","running","aborted","completed"],"type":"string"},"notify":{"type":"boolean","description":"If set to true, the system will notify the user when the job is completed. (Default to true)"},"hidden":{"type":"boolean","description":"If set to true, the background job will be hidden. Default: false"},"notify_email":{"type":"string","description":"Notifications will be sent to this email, if it&#039;s empty they will be sent to the user that created the background job"},"notify_type":{"description":"The transport used for notification","enum":["email","inbox","email_and_inbox"],"type":"string"},"custom_queue":{"type":"string","description":"Custom queue name"},"custom_worker":{"type":"string","description":"Custom queue name"}}},"ManageJobDeleteResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageJobDeleteData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageJobDeleteData":{"properties":{"success":{"type":"boolean","description":"Whether the operation was successful."}}},"ManageJobIndexResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageJobIndexData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageJobIndexData":{"required":["jobs"],"properties":{"jobs":{"type":"array","description":"Array of job descriptors.","items":{"$ref":"#/definitions/ManageJobIndexJobs"}}}},"ManageJobIndexJobs":{"required":["job_descriptor"],"properties":{"job_descriptor":{"$ref":"#/definitions/ManageJobIndexJobDescriptor","description":"Job descriptor record containing information about the requested job."}}},"ManageJobIndexJobDescriptor":{"required":["name","hash","author_id","author_name","date_created","last_update","download","download_csv_label","download_csv_url","domain","processed_records","total","errors","log_file","status","notify","notify_email","notify_type"],"properties":{"name":{"type":"string","description":"The Name of the job."},"hash":{"type":"string","description":"The UUID of the job."},"author_id":{"type":"integer","description":"The user ID who created this job."},"author_name":{"type":"string","description":"The name of the user that created this job."},"date_created":{"type":"string","format":"date","description":"The MYSQL UTC datetime of when the job was created."},"last_update":{"type":"string","format":"date","description":"The MYSQL UTC datetime of when the job was last updated."},"download":{"$ref":"#/definitions/ManageJobIndexDownload","description":""},"download_csv_label":{"type":"string","description":"Download csv label"},"download_csv_url":{"type":"string","description":"Download csv url"},"domain":{"type":"string","description":"The LMS domain from where the job was posted."},"processed_records":{"type":"integer","description":"The number of processed records by the current job."},"total":{"type":"integer","description":"The total amount of records calculated for this job. If job type is &quot;importer&quot; the value will be empty."},"errors":{"type":"integer","description":"How many errors were raised so far during the process."},"log_file":{"type":"string","description":"The UUID of the job."},"status":{"description":"The current status of the job.","enum":["queued","running","aborted","completed"],"type":"string"},"hidden":{"type":"boolean","description":"If set to true, the background jobs is hidden"},"notify":{"type":"boolean","description":"If set to true, the system will notify the user by mail when the job is completed. (Default to true)"},"notify_email":{"type":"string","description":"The email address to notify when the job is completed."},"notify_type":{"description":"The transport used for notification","enum":["email","inbox","email_and_inbox"],"type":"string"}}},"ManageJobIndexDownload":{"required":["csv_label","csv_url"],"properties":{"csv_label":{"type":"string","description":"Download csv label"},"csv_url":{"type":"string","description":"Download csv url"}}},"ManageJobUpdateSchema":{"type":"object","properties":{"notify":{"type":"boolean","description":"Checks whether the job executor should email the author when it transitions into the &quot;completed&quot; state."},"abort":{"type":"boolean","description":"If passed as true, it sets the new status of the job to &quot;aborted&quot; and stops its execution."}}},"ManageJobUpdateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageJobUpdateData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageJobUpdateData":{"properties":{"success":{"type":"boolean","description":"Whether the operation was successful."}}},"ManageJobViewResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageJobViewData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageJobViewData":{"required":["job_descriptor"],"properties":{"job_descriptor":{"$ref":"#/definitions/ManageJobViewJobDescriptor","description":"Job descriptor record containing information about the requested job."}}},"ManageJobViewJobDescriptor":{"required":["name","hash","author_id","author_name","date_created","last_update","domain","processed_records","total","errors","log_file","status","notify","notify_email","notify_type"],"properties":{"name":{"type":"string","description":"The Name of the job."},"hash":{"type":"string","description":"The UUID of the job."},"author_id":{"type":"integer","description":"The user ID who created this job."},"author_name":{"type":"string","description":"The name of the user that created this job."},"date_created":{"type":"string","format":"date","description":"The MYSQL UTC datetime of when the job was created."},"last_update":{"type":"string","format":"date","description":"The MYSQL UTC datetime of when the job was last updated."},"domain":{"type":"string","description":"The LMS domain from where the job was posted."},"processed_records":{"type":"integer","description":"The number of processed records by the current job."},"total":{"type":"integer","description":"The total amount of records calculated for this job. If job type is &quot;importer&quot; the value will be empty."},"errors":{"type":"integer","description":"How many errors were raised so far during the process."},"log_file":{"type":"string","description":"The UUID of the job."},"hidden":{"type":"boolean","description":"If set to true, the background job will be hidden. Default: false"},"status":{"description":"The current status of the job.","enum":["queued","running","aborted","completed"],"type":"string"},"notify":{"type":"boolean","description":"If set to true, the system will notify the user by mail when the job is completed. (Default to true)"},"notify_email":{"type":"string","description":"The email address to notify when the job is completed."},"notify_type":{"description":"The transport used for notification","enum":["email","inbox","email_and_inbox"],"type":"string"}}},"ManageJobCreateJobSchema":{"type":"object","required":["name","endpoint","method","type","data_source"],"properties":{"name":{"type":"string","description":"Job title (e.g. &quot;Importing users from CSV&quot;)"},"endpoint":{"type":"string","description":"The endpoint of the batch API that will process each chunk of records and return errors &amp; output (e.g. &quot;/manage/v1/user/batch&quot;)"},"method":{"description":"The HTTP method to use when calling the &quot;endpoint&quot;","enum":["GET","POST","PUT","DELETE"],"type":"string"},"chunk_size":{"type":"integer","description":"The maximum size of the chunk that the endpoint accepts. If not provided, it defaults to 100"},"type":{"description":"The type of data source","enum":["importer","api","polling"],"type":"string"},"data_source":{"$ref":"#/definitions/ManageJobCreateJobDataSource","description":"An object containing data source configuration params specific of the data_source type, Check implementation notes."},"notify":{"type":"boolean","description":"Whether the job executor should send a notification to the author when the job is completed state. Default: true"},"hidden":{"type":"boolean","description":"Hides the background job from the list. Default: false"},"notify_email":{"type":"string","description":"Notifications will be sent to this email, if it&#039;s empty they will be sent to the user that created the background job"},"notify_type":{"description":"The transport used for notification. Default: email","enum":["email","inbox","email_and_inbox"],"type":"string"},"include_data_source_in_log_file":{"type":"boolean","description":"If true, in case of errors the source data will be added to logs."}}},"ManageJobCreateJobDataSource":{},"ManageJobCreateJobResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageJobCreateJobData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageJobCreateJobData":{"required":["job_descriptor"],"properties":{"job_descriptor":{"$ref":"#/definitions/ManageJobCreateJobJobDescriptor","description":"Job descriptor record containing information about the newly created job."}}},"ManageJobCreateJobJobDescriptor":{"required":["name","hash","author_id","author_name","date_created","last_update","domain","processed_records","total","errors","log_file","status","notify","notify_email","notify_type"],"properties":{"name":{"type":"string","description":"The Name of the job."},"hash":{"type":"string","description":"The UUID of the job."},"author_id":{"type":"integer","description":"The user ID who created this job."},"author_name":{"type":"string","description":"The name of the user that created this job."},"date_created":{"type":"string","format":"date","description":"The MYSQL UTC datetime of when the job was created."},"last_update":{"type":"string","format":"date","description":"The MYSQL UTC datetime of when the job was last updated."},"domain":{"type":"string","description":"The LMS domain from where the job was posted."},"processed_records":{"type":"integer","description":"The number of processed records by the current job."},"total":{"type":"integer","description":"The total amount of records calculated for this job. If job type is &quot;importer&quot; the value will be empty."},"errors":{"type":"integer","description":"How many errors were raised so far during the process."},"log_file":{"type":"string","description":"The UUID of the job."},"status":{"description":"The current status of the job.","enum":["queued","running","aborted","completed"],"type":"string"},"notify":{"type":"boolean","description":"If set to true, the system will notify the user when the job is completed. (Default to true)"},"hidden":{"type":"boolean","description":"If set to true, the background job will be hidden. Default: false"},"notify_email":{"type":"string","description":"Notifications will be sent to this email, if it&#039;s empty they will be sent to the user that created the background job"},"notify_type":{"description":"The transport used for notification","enum":["email","inbox","email_and_inbox"],"type":"string"},"custom_queue":{"type":"string","description":"Custom queue name"},"custom_worker":{"type":"string","description":"Custom queue name"}}},"ManageJobViewJobsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageJobViewJobsData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageJobViewJobsData":{"required":["jobs"],"properties":{"jobs":{"type":"array","description":"Array of job descriptors.","items":{"$ref":"#/definitions/ManageJobViewJobsJobs"}}}},"ManageJobViewJobsJobs":{"required":["job_descriptor"],"properties":{"job_descriptor":{"$ref":"#/definitions/ManageJobViewJobsJobDescriptor","description":"Job descriptor record containing information about the requested job."}}},"ManageJobViewJobsJobDescriptor":{"required":["name","hash","author_id","author_name","date_created","last_update","download","download_csv_label","download_csv_url","domain","processed_records","total","errors","log_file","status","notify","notify_email","notify_type"],"properties":{"name":{"type":"string","description":"The Name of the job."},"hash":{"type":"string","description":"The UUID of the job."},"author_id":{"type":"integer","description":"The user ID who created this job."},"author_name":{"type":"string","description":"The name of the user that created this job."},"date_created":{"type":"string","format":"date","description":"The MYSQL UTC datetime of when the job was created."},"last_update":{"type":"string","format":"date","description":"The MYSQL UTC datetime of when the job was last updated."},"download":{"$ref":"#/definitions/ManageJobViewJobsDownload","description":""},"download_csv_label":{"type":"string","description":"Download csv label"},"download_csv_url":{"type":"string","description":"Download csv url"},"domain":{"type":"string","description":"The LMS domain from where the job was posted."},"processed_records":{"type":"integer","description":"The number of processed records by the current job."},"total":{"type":"integer","description":"The total amount of records calculated for this job. If job type is &quot;importer&quot; the value will be empty."},"errors":{"type":"integer","description":"How many errors were raised so far during the process."},"log_file":{"type":"string","description":"The UUID of the job."},"status":{"description":"The current status of the job.","enum":["queued","running","aborted","completed"],"type":"string"},"hidden":{"type":"boolean","description":"If set to true, the background jobs is hidden"},"notify":{"type":"boolean","description":"If set to true, the system will notify the user by mail when the job is completed. (Default to true)"},"notify_email":{"type":"string","description":"The email address to notify when the job is completed."},"notify_type":{"description":"The transport used for notification","enum":["email","inbox","email_and_inbox"],"type":"string"}}},"ManageJobViewJobsDownload":{"required":["csv_label","csv_url"],"properties":{"csv_label":{"type":"string","description":"Download csv label"},"csv_url":{"type":"string","description":"Download csv url"}}},"ManageJobViewJobResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageJobViewJobData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageJobViewJobData":{"required":["job_descriptor"],"properties":{"job_descriptor":{"$ref":"#/definitions/ManageJobViewJobJobDescriptor","description":"Job descriptor record containing information about the requested job."}}},"ManageJobViewJobJobDescriptor":{"required":["name","hash","author_id","author_name","date_created","last_update","domain","processed_records","total","errors","log_file","status","notify","notify_email","notify_type"],"properties":{"name":{"type":"string","description":"The Name of the job."},"hash":{"type":"string","description":"The UUID of the job."},"author_id":{"type":"integer","description":"The user ID who created this job."},"author_name":{"type":"string","description":"The name of the user that created this job."},"date_created":{"type":"string","format":"date","description":"The MYSQL UTC datetime of when the job was created."},"last_update":{"type":"string","format":"date","description":"The MYSQL UTC datetime of when the job was last updated."},"domain":{"type":"string","description":"The LMS domain from where the job was posted."},"processed_records":{"type":"integer","description":"The number of processed records by the current job."},"total":{"type":"integer","description":"The total amount of records calculated for this job. If job type is &quot;importer&quot; the value will be empty."},"errors":{"type":"integer","description":"How many errors were raised so far during the process."},"log_file":{"type":"string","description":"The UUID of the job."},"hidden":{"type":"boolean","description":"If set to true, the background job will be hidden. Default: false"},"status":{"description":"The current status of the job.","enum":["queued","running","aborted","completed"],"type":"string"},"notify":{"type":"boolean","description":"If set to true, the system will notify the user by mail when the job is completed. (Default to true)"},"notify_email":{"type":"string","description":"The email address to notify when the job is completed."},"notify_type":{"description":"The transport used for notification","enum":["email","inbox","email_and_inbox"],"type":"string"}}},"ManageJobUpdateJobSchema":{"type":"object","properties":{"notify":{"type":"boolean","description":"Checks whether the job executor should email the author when it transitions into the &quot;completed&quot; state."},"abort":{"type":"boolean","description":"If passed as true, it sets the new status of the job to &quot;aborted&quot; and stops its execution."}}},"ManageJobUpdateJobResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageJobUpdateJobData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageJobUpdateJobData":{"properties":{"success":{"type":"boolean","description":"Whether the operation was successful."}}},"ManageJobDeleteJobResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageJobDeleteJobData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageJobDeleteJobData":{"properties":{"success":{"type":"boolean","description":"Whether the operation was successful."}}},"ManageLegacyenrollmentrulesIndexActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexActionLinks"}}}},"ManageLegacyenrollmentrulesIndexActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"ManageLegacyenrollmentrulesIndexActionItems":{"required":["enrollment_rule_id","title","code","rule_type","notifications","notification_ids","active_status"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The ID of the Enrollment Rules"},"title":{"type":"string","description":"The name of the Enrollment Rules"},"code":{"type":"string","description":"The code of the Enrollment Rules"},"rule_type":{"type":"string","description":"The combination of audience_type_from/enroll_to which define the rule"},"branch_ids":{"type":"array","description":"The list of the branch ids if the rule_type audience_type_from is set to branch","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexActionBranchIds"}},"groups":{"type":"integer","description":"The number of groups"},"group_ids":{"type":"array","description":"The list of the group ids if the rule_type audience_type_from is set to group","items":{"type":"int"}},"courses":{"type":"integer","description":"The number of courses"},"course_ids":{"type":"array","description":"The list of the course ids if the rule_type enroll_to is set to course","items":{"type":"int"}},"plans":{"type":"integer","description":"The number learning plans"},"lp_ids":{"type":"array","description":"The list of the group ids if the rule_type enroll_to is set to lp","items":{"type":"int"}},"notifications":{"type":"integer","description":"The number of notifications"},"notification_ids":{"type":"array","description":"The list of the notification ids. The value is array(string) when release/weekly/paas/notifications and release/weekly/paas/notifications-enable-triggers toggles are ON","items":{"type":"int"}},"active_status":{"type":"boolean","description":"The active status of the Enrollment Rule"},"updated_at":{"type":"string","description":"The time of last update of the Enrollment Rule UTC format yyyy-mm-dd hh:ii:ss or null"}}},"ManageLegacyenrollmentrulesIndexActionBranchIds":{"required":["branch_id","selection_status"],"properties":{"branch_id":{"type":"integer","description":"the id of the branch"},"selection_status":{"type":"integer","description":"the selection level of the branch. 1 means only the branch_id while 2 means the branch_id and all its children."}}},"ManageLegacyenrollmentrulesIndexActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageLegacyenrollmentrulesViewActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesViewActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageLegacyenrollmentrulesViewActionData":{"required":["enrollment_rule_id","title","code","rule_type","notifications","notification_ids","active_status"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The ID of the Enrollment Rules"},"title":{"type":"string","description":"The name of the Enrollment Rules"},"code":{"type":"string","description":"The code of the Enrollment Rules"},"date_begin_validity":{"type":"string","description":"validity start date/time UTC format yyyy-mm-dd hh:ii:ss or null"},"date_expire_validity":{"type":"string","description":"validity expiration date/time UTC format yyyy-mm-dd hh:ii:ss or null"},"rule_type":{"type":"string","description":"The combination of audience_type_from/enroll_to which define the rule"},"branches":{"type":"integer","description":"The number of selected branches"},"branch_ids":{"type":"array","description":"The list of the branch ids if the rule_type audience_type_from is set to branch","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesViewActionBranchIds"}},"groups":{"type":"integer","description":"The number of selected groups"},"group_ids":{"type":"array","description":"The list of the group ids if the rule_type audience_type_from is set to group","items":{"type":"int"}},"courses":{"type":"integer","description":"The number of selected courses"},"course_ids":{"type":"array","description":"The list of the course ids if the rule_type enroll_to is set to course","items":{"type":"int"}},"plans":{"type":"integer","description":"The number of selected learning plans"},"lp_ids":{"type":"array","description":"The list of the group ids if the rule_type enroll_to is set to lp","items":{"type":"int"}},"notifications":{"type":"integer","description":"The number of selected notifications"},"notification_ids":{"type":"array","description":"The list of the notification ids. The value is array(string) when release/weekly/paas/notifications and release/weekly/paas/notifications-enable-triggers toggles are ON","items":{"type":"int"}},"active_status":{"type":"boolean","description":"The active status of the Enrollment Rule"},"updated_at":{"type":"string","description":"The time of last update of the Enrollment Rule UTC format yyyy-mm-dd hh:ii:ss or null"},"assignment_type":{"description":"Enrollment assignment type for the user. This field is returned only when this enrollment attribute is configured in the platform advanced settings. The possible values are: Mandatory,Required, Recommended, Optional.","enum":["string"],"type":"string"}}},"ManageLegacyenrollmentrulesViewActionBranchIds":{"required":["branch_id","selection_status"],"properties":{"branch_id":{"type":"integer","description":"the id of the branch"},"selection_status":{"type":"integer","description":"the selection level of the branch. 1 means only the branch_id while 2 means the branch_id and all its children."}}},"ManageLegacyenrollmentrulesCreateActionSchema":{"type":"object","required":["title","audience_type_from","enroll_to"],"properties":{"title":{"type":"string","description":"the title of the enrollment rule"},"code":{"type":"string","description":"the code of the enrollment rule"},"audience_type_from":{"type":"string","description":"The audience type for the enrollment rule. Accepted values: group, branch"},"enroll_to":{"type":"string","description":"The destination type where user will be enrolled in. Accepted values: course, lp"}}},"ManageLegacyenrollmentrulesCreateActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesCreateActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageLegacyenrollmentrulesCreateActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the newly created enrollment rule"},"success":{"type":"boolean","description":"Success or failure"}}},"ManageLegacyenrollmentrulesUpdateActionSchema":{"type":"object","required":["title","active_status"],"properties":{"title":{"type":"string","description":"the title of the enrollment rule"},"code":{"type":"string","description":"the code of the enrollment rule"},"date_begin_validity":{"type":"string","description":"validity start date/time UTC format yyyy-mm-dd hh:ii:ss or null"},"date_expire_validity":{"type":"string","description":"validity expiration date/time UTC format yyyy-mm-dd hh:ii:ss or null"},"active_status":{"type":"boolean","description":"the active_status to be applied to the Enrollment Rule"},"assignment_type":{"description":"Enrollment assignment type for the user. This field is taken in input only when this enrollment attribute is configured in the platform advanced settings. Accepted values: Mandatory, Required, Recommended, Optional.","enum":["string"],"type":"string"}}},"ManageLegacyenrollmentrulesUpdateActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageLegacyenrollmentrulesUpdateActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageLegacyenrollmentrulesUpdateStatusActionSchema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"the activation status of the enrollment rule"}}},"ManageLegacyenrollmentrulesUpdateStatusActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateStatusActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageLegacyenrollmentrulesUpdateStatusActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageLegacyenrollmentrulesUpdateBranchActionSchema":{"type":"object","required":["branches"],"properties":{"branches":{"type":"array","description":"the branches to be applied to the Enrollment Rule","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateBranchActionBranches"}}}},"ManageLegacyenrollmentrulesUpdateBranchActionBranches":{"required":["branch_id","selection_status"],"properties":{"branch_id":{"type":"integer","description":"the id of the branch"},"selection_status":{"type":"integer","description":"the selection level of the branch. Accepted values: 1, 2. 1 means only the branch_id while 2 means the branch_id and all its children, if any"}}},"ManageLegacyenrollmentrulesUpdateBranchActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateBranchActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageLegacyenrollmentrulesUpdateBranchActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageLegacyenrollmentrulesUpdateCourseActionSchema":{"type":"object","required":["course_ids"],"properties":{"course_ids":{"type":"array","description":"the courses to be applied to the Enrollment Rule","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"Select all resources to associate to the Enrollment Rule. Default: False"},"search_text":{"type":"string","description":"Search resources by text. Default: null"},"incremental_update":{"type":"boolean","description":"The previous association will not be deleted, instead the new elements will be added. Default: False"}}},"ManageLegacyenrollmentrulesUpdateCourseActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateCourseActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageLegacyenrollmentrulesUpdateCourseActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageLegacyenrollmentrulesUpdateGroupActionSchema":{"type":"object","required":["group_ids"],"properties":{"group_ids":{"type":"array","description":"the groups to be applied to the Enrollment Rule","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"Select all resources to associate to the Enrollment Rule. Default: False"},"search_text":{"type":"string","description":"Search resources by text. Default: null"},"incremental_update":{"type":"boolean","description":"The previous association will not be deleted, instead the new elements will be added. Default: False"}}},"ManageLegacyenrollmentrulesUpdateGroupActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateGroupActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageLegacyenrollmentrulesUpdateGroupActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageLegacyenrollmentrulesUpdateLpActionSchema":{"type":"object","required":["learning_plan_ids"],"properties":{"learning_plan_ids":{"type":"array","description":"the learning plans to be applied to the Enrollment Rule","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"Select all resources to associate to the Enrollment Rule. Default: False"},"search_text":{"type":"string","description":"Search resources by text. Default: null"},"incremental_update":{"type":"boolean","description":"The previous association will not be deleted, instead the new elements will be added. Default: False"}}},"ManageLegacyenrollmentrulesUpdateLpActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesUpdateLpActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageLegacyenrollmentrulesUpdateLpActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageLegacyenrollmentrulesDeleteActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesDeleteActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageLegacyenrollmentrulesDeleteActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"id of the rule deleted"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageLegacyenrollmentrulesIndexBranchActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexBranchActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexBranchActionLinks"}}}},"ManageLegacyenrollmentrulesIndexBranchActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexBranchActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"ManageLegacyenrollmentrulesIndexBranchActionItems":{"required":["id","code","title","selection_status","route"],"properties":{"id":{"type":"integer","description":"The ID of the Enrollment Rules"},"code":{"type":"string","description":"The name of the Enrollment Rules"},"title":{"type":"string","description":"The code of the Enrollment Rules"},"selection_status":{"type":"integer","description":"the selection level of the branch. Accepted values: 1, 2. 1 means only the branch_id while 2 means the branch_id and all its children, if any"},"route":{"type":"string","description":"Branch route, from root to branch item"}}},"ManageLegacyenrollmentrulesIndexBranchActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageLegacyenrollmentrulesIndexCourseActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexCourseActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexCourseActionLinks"}}}},"ManageLegacyenrollmentrulesIndexCourseActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexCourseActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"ManageLegacyenrollmentrulesIndexCourseActionItems":{"required":["id","code","title"],"properties":{"id":{"type":"integer","description":"The ID of the Enrollment Rules"},"code":{"type":"string","description":"The name of the Enrollment Rules"},"title":{"type":"string","description":"The code of the Enrollment Rules"}}},"ManageLegacyenrollmentrulesIndexCourseActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageLegacyenrollmentrulesIndexLpActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexLpActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexLpActionLinks"}}}},"ManageLegacyenrollmentrulesIndexLpActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size","sort"],"properties":{"items":{"type":"array","description":"The list of Learning Plans","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexLpActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"An array of applied sorting fields","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexLpActionSort"}}}},"ManageLegacyenrollmentrulesIndexLpActionItems":{"required":["id","code","title"],"properties":{"id":{"type":"string","description":"The ID of the Learning Plan"},"code":{"type":"string","description":"The name of the Learning Plan"},"title":{"type":"string","description":"The code of the Learning Plan"},"type":{"type":"string","description":"The type of the Learning Plan. Can be Learning Plan or Certification. The attribute is returned only when the release/weekly/new-certification-1-private-beta toggle is ON"}}},"ManageLegacyenrollmentrulesIndexLpActionSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"The sorting field name"},"sort_dir":{"type":"string","description":"The sorting direction."}}},"ManageLegacyenrollmentrulesIndexLpActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageLegacyenrollmentrulesIndexGroupActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexGroupActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexGroupActionLinks"}}}},"ManageLegacyenrollmentrulesIndexGroupActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules Group Items","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexGroupActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesIndexGroupActionSort"}}}},"ManageLegacyenrollmentrulesIndexGroupActionItems":{"required":["id","title","description"],"properties":{"id":{"type":"integer","description":"The ID of the Enrollment Rules Group Item"},"title":{"type":"string","description":"The code of the Enrollment Rules Group Item"},"description":{"type":"string","description":"The description of the Enrollment Rules Group Item"}}},"ManageLegacyenrollmentrulesIndexGroupActionSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["title","id","description"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["desc","asc"],"type":"string"}}},"ManageLegacyenrollmentrulesIndexGroupActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageLegacyenrollmentrulesListCourseActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListCourseActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListCourseActionLinks"}}}},"ManageLegacyenrollmentrulesListCourseActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListCourseActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"ManageLegacyenrollmentrulesListCourseActionItems":{"required":["id","code","title"],"properties":{"id":{"type":"integer","description":"The ID of the Enrollment Rules"},"code":{"type":"string","description":"The name of the Enrollment Rules"},"title":{"type":"string","description":"The code of the Enrollment Rules"}}},"ManageLegacyenrollmentrulesListCourseActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageLegacyenrollmentrulesListLpActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListLpActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListLpActionLinks"}}}},"ManageLegacyenrollmentrulesListLpActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Learning Plans","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListLpActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"ManageLegacyenrollmentrulesListLpActionItems":{"required":["id","code","title"],"properties":{"id":{"type":"string","description":"The ID of the Learning Plan"},"code":{"type":"string","description":"The name of the Learning Plan"},"title":{"type":"string","description":"The code of the Learning Plan"},"type":{"type":"string","description":"The type of the Learning Plan. Can be Learning Plan or Certification. The attribute is returned only when the release/weekly/new-certification-1-private-beta toggle is ON"}}},"ManageLegacyenrollmentrulesListLpActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageLegacyenrollmentrulesListGroupActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListGroupActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListGroupActionLinks"}}}},"ManageLegacyenrollmentrulesListGroupActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules Group Items","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListGroupActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListGroupActionSort"}}}},"ManageLegacyenrollmentrulesListGroupActionItems":{"required":["id","title","description"],"properties":{"id":{"type":"integer","description":"The ID of the Enrollment Rules Group Item"},"title":{"type":"string","description":"The code of the Enrollment Rules Group Item"},"description":{"type":"string","description":"The description of the Enrollment Rules Group Item"}}},"ManageLegacyenrollmentrulesListGroupActionSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["title","id","description"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["desc","asc"],"type":"string"}}},"ManageLegacyenrollmentrulesListGroupActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageLegacyenrollmentrulesListNotificationActionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListNotificationActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListNotificationActionLinks"}}}},"ManageLegacyenrollmentrulesListNotificationActionData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of Enrollment Rules Notification Items","items":{"$ref":"#/definitions/ManageLegacyenrollmentrulesListNotificationActionItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"ManageLegacyenrollmentrulesListNotificationActionItems":{"required":["id","title","type","type_translation","recipient","active"],"properties":{"id":{"type":"integer","description":"The ID of the Enrollment Rules Notification Item"},"title":{"type":"string","description":"The code of the Enrollment Rules Notification Item"},"type":{"type":"string","description":"The type of the Notification - Type Code"},"type_translation":{"type":"string","description":"The type of the Notification - Translation"},"recipient":{"type":"string","description":"The recipient of the Notification"},"active":{"type":"boolean","description":"If true, the notification is active, false otherwise"}}},"ManageLegacyenrollmentrulesListNotificationActionLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageLegacyenrollmentrulesDeleteCourseActionSchema":{"type":"object","required":["course_ids"],"properties":{"course_ids":{"type":"array","description":"the courses to be deleted from the Enrollment Rule","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"select all resources filtered by search text (if passed) - Default: false"},"search_text":{"type":"string","description":"search text to filter resources in case of select_all - Default: no value"}}},"ManageLegacyenrollmentrulesDeleteCourseActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesDeleteCourseActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageLegacyenrollmentrulesDeleteCourseActionData":{"required":["enrollment_rule_id","success","delete_count"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"},"delete_count":{"type":"integer","description":"how many items were deleted"}}},"ManageLegacyenrollmentrulesDeleteLpActionSchema":{"type":"object","required":["learning_plan_ids"],"properties":{"learning_plan_ids":{"type":"array","description":"the learning plans to be applied to the Enrollment Rule","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"select all resources filtered by search text (if passed) - Default: false"},"search_text":{"type":"string","description":"search text to filter resources in case of select_all - Default: no value"}}},"ManageLegacyenrollmentrulesDeleteLpActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesDeleteLpActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageLegacyenrollmentrulesDeleteLpActionData":{"required":["enrollment_rule_id","success"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"}}},"ManageLegacyenrollmentrulesDeleteGroupActionSchema":{"type":"object","required":["group_ids"],"properties":{"group_ids":{"type":"array","description":"the groups to be deleted from the Enrollment Rule","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"select all resources filtered by search text (if passed) - Default: false"},"search_text":{"type":"string","description":"search text to filter resources in case of select_all - Default: no value"}}},"ManageLegacyenrollmentrulesDeleteGroupActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesDeleteGroupActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageLegacyenrollmentrulesDeleteGroupActionData":{"required":["enrollment_rule_id","success","delete_count"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"},"delete_count":{"type":"integer","description":"how many items were deleted"}}},"ManageLegacyenrollmentrulesDeleteBranchesActionSchema":{"type":"object","properties":{"branch_ids":{"type":"array","description":"the branchs to be deleted from the Enrollment Rule","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"select all resources filtered by search text (if passed) - Default: false"},"search_text":{"type":"string","description":"search text to filter resources in case of select_all - Default: no value"}}},"ManageLegacyenrollmentrulesDeleteBranchesActionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageLegacyenrollmentrulesDeleteBranchesActionData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageLegacyenrollmentrulesDeleteBranchesActionData":{"required":["enrollment_rule_id","success","delete_count"],"properties":{"enrollment_rule_id":{"type":"integer","description":"The internal ID for the updated enrollment rule"},"success":{"type":"boolean","description":"status of the operation"},"delete_count":{"type":"integer","description":"how many items were deleted"}}},"ManageManagerCreateSchema":{"type":"object","required":["title"],"properties":{"title":{"$ref":"#/definitions/localizable","description":"Manager Type Title"},"description":{"$ref":"#/definitions/localizable","description":"Manager Type Description"},"active":{"type":"integer","description":"If the updated manager should be active 1 = active 0 = inactive. Default - current type value"}}},"ManageManagerCreateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageManagerCreateData","description":"ID of the created record"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageManagerCreateData":{"required":["manager_type_id"],"properties":{"manager_type_id":{"type":"integer","description":"The internal ID for the newly created manager type"}}},"ManageManagerDeleteSchema":{"type":"object","required":["manager_type_ids"],"properties":{"manager_type_ids":{"type":"array","description":"ID of skill/s to be deleted","items":{"type":"integer"}}}},"ManageManagerDeleteResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageManagerDeleteData","description":"Return data for deleted objects and errors during deletion"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageManagerDeleteData":{"required":["deleted"],"properties":{"deleted":{"type":"array","description":"IDs of deleted manager types","items":{"$ref":"#/definitions/ManageManagerDeleteDeleted"}}}},"ManageManagerDeleteDeleted":{"required":["not_deleted"],"properties":{"not_deleted":{"type":"array","description":"IDs of not deleted manager types","items":{"$ref":"#/definitions/ManageManagerDeleteNotDeleted"}}}},"ManageManagerDeleteNotDeleted":{"required":["error_messages"],"properties":{"error_messages":{"type":"array","description":"Error messages during deletion","items":{"$ref":"#/definitions/ManageManagerDeleteErrorMessages"}}}},"ManageManagerDeleteErrorMessages":{},"ManageManagerUpdateSchema":{"type":"object","properties":{"active":{"type":"integer","description":"If the updated manager should be active 1 = active 0 = inactive. Default - current type value"},"title":{"$ref":"#/definitions/localizable","description":"Manager Type Title"},"description":{"$ref":"#/definitions/localizable","description":"Manager Type Description"}}},"ManageManagerUpdateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageManagerUpdateData","description":"ID of updated record"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageManagerUpdateData":{"required":["updated_manager_id"],"properties":{"updated_manager_id":{"type":"integer","description":"Updated record ID"}}},"ManageManagerViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageManagerViewData","description":"Return manager type object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/ManageManagerViewLinks"}}}},"ManageManagerViewData":{"required":["id","title","active"],"properties":{"id":{"type":"integer","description":"Manager Type ID"},"title":{"$ref":"#/definitions/localizable","description":"Manager Type Titles"},"description":{"$ref":"#/definitions/localizable","description":"Manager Type Descriptions"},"active":{"type":"integer","description":"Manager Type status"}}},"ManageManagerViewLinks":{},"ManageManagerListResponse":{"required":["data","version","_links","version","version"],"properties":{"data":{"$ref":"#/definitions/ManageManagerListData","description":"List of all retrieved manager types"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageManagerListLinks"}},"extra_data":{"type":"array","description":"Array with extra data","items":{"$ref":"#/definitions/ManageManagerListExtraData"}}}},"ManageManagerListData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"$ref":"#/definitions/ManageManagerListItems","description":"Array of manager types info objects"},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items returned. Returned if get_total_count parameter is 1"}}},"ManageManagerListItems":{"required":["id","active","title","description","actions","used"],"properties":{"id":{"type":"integer","description":"ID of the manager type"},"active":{"type":"integer","description":"whatever manager type is active or not(&#039;active&#039; -&gt; [1], &#039;inactive&#039; -&gt; [0])"},"title":{"type":"string","description":"Manager type title in the selected language"},"description":{"type":"string","description":"Manager type description in the selected language"},"manager_id":{"type":"integer","description":"User managers id of this type - if user_id is passed"},"manager_names":{"type":"string","description":"User managers names of this type - if user_id is passed"},"manager_username":{"type":"string","description":"Manager&#039;s username- if user_id is passed"},"actions":{"type":"array","description":"Available actions, that could be performed on the manager type","items":{"type":"string"}},"used":{"type":"integer","description":"Whatever the manager type is used[1] or not used[0]"},"subordinates":{"type":"array","description":"List of subordinates, that are assigned to - if user_id is passed","items":{"$ref":"#/definitions/ManageManagerListSubordinates"}}}},"ManageManagerListSubordinates":{"properties":{"id":{"type":"integer","description":"Id of the subordinate user"},"subordinate_names":{"type":"string","description":"Names of the subordinate user"},"subordinate_username":{"type":"string","description":"Username of the subordinate user"}}},"ManageManagerListLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageManagerListExtraData":{},"ManageManagerListSubordinatesL2Response":{"required":["data","version","extra_data","version"],"properties":{"data":{"$ref":"#/definitions/ManageManagerListSubordinatesData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"$ref":"#/definitions/ManageManagerListSubordinatesExtraData","description":"Object containing the statuses and the amount of relations for each one"}}},"ManageManagerListSubordinatesData":{"required":["items"],"properties":{"items":{"type":"array","description":"Manager subordinate relation fields","items":{"$ref":"#/definitions/ManageManagerListSubordinatesItems"}}}},"ManageManagerListSubordinatesItems":{"required":["relation_id","subordinate_id","subordinate_username","subordinate_firstname","subordinate_lastname","subordinate_fullname","subordinate_email","manager_id","manager_username","manager_firstname","manager_lastname","manager_fullname","manager_email","manager_type_id","manager_type_name","manager_type_status","manager_type_last_update"],"properties":{"relation_id":{"type":"integer","description":"Id of the manager subordinate relation record"},"subordinate_id":{"type":"integer","description":"Subordinate id"},"subordinate_username":{"type":"string","description":"Subordinate username"},"subordinate_firstname":{"type":"string","description":"Subordinate firstname"},"subordinate_lastname":{"type":"string","description":"Subordinate lastname"},"subordinate_fullname":{"type":"string","description":"Subordinate fullname"},"subordinate_email":{"type":"string","description":"Subordinate email"},"manager_id":{"type":"integer","description":"Manager id"},"manager_username":{"type":"string","description":"Manager username"},"manager_firstname":{"type":"string","description":"Manager firstname"},"manager_lastname":{"type":"string","description":"Manager lastname"},"manager_fullname":{"type":"string","description":"Manager fullname"},"manager_email":{"type":"string","description":"Manager email"},"manager_type_id":{"type":"integer","description":"Manager type id"},"manager_type_name":{"type":"string","description":"Manager type name"},"manager_type_status":{"type":"string","description":"Approval status Possible values (&#039;confirmed&#039;, &#039;not_confirmed&#039;, &#039;pending&#039;, &#039;imported&#039;)"},"manager_type_last_update":{"type":"string","description":"Datetime of the last subordinate status change"}}},"ManageManagerListSubordinatesExtraData":{"required":["confirmed","not_confirmed","pending","imported","check_team_notification"],"properties":{"confirmed":{"type":"integer","description":"Number of manager subordinate relations that have a status &quot;confirmed&quot;"},"not_confirmed":{"type":"integer","description":"Number of manager subordinate relations that have a status &quot;not_confirmed&quot;"},"pending":{"type":"integer","description":"Number of manager subordinate relations that have a status &quot;pending&quot;"},"imported":{"type":"integer","description":"Number of manager subordinate relations that have a status &quot;imported&quot;"},"check_team_notification":{"type":"boolean","description":"Extra data to see &quot;SEND NOTIFICATION TO MANAGER&quot; in &quot;Manage team request page&quot;"}}},"ManageManagerViewManagerSubordinateResponse":{"required":["data","version","extra_data","version"],"properties":{"data":{"$ref":"#/definitions/ManageManagerViewManagerSubordinateData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"$ref":"#/definitions/ManageManagerViewManagerSubordinateExtraData","description":"API extra data"}}},"ManageManagerViewManagerSubordinateData":{"required":["id","uuid","avatar","username","fullname","firstname","lastname","email","skills"],"properties":{"id":{"type":"integer","description":"Subordinate id"},"uuid":{"type":"string","description":"Subordinate unique id"},"avatar":{"type":"string","description":"Subordinate avatar"},"username":{"type":"string","description":"Subordinate username"},"fullname":{"type":"string","description":"Subordinate fullname"},"firstname":{"type":"string","description":"Subordinate firstname"},"lastname":{"type":"string","description":"Subordinate lastname"},"email":{"type":"string","description":"Subordinate email"},"occupation":{"$ref":"#/definitions/ManageManagerViewManagerSubordinateOccupation","description":"Object containing occupation data"},"skills":{"type":"array","description":"Array of skills","items":{"$ref":"#/definitions/ManageManagerViewManagerSubordinateSkills"}}}},"ManageManagerViewManagerSubordinateOccupation":{"required":["code","name","canonical_code","canonical_name","is_custom"],"properties":{"code":{"type":"string","description":"Occupation code"},"name":{"type":"string","description":"Occupation name"},"canonical_code":{"type":"string","description":"Occupation canonical code"},"canonical_name":{"type":"string","description":"Occupation canonical name"},"is_custom":{"type":"boolean","description":"True if the occupation is custom"}}},"ManageManagerViewManagerSubordinateSkills":{"required":["code","name","expertise"],"properties":{"code":{"type":"string","description":"Code of the skill"},"name":{"type":"string","description":"Name of the skill"},"expertise":{"type":"integer","description":"The level of expertise for the skill. Allowed values are 1,2,3 or 4"},"target_expertise":{"type":"integer","description":"The target level of expertise for the skill. Possible values are 2,3 or 4. This item is visible only if the Skill Gap toggle is active."},"manager_evaluations":{"type":"array","description":"Manager evaluations for the skill","items":{"$ref":"#/definitions/ManageManagerViewManagerSubordinateManagerEvaluations"}}}},"ManageManagerViewManagerSubordinateManagerEvaluations":{"required":["type","created","active"],"properties":{"type":{"type":"string","description":"Type of the evaluation. Possible values (suggest, evaluate, improve)"},"expertise":{"type":"integer","description":"The level of evaluation for the skill, required only when the type is set to &quot;evaluate&quot;. Allowed values are 1,2,3 or 4. If Skill Gap is on, it is used for type:target_level too (expertise needs to be higher than current skill expertise)."},"created":{"type":"string","format":"date","description":"Creation date of record (UTC timezone)"},"active":{"type":"boolean","description":"Status of the evaluation"}}},"ManageManagerViewManagerSubordinateExtraData":{"required":["is_manager"],"properties":{"is_manager":{"type":"boolean","description":"If the logged user is the manager of the provided subordinate"}}},"ManageManagerDeleteSubordinateRelationsBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageManagerDeleteSubordinateRelationsBatchItems"}}}},"ManageManagerDeleteSubordinateRelationsBatchItems":{"required":["relation_id"],"properties":{"relation_id":{"type":"integer","description":"Id of the manager subordinate relation"}}},"ManageManagerDeleteSubordinateRelationsBatchResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageManagerDeleteSubordinateRelationsBatchData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageManagerDeleteSubordinateRelationsBatchData":{"required":["row_index","success","message","output"],"properties":{"row_index":{"type":"integer","description":"Index of the row"},"success":{"type":"boolean","description":"Status of operation"},"message":{"type":"string","description":"Returned additional info for status of operation"},"output":{"type":"array","description":"output","items":{"$ref":"#/definitions/ManageManagerDeleteSubordinateRelationsBatchOutput"}}}},"ManageManagerDeleteSubordinateRelationsBatchOutput":{},"ManageManagerUpdateSubordinateRelationsBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageManagerUpdateSubordinateRelationsBatchItems"}}}},"ManageManagerUpdateSubordinateRelationsBatchItems":{"required":["relation_id","status"],"properties":{"relation_id":{"type":"integer","description":"Id of the manager subordinate relation"},"status":{"description":"Status of the subordinate","enum":["confirmed","not_confirmed","pending","imported"],"type":"string"}}},"ManageManagerUpdateSubordinateRelationsBatchResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageManagerUpdateSubordinateRelationsBatchData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageManagerUpdateSubordinateRelationsBatchData":{"required":["row_index","success","message","output"],"properties":{"row_index":{"type":"integer","description":"Index of the row"},"success":{"type":"boolean","description":"Status of operation"},"message":{"type":"string","description":"Returned additional info for status of operation"},"output":{"type":"array","description":"output","items":{"$ref":"#/definitions/ManageManagerUpdateSubordinateRelationsBatchOutput"}}}},"ManageManagerUpdateSubordinateRelationsBatchOutput":{},"ManageManagerBatchNotifyMangersSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array of objects containing the ID of the manager/subordinate relation","items":{"$ref":"#/definitions/ManageManagerBatchNotifyMangersItems"}}}},"ManageManagerBatchNotifyMangersItems":{"required":["relation_id"],"properties":{"relation_id":{"type":"integer","description":"ID of manager/subordinate relation"}}},"ManageManagerBatchNotifyMangersResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Array containing the result status","items":{"$ref":"#/definitions/ManageManagerBatchNotifyMangersData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageManagerBatchNotifyMangersData":{"required":["row_index","success","message","output"],"properties":{"row_index":{"type":"integer","description":"The index for the record in the incoming array"},"success":{"type":"boolean","description":"Was the operation successful or not?"},"message":{"type":"string","description":"Optional message for the current iteration"},"output":{"type":"array","description":"Optional key value object for output","items":{"$ref":"#/definitions/ManageManagerBatchNotifyMangersOutput"}}}},"ManageManagerBatchNotifyMangersOutput":{},"ManageManagerBatchMailSubordinatesSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageManagerBatchMailSubordinatesItems"}}}},"ManageManagerBatchMailSubordinatesItems":{"required":["to","subject","message"],"properties":{"to":{"type":"integer","description":"User ID"},"subject":{"type":"string","description":"Mail subject"},"message":{"type":"string","description":"Mail body"}}},"ManageManagerBatchMailSubordinatesResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Array containing the result status","items":{"$ref":"#/definitions/ManageManagerBatchMailSubordinatesData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageManagerBatchMailSubordinatesData":{"required":["row_index","success","message","output"],"properties":{"row_index":{"type":"integer","description":"The index for the record in the incoming array"},"success":{"type":"boolean","description":"Was the operation successful or not?"},"message":{"type":"string","description":"Optional message for the current iteration"},"output":{"type":"array","description":"Optional key value object for output","items":{"$ref":"#/definitions/ManageManagerBatchMailSubordinatesOutput"}}}},"ManageManagerBatchMailSubordinatesOutput":{},"ManageManagerCreateSubordinateRelationsBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageManagerCreateSubordinateRelationsBatchItems"}}}},"ManageManagerCreateSubordinateRelationsBatchItems":{"required":["manager","subordinate","manager_type_id","manager_type_status"],"properties":{"manager":{"type":"string","description":"Username, email or id of the manager"},"subordinate":{"type":"string","description":"Username, email or id of the subordinate"},"manager_type_id":{"type":"integer","description":"Manager type id"},"manager_type_status":{"type":"string","description":"Approval status Possible values (&#039;confirmed&#039;,&#039;not_confirmed&#039;,&#039;pending&#039;,&#039;imported&#039;) Only available to power users and Super Admins"}}},"ManageManagerCreateSubordinateRelationsBatchResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageManagerCreateSubordinateRelationsBatchData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageManagerCreateSubordinateRelationsBatchData":{"required":["row_index","success","message","output"],"properties":{"row_index":{"type":"integer","description":"Index of the row"},"success":{"type":"boolean","description":"Status of operation"},"message":{"type":"string","description":"Returned additional info for status of operation"},"output":{"$ref":"#/definitions/ManageManagerCreateSubordinateRelationsBatchOutput","description":"output"}}},"ManageManagerCreateSubordinateRelationsBatchOutput":{"properties":{"relation_id":{"type":"integer","description":"Id of the created or updated record"}}},"ManageManagerSubordinateCandidatesResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageManagerSubordinateCandidatesData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageManagerSubordinateCandidatesData":{"required":["items"],"properties":{"items":{"type":"array","description":"List of subordinate items","items":{"$ref":"#/definitions/ManageManagerSubordinateCandidatesItems"}}}},"ManageManagerSubordinateCandidatesItems":{"required":["subordinate_id","subordinate_avatar","subordinate_username","subordinate_fullname","subordinate_firstname","subordinate_lastname","subordinate_email"],"properties":{"subordinate_id":{"type":"integer","description":"Subordinate id"},"subordinate_avatar":{"type":"string","description":"Subordinate avatar"},"subordinate_username":{"type":"string","description":"Subordinate username"},"subordinate_fullname":{"type":"string","description":"Subordinate fullname"},"subordinate_firstname":{"type":"string","description":"Subordinate firstname"},"subordinate_lastname":{"type":"string","description":"Subordinate lastname"},"subordinate_email":{"type":"string","description":"Subordinate email"}}},"ManageManagerListManagersCandidatesResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageManagerListManagersCandidatesData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageManagerListManagersCandidatesData":{"required":["items"],"properties":{"items":{"type":"array","description":"List of managers items","items":{"$ref":"#/definitions/ManageManagerListManagersCandidatesItems"}}}},"ManageManagerListManagersCandidatesItems":{"required":["manager_id","manager_avatar","manager_username","manager_fullname","manager_firstname","manager_lastname","manager_email"],"properties":{"manager_id":{"type":"integer","description":"Manager id"},"manager_avatar":{"type":"string","description":"Manager avatar URL"},"manager_username":{"type":"string","description":"Manager username"},"manager_fullname":{"type":"string","description":"Manager fullname"},"manager_firstname":{"type":"string","description":"Manager firstname"},"manager_lastname":{"type":"string","description":"Manager lastname"},"manager_email":{"type":"string","description":"Manager email"}}},"ManageManagerListManagerSubordinatesResponse":{"required":["data","version","extra_data","version"],"properties":{"data":{"$ref":"#/definitions/ManageManagerListManagerSubordinatesData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"$ref":"#/definitions/ManageManagerListManagerSubordinatesExtraData","description":""}}},"ManageManagerListManagerSubordinatesData":{"required":["items"],"properties":{"items":{"type":"array","description":"Contains a list assigned subordinates.","items":{"$ref":"#/definitions/ManageManagerListManagerSubordinatesItems"}}}},"ManageManagerListManagerSubordinatesItems":{"required":["subordinate_id","subordinate_avatar","subordinate_username","subordinate_fullname","subordinate_firstname","subordinate_lastname","subordinate_email","subordinate_uuid","manager_types","is_manager","subordinates_count","kpi","actions","is_new","skills_count","skills_suggestion_count"],"properties":{"subordinate_id":{"type":"integer","description":"Subordinate id"},"subordinate_avatar":{"type":"string","description":"Subordinate avatar"},"subordinate_username":{"type":"string","description":"Subordinate username"},"subordinate_fullname":{"type":"string","description":"Subordinate fullname"},"subordinate_firstname":{"type":"string","description":"Subordinate firstname"},"subordinate_lastname":{"type":"string","description":"Subordinate lastname"},"subordinate_email":{"type":"string","description":"Subordinate email"},"subordinate_uuid":{"type":"string","description":"Subordinate uuid"},"manager_types":{"type":"array","description":"List of type relations between the manager and the subordinate","items":{"$ref":"#/definitions/ManageManagerListManagerSubordinatesManagerTypes"}},"is_manager":{"type":"boolean","description":"Is the given subordinate a manager"},"subordinates_count":{"$ref":"#/definitions/ManageManagerListManagerSubordinatesSubordinatesCount","description":""},"kpi":{"$ref":"#/definitions/ManageManagerListManagerSubordinatesKpi","description":"Manager types and number of subordinates for them, that are assigned to this user"},"actions":{"type":"array","description":"List of actions that can be performed against current subordinate, possible values (can_send_email, can_remove_relation, can_enroll_to_course, can_enroll_to_lp)","items":{"type":"string"}},"is_new":{"type":"boolean","description":"If the subordinate was recently assigned"},"skills_count":{"type":"integer","description":"The number of skills assigned to the user"},"skills_suggestion_count":{"type":"integer","description":"The number of active skill suggestions"},"occupation":{"$ref":"#/definitions/ManageManagerListManagerSubordinatesOccupation","description":"The user&#039;s occupation"},"expertise":{"type":"integer","description":"If skill_code is provided, show the expertise of the skill. Allowed values are 1, 2, 3 or 4."},"trend":{"description":"If skill_code is provided, show the expertise trend of the skill, if any. Calculated on the basis of the previous expertise","enum":["up","down","equal"],"type":"string"},"has_dashboard":{"type":"boolean","description":"Whether the subordinate has the skill dashboard"}}},"ManageManagerListManagerSubordinatesManagerTypes":{"required":["relation_id","manager_type_id","manager_type_name","manager_type_status","manager_type_last_update"],"properties":{"relation_id":{"type":"integer","description":"The id of the relation between the manager and the subordinate"},"manager_type_id":{"type":"integer","description":"Manager type id"},"manager_type_name":{"type":"string","description":"Manager type name"},"manager_type_status":{"description":"Approval status Possible values (&#039;confirmed&#039;,&#039;not_confirmed&#039;,&#039;pending&#039;,&#039;imported&#039;)","enum":["confirmed","not_confirmed","pending","imported"],"type":"string"},"manager_type_last_update":{"type":"string","description":"Datetime of the last subordinate status change"}}},"ManageManagerListManagerSubordinatesSubordinatesCount":{"required":["active","pending"],"properties":{"active":{"type":"integer","description":"Number of active users for this subordinate"},"pending":{"type":"integer","description":"Number of pending users for this subordinate"}}},"ManageManagerListManagerSubordinatesKpi":{"required":["status","expired_certification","overdue_course"],"properties":{"status":{"description":"Status based on the expired_certification and overdue_course","enum":["no_data_available","looks_good","take_a_look","heads_up"],"type":"string"},"expired_certification":{"type":"integer","description":"Number of expired certifications for this subordinate. Only returned when the CertificationApp is enabled"},"overdue_course":{"type":"integer","description":"Number of overdue courses for this subordinate"}}},"ManageManagerListManagerSubordinatesOccupation":{"required":["id","code","name","canonical_code","canonical_name","is_custom"],"properties":{"id":{"type":"integer","description":"Occupation id"},"code":{"type":"string","description":"Occupation code"},"name":{"type":"string","description":"Occupation name"},"canonical_code":{"type":"string","description":"Occupation Canonical code"},"canonical_name":{"type":"string","description":"Occupation Canonical name"},"is_custom":{"type":"boolean","description":"True if the Occupation is custom"}}},"ManageManagerListManagerSubordinatesExtraData":{"required":["subordinates_with_expired_certifications","subordinates_with_overdue_course","total_subordinates_count","enrollment_settings"],"properties":{"subordinates_with_expired_certifications":{"type":"integer","description":"Number of subordinates that have an expired certificate. Only returned when the CertificationApp is enabled"},"subordinates_with_overdue_course":{"type":"integer","description":"Number of subordinates that have an overdue course"},"total_subordinates_count":{"$ref":"#/definitions/ManageManagerListManagerSubordinatesTotalSubordinatesCount","description":"Object containing the number of active and pending subordinates"},"enrollment_settings":{"$ref":"#/definitions/ManageManagerListManagerSubordinatesEnrollmentSettings","description":"Information about manager enrollment setting"}}},"ManageManagerListManagerSubordinatesTotalSubordinatesCount":{"required":["active","pending"],"properties":{"active":{"type":"integer","description":"Total number of subordinates that have an active relation"},"pending":{"type":"integer","description":"Total number of subordinates that have pending relation"}}},"ManageManagerListManagerSubordinatesEnrollmentSettings":{"required":["visibility","has_catalogs","has_courses","has_lps","enable_myteam_enrollment_for_managers","enable_enrollment_deadlines_for_managers","enable_user_additional_fields_filter_for_managers"],"properties":{"visibility":{"description":"Visibility settings for the catalogs","enum":["disabled","all","in_visible_catalogs","custom_selection"],"type":"string"},"has_catalogs":{"type":"boolean","description":"Flag if there is at least one catalog"},"has_courses":{"type":"boolean","description":"Flag if there is at least one free course in this catalogs"},"has_lps":{"type":"boolean","description":"Flag if there is at leas one free learning plan in this catalogs"},"enable_myteam_enrollment_for_managers":{"type":"boolean","description":"advancedsetting for enable direct and indirect enrollment"},"enable_enrollment_deadlines_for_managers":{"type":"boolean","description":"advancedsetting for enable enrollment deadlines"},"enable_user_additional_fields_filter_for_managers":{"type":"boolean","description":"advancedsetting for show additional fields to my team filters"}}},"ManageManagerListManagerTypesResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageManagerListManagerTypesData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageManagerListManagerTypesData":{"required":["items"],"properties":{"items":{"type":"array","description":"Contains a list with all manager types","items":{"$ref":"#/definitions/ManageManagerListManagerTypesItems"}}}},"ManageManagerListManagerTypesItems":{"required":["manager_type_id","manager_type_name","manager_type_description","manager_type_active"],"properties":{"manager_type_id":{"type":"integer","description":"Manager type ID"},"manager_type_name":{"type":"string","description":"Manager type name"},"manager_type_description":{"type":"string","description":"Manager type description"},"manager_type_active":{"type":"boolean","description":"Indicate whether or not the manager type is active"}}},"ManageManagerTransfersBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"An array of objects containing the source manager and target manager","items":{"$ref":"#/definitions/ManageManagerTransfersBatchItems"}}}},"ManageManagerTransfersBatchItems":{"required":["source_id","target_id"],"properties":{"source_id":{"type":"integer","description":"ID of the source manager from where subordinates will be taken"},"target_id":{"type":"integer","description":"ID of the target manager where the subordinates will be transferred"}}},"ManageManagerTransfersBatchResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageManagerTransfersBatchData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageManagerTransfersBatchLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageManagerTransfersBatchData":{"required":["row_index","success","message"],"properties":{"row_index":{"type":"integer","description":"Index of the row"},"success":{"type":"boolean","description":"Status of operation"},"message":{"type":"string","description":"Error messages in case when some items could not be processed"}}},"ManageManagerTransfersBatchLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/ManageManagerTransfersBatchSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ManageManagerTransfersBatchGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ManageManagerTransfersBatchFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ManageManagerTransfersBatchLast","description":"Link to the last page"}}},"ManageManagerTransfersBatchSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"ManageManagerTransfersBatchGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"ManageManagerTransfersBatchFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"ManageManagerTransfersBatchLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"ManageManagerListManagerCoursesResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageManagerListManagerCoursesData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageManagerListManagerCoursesLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageManagerListManagerCoursesData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"List of course items","items":{"$ref":"#/definitions/ManageManagerListManagerCoursesItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageManagerListManagerCoursesSort"}}}},"ManageManagerListManagerCoursesItems":{"required":["id","name","description","course_type","code","img_url","language_code","locked","locked_message"],"properties":{"id":{"type":"integer","description":"Course id"},"name":{"type":"string","description":"Course name"},"description":{"type":"string","description":"Course description"},"course_type":{"description":"Course type","enum":["elearning","classroom"],"type":"string"},"code":{"type":"string","description":"Course code"},"img_url":{"type":"string","description":"Link to course image"},"language_code":{"type":"string","description":"Course language code"},"locked":{"type":"boolean","description":"Flag showing if the given &quot;user_id&quot; could be enrolled in the course."},"locked_message":{"type":"string","description":"Message why the course is not accessible"},"suggested":{"type":"boolean","description":"Flag showing if the given course is suggested. Only shown if the &#039;user_id&#039; is valid and if the &#039;show_suggested&#039; is passed as TRUE"}}},"ManageManagerListManagerCoursesSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["id","name","description","code"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"ManageManagerListManagerCoursesLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/ManageManagerListManagerCoursesSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ManageManagerListManagerCoursesGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ManageManagerListManagerCoursesFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ManageManagerListManagerCoursesLast","description":"Link to the last page"}}},"ManageManagerListManagerCoursesSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"ManageManagerListManagerCoursesGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"ManageManagerListManagerCoursesFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"ManageManagerListManagerCoursesLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"ManageManagerListManagerLearningPlansResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageManagerListManagerLearningPlansData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageManagerListManagerLearningPlansLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageManagerListManagerLearningPlansData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"List of learning plan items","items":{"$ref":"#/definitions/ManageManagerListManagerLearningPlansItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageManagerListManagerLearningPlansSort"}}}},"ManageManagerListManagerLearningPlansItems":{"required":["id","code","name","img_url","courses_count","description"],"properties":{"id":{"type":"integer","description":"Learning plan id"},"code":{"type":"string","description":"Learning plan code"},"name":{"type":"string","description":"Learning plan name"},"img_url":{"type":"string","description":"Learning plan name"},"courses_count":{"type":"integer","description":"Total count of courses for the given learning plan"},"description":{"type":"string","description":"Learning plan description"},"locked":{"type":"boolean","description":"Flag showing if the given &quot;user_id&quot; could be enrolled in the learning plan."},"locked_message":{"type":"string","description":"Message why the learning plan is not accessible"},"type":{"type":"integer","description":"Learning plan type: 1 = standard Learning Plan, 2 = Certification. Returned only when the release/weekly/new-certification-1-private-beta toggle is ON."}}},"ManageManagerListManagerLearningPlansSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["id","name","description","code"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"ManageManagerListManagerLearningPlansLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/ManageManagerListManagerLearningPlansSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ManageManagerListManagerLearningPlansGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ManageManagerListManagerLearningPlansFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ManageManagerListManagerLearningPlansLast","description":"Link to the last page"}}},"ManageManagerListManagerLearningPlansSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"ManageManagerListManagerLearningPlansGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"ManageManagerListManagerLearningPlansFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"ManageManagerListManagerLearningPlansLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"ManageManagerCourseEnrollBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array of objects containing user, course and additional enrollment fields","items":{"$ref":"#/definitions/ManageManagerCourseEnrollBatchItems"}},"options":{"$ref":"#/definitions/ManageManagerCourseEnrollBatchOptions","description":"Object containing additional options."},"enroll_only_direct_subordinates":{"type":"boolean","description":"False if we try to enroll indirect subordinates"}}},"ManageManagerCourseEnrollBatchItems":{"required":["user_id","course_id"],"properties":{"user_id":{"type":"integer","description":"ID of user"},"course_id":{"type":"integer","description":"ID of course"},"enrollment_fields":{"type":"array","description":"Array with enrollment fields","items":{"$ref":"#/definitions/ManageManagerCourseEnrollBatchEnrollmentFields"}},"date_begin_validity":{"type":"string","format":"date","description":"Starting date of the enrollment. The date format should be &quot;yyyy-mm-dd HH:mm:ss&quot; or &quot;yyyy-mm-dd&quot;."},"date_expire_validity":{"type":"string","format":"date","description":"Expiration date of the enrollment. The date format should be &quot;yyyy-mm-dd HH:mm:ss&quot; or &quot;yyyy-mm-dd&quot;."}}},"ManageManagerCourseEnrollBatchEnrollmentFields":{"required":["id","value"],"properties":{"id":{"type":"integer","description":"ID of additional enrollment field"},"value":{"type":"string","description":"Value of additional enrollment field"}}},"ManageManagerCourseEnrollBatchOptions":{},"ManageManagerCourseEnrollBatchResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Array containing the result status","items":{"$ref":"#/definitions/ManageManagerCourseEnrollBatchData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageManagerCourseEnrollBatchData":{"required":["row_index","success","message","output"],"properties":{"row_index":{"type":"integer","description":"The index for the record in the incoming array"},"success":{"type":"boolean","description":"Was the operation successful or not?"},"message":{"type":"string","description":"Optional message for the current iteration"},"output":{"type":"array","description":"Optional key value object for output","items":{"$ref":"#/definitions/ManageManagerCourseEnrollBatchOutput"}}}},"ManageManagerCourseEnrollBatchOutput":{},"ManageManagerLearningplanEnrollBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array of objects containing user ID, learning plan ID and additional enrollment fields","items":{"$ref":"#/definitions/ManageManagerLearningplanEnrollBatchItems"}},"options":{"$ref":"#/definitions/ManageManagerLearningplanEnrollBatchOptions","description":"Object containing additional options."},"enroll_only_direct_subordinates":{"type":"boolean","description":"False if we try to enroll indirect subordinates"}}},"ManageManagerLearningplanEnrollBatchItems":{"required":["user_id","learningplan_id"],"properties":{"user_id":{"type":"integer","description":"User ID"},"learningplan_id":{"type":"integer","description":"Learning plan ID"},"enrollment_fields":{"type":"array","description":"Array of objects containing details of enrollment fields","items":{"$ref":"#/definitions/ManageManagerLearningplanEnrollBatchEnrollmentFields"}}}},"ManageManagerLearningplanEnrollBatchEnrollmentFields":{"required":["id","value"],"properties":{"id":{"type":"integer","description":"ID of the additional enrollment field"},"value":{"type":"string","description":"Value of the additional enrollment field"}}},"ManageManagerLearningplanEnrollBatchOptions":{},"ManageManagerLearningplanEnrollBatchResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Array containing the result status","items":{"$ref":"#/definitions/ManageManagerLearningplanEnrollBatchData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageManagerLearningplanEnrollBatchData":{"required":["row_index","success","message","output"],"properties":{"row_index":{"type":"integer","description":"The index for the record in the incoming array"},"success":{"type":"boolean","description":"Was the operation successful or not"},"message":{"type":"string","description":"Optional message for the current iteration"},"output":{"type":"array","description":"Optional key value object for output","items":{"$ref":"#/definitions/ManageManagerLearningplanEnrollBatchOutput"}}}},"ManageManagerLearningplanEnrollBatchOutput":{},"ManageMobileViewSettingsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageMobileViewSettingsData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageMobileViewSettingsData":{"properties":{"enable_custom_settings":{"type":"boolean","description":"Indicates if the custom settings are activated. Used only if multidomain ID is passed as parameter"},"logo_url":{"type":"string","description":"Url of the current logo"},"app_colors":{"$ref":"#/definitions/ManageMobileViewSettingsAppColors","description":"Contains information about the interface colors"},"signin_page_type":{"description":"The background image url to be used for the sign-in page","enum":["color","image"],"type":"string"},"enable_external_tincan":{"type":"boolean","description":"Whether or not the external TinCan providing is enabled"},"external_tincan_play_url":{"type":"string","description":"The URL to be used to play an external TinCan"},"external_tincan_download_url":{"type":"string","description":"The URL to be used to download an external TinCan"},"enable_thirdparty_login":{"type":"boolean","description":"Whether or not the third-party login is available"},"thirdparty_login_url":{"type":"string","description":"The URL through which the third-party login is done"},"last_editor_username":{"type":"string","description":"The name of the last editor. False if no editor"},"last_editor_avatar":{"type":"string","description":"The avatar of the last editor. False if no editor"},"last_editor_initials":{"type":"string","description":"The initials of the last editor. False if no editor"},"last_edit_datetime":{"type":"string","description":"The datetime of the last modification of the settings"},"signin_page_image":{"type":"string","description":"The background image url to be used for the sign-in page. Sent only if the background type is &quot;image&quot;"},"home_page":{"description":"Where should the user be redirected to, after a successful login","enum":["all_channels","my_courses"],"type":"string"},"show_sso":{"type":"boolean","description":"Parameter that decides if the Single sign on button will be visible or not. Always sent even if empty"},"show_redirect_button":{"type":"boolean","description":"Parameter that decides if the redirect button will be visible or not. Always sent even if empty"},"redirect_link":{"type":"string","description":"Redirect link of the SSO. Not sent if empty"},"show_redirect_window":{"type":"boolean","description":"Parameter that decides if the redirect windows on mobile browser will be visible or not. Always sent even if empty"}},"required":["logo_url","app_colors","signin_page_type","enable_external_tincan","external_tincan_play_url","external_tincan_download_url","enable_thirdparty_login","thirdparty_login_url","last_editor_username","last_editor_avatar","last_editor_initials","last_edit_datetime","home_page","show_sso","show_redirect_button"]},"ManageMobileViewSettingsAppColors":{"required":["background_nav","icons_nav","title_nav","selected_tab","title_tab","background_button","text_button","accent","unselected","main_text","secondary_text","border_lines","background"],"properties":{"background_nav":{"type":"string","description":"Top navigation background color"},"icons_nav":{"type":"string","description":"Top navigation icons"},"title_nav":{"type":"string","description":"Top navigation title"},"selected_tab":{"type":"string","description":"Buttons and links text links"},"title_tab":{"type":"string","description":"Text and borders main text"},"background_button":{"type":"string","description":"Buttons and links buttons"},"text_button":{"type":"string","description":"Buttons and links button label"},"accent":{"type":"string","description":"Buttons and links text links"},"unselected":{"type":"string","description":"Buttons and links unselected"},"main_text":{"type":"string","description":"Text and borders main text"},"secondary_text":{"type":"string","description":"Text and borders secondary text"},"border_lines":{"type":"string","description":"Text and borders borders"},"background":{"type":"string","description":"Text and borders main background"}}},"ManageMobileEditSettingsSchema":{"type":"object","properties":{"multidomain_id":{"type":"integer","description":"ID of a multidomain for which to view the setting&#039;s value."},"settings":{"$ref":"#/definitions/ManageMobileEditSettingsSettings","description":"Settings object"}},"required":["settings"]},"ManageMobileEditSettingsSettings":{"properties":{"enable_custom_settings":{"type":"boolean","description":"Indicates if the custom settings are activated. Used only if multidomain ID is passed as parameter"},"logo":{"type":"string","description":"The filename of the logo image to be used, saved on S3 in the Themes collection"},"app_colors":{"$ref":"#/definitions/ManageMobileEditSettingsAppColors","description":"Contains information about the interface colors"},"signin_page_type":{"description":"The type of the background of the sign-in page. If the type is &quot;image&quot; then the &quot;signin_page_image&quot; is to be used as background. If the type is &quot;color&quot; then the &quot;background_nav&quot; color is to be used as background","enum":["color","image"],"type":"string"},"signin_page_image":{"type":"string","description":"The background image url to be used for the sign-in page. Sent only if the background type is &quot;image&quot;"},"enable_external_tincan":{"type":"boolean","description":"Whether or not the external TinCan providing is enabled"},"external_tincan_play_url":{"type":"string","description":"The URL to be used to play an external TinCan"},"external_tincan_download_url":{"type":"string","description":"The URL to be used to download an external TinCan"},"enable_thirdparty_login":{"type":"boolean","description":"Whether or not the third-party login is available"},"thirdparty_login_url":{"type":"string","description":"The URL through which the third-party login is done"},"last_editor":{"type":"string","description":"The ID of the last user to edit those settings. False if the settings have not yet been edited"},"last_edit_datetime":{"type":"string","description":"The datetime of the last modification of the settings"},"home_page":{"description":"Where should the user be redirected to, after a successful login","enum":["all_channels","my_courses"],"type":"string"},"show_sso":{"type":"boolean","description":"Parameter that decides if the Single sign on button will be visible or not. Always sent even if empty"},"show_redirect_button":{"type":"boolean","description":"Parameter that decides if the redirect button will be visible or not. Always sent even if empty"},"redirect_link":{"type":"string","description":"Redirect link of the SSO. Not sent if empty"},"show_redirect_window":{"type":"boolean","description":"Parameter that decides if the redirect windows on mobile browser will be visible or not. Always sent even if empty"}},"required":["home_page","show_sso","show_redirect_button"]},"ManageMobileEditSettingsAppColors":{"required":["background_nav","icons_nav","title_nav","selected_tab","title_tab","background_button","text_button","accent","unselected","main_text","secondary_text","border_lines","background"],"properties":{"background_nav":{"type":"string","description":"Top navigation background color"},"icons_nav":{"type":"string","description":"Top navigation icons"},"title_nav":{"type":"string","description":"Top navigation title"},"selected_tab":{"type":"string","description":"Buttons and links text links"},"title_tab":{"type":"string","description":"Text and borders main text"},"background_button":{"type":"string","description":"Buttons and links buttons"},"text_button":{"type":"string","description":"Buttons and links button label"},"accent":{"type":"string","description":"Buttons and links text links"},"unselected":{"type":"string","description":"Buttons and links unselected"},"main_text":{"type":"string","description":"Text and borders main text"},"secondary_text":{"type":"string","description":"Text and borders secondary text"},"border_lines":{"type":"string","description":"Text and borders borders"},"background":{"type":"string","description":"Text and borders main background"}}},"ManageMobileEditSettingsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageMobileEditSettingsData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageMobileEditSettingsData":{},"ManageMobileBootstrapResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageMobileBootstrapData","description":"Bootstrap information"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/ManageMobileBootstrapLinks"}}}},"ManageMobileBootstrapData":{"required":["is_ip_access_allowed","default_platform_language","platform_version","policy_id","multidomain_id","channel_question_mandatory","branding_elements","settings","sso_providers","in_maintenance_mode","use_https","original_domain","active_languages","active_plugins","active_theme","enabled_feature_toggles"],"properties":{"is_ip_access_allowed":{"type":"boolean","description":"Whether the IP from which, the current request is made, has access to the platform (the IP is in platform&#039;s whitelist or not)"},"default_platform_language":{"type":"string","description":"The default language for the platform"},"platform_version":{"type":"string","description":"The platform version"},"policy_id":{"type":"integer","description":"Id of policy. If it is a 0, no policy is required to be signed for this domain client."},"tc_id":{"type":"integer","description":"Id of a terms and conditions record. If it is a 0, no terms and conditions are required to be agreed with for this domain client."},"multidomain_id":{"type":"integer","description":"ID of the multidomain client detected. False if none is detected."},"channel_question_mandatory":{"type":"boolean","description":"Channel question mandatory setting field"},"branding_elements":{"$ref":"#/definitions/ManageMobileBootstrapBrandingElements","description":"This object contains information about branding options of the mobile version"},"settings":{"$ref":"#/definitions/ManageMobileBootstrapSettings","description":"Different settings of the platform"},"ecommerce_settings":{"$ref":"#/definitions/ManageMobileBootstrapEcommerceSettings","description":"Ecommerce settings"},"catalog_settings":{"$ref":"#/definitions/ManageMobileBootstrapCatalogSettings","description":"Basic catalog settings"},"sso_providers":{"type":"array","description":"It contains the array of SSO providers to display as buttons","items":{"$ref":"#/definitions/ManageMobileBootstrapSsoProviders"}},"in_maintenance_mode":{"type":"boolean","description":"If the LMS is in maintenance mode"},"use_https":{"type":"boolean","description":"Whether or not to force usage of HTTPs"},"original_domain":{"type":"string","description":"The original domain name of the platform"},"active_languages":{"$ref":"#/definitions/ManageMobileBootstrapActiveLanguages","description":"Object with active languages"},"active_plugins":{"$ref":"#/definitions/ManageMobileBootstrapActivePlugins","description":"Object with active plugins"},"active_theme":{"type":"string","description":"The current active theme assigned to requested main domain or multidomain client"},"coach_and_share":{"$ref":"#/definitions/ManageMobileBootstrapCoachAndShare","description":"Information about the Coach&amp;Share plugin. Not present if the plugin is not active"},"enabled_feature_toggles":{"type":"array","description":"An array of mobile feature toggles enabled for the LMS. Empty if no toggles are enabled.","items":{"$ref":"#/definitions/ManageMobileBootstrapEnabledFeatureToggles"}},"community_settings":{"$ref":"#/definitions/ManageMobileBootstrapCommunitySettings","description":"Only show if the community app is enabled, null if no community are configured for the current domain."},"paas":{"$ref":"#/definitions/ManageMobileBootstrapPaas","description":""},"peerboard_base_url":{"type":"string","description":"The peerboard base url used to make API calls."},"docet_configuration":{"type":"array","description":"This array return only when toggle TOGGLE_ENABLE_DOCET_TRACKING is enabled and contains docet configurations","items":{"$ref":"#/definitions/ManageMobileBootstrapDocetConfiguration"}}}},"ManageMobileBootstrapBrandingElements":{"required":["colors","signin","home_page"],"properties":{"colors":{"$ref":"#/definitions/ManageMobileBootstrapColors","description":"Contains information about the interface colors"},"signin":{"$ref":"#/definitions/ManageMobileBootstrapSignin","description":"Contains information about branding options concerned with the sign-in page"},"home_page":{"description":"Where should the user be redirected to, after a successful login","enum":["all_channels","my_courses"],"type":"string"}}},"ManageMobileBootstrapColors":{"required":["background_nav","icons_nav","title_nav","selected_tab","title_tab","background_button","text_button","accent","unselected","main_text","secondary_text","border_lines","background"],"properties":{"background_nav":{"type":"string","description":"Top navigation background color"},"icons_nav":{"type":"string","description":"Top navigation icons"},"title_nav":{"type":"string","description":"Top navigation title"},"selected_tab":{"type":"string","description":"Buttons and links text links"},"title_tab":{"type":"string","description":"Text and borders main text"},"background_button":{"type":"string","description":"Buttons and links buttons"},"text_button":{"type":"string","description":"Buttons and links button label"},"accent":{"type":"string","description":"Buttons and links text links"},"unselected":{"type":"string","description":"Buttons and links unselected"},"main_text":{"type":"string","description":"Text and borders main text"},"secondary_text":{"type":"string","description":"Text and borders secondary text"},"border_lines":{"type":"string","description":"Text and borders borders"},"background":{"type":"string","description":"Text and borders main background"}}},"ManageMobileBootstrapSignin":{"required":["background_type","show_sso","show_redirect_button"],"properties":{"background_type":{"description":"The background image url to be used for the sign-in page","enum":["color","image"],"type":"string"},"background_image":{"type":"string","description":"The background image url to be used for the sign-in page. Always sent even if empty"},"logo":{"type":"string","description":"The logo image url to be used for the sign-in page. Always sent even if empty"},"show_sso":{"type":"boolean","description":"Parameter that decides if the Single sign on button will be visible or not. Always sent even if empty"},"show_redirect_button":{"type":"boolean","description":"Parameter that decides if the redirect button will be visible or not. Always sent even if empty"},"redirect_link":{"type":"string","description":"Redirect link of the SSO. Not sent if empty"}}},"ManageMobileBootstrapSettings":{"required":["registration_settings","erp","request_mandatory_fields_completion","allow_only_password_change","hide_signin_form","enable_external_tincan","remember_me_is_enabled","new_certification_enabled","show_redirect_mobile_dialog","timezone_allow_user_override","currency_settings","elearning"],"properties":{"registration_settings":{"$ref":"#/definitions/ManageMobileBootstrapRegistrationSettings","description":"Settings for the registration functionality"},"erp":{"$ref":"#/definitions/ManageMobileBootstrapErp","description":"This object contains information about erp."},"request_mandatory_fields_completion":{"type":"boolean","description":"Whether or not users need to fill any unfilled user additional fields before being able to use the platform."},"allow_only_password_change":{"type":"boolean","description":"Whether or not users can only change their password of their profile (and nothing else)"},"hide_signin_form":{"type":"boolean","description":"Indicates whether username/password login is to be hidden. Default = false"},"enable_external_tincan":{"type":"boolean","description":"Whether or not the external TinCan providing is enabled"},"remember_me_is_enabled":{"type":"boolean","description":"Whether or not the &quot;Remember me&quot; functionality is on"},"new_certification_enabled":{"type":"boolean","description":"Whether new certifications are enabled"},"show_redirect_mobile_dialog":{"type":"boolean","description":"Whether or not the &quot;Redirect Mobile Dialog Window&quot; functionality is on"},"timezone_allow_user_override":{"type":"boolean","description":"Allow the user to override the Timezone"},"allow_password_change":{"description":"Users settings parameter used by admin, the allow/not allow to change users password, possible value: never, always","enum":["never","always"],"type":"string"},"currency_settings":{"$ref":"#/definitions/ManageMobileBootstrapCurrencySettings","description":""},"elearning":{"$ref":"#/definitions/ManageMobileBootstrapElearning","description":"E-learning Settings"},"ai_configuration":{"$ref":"#/definitions/ManageMobileBootstrapAiConfiguration","description":"Activation status of AI features. Only returned if at least one is active."}}},"ManageMobileBootstrapRegistrationSettings":{"required":["registration_type","options","registration_code_usage","use_email_as_username"],"properties":{"registration_type":{"description":"User registration type (free/moderated/done only by an administrator)","enum":["self","moderate","admin"],"type":"string"},"options":{"$ref":"#/definitions/ManageMobileBootstrapOptions","description":"Registration options"},"registration_code_usage":{"$ref":"#/definitions/ManageMobileBootstrapRegistrationCodeUsage","description":"Registration code usage settings"},"use_email_as_username":{"type":"boolean","description":"Possibility for new users to use an email as username"}}},"ManageMobileBootstrapOptions":{"required":["lastfirst_mandatory","allow_quick_registration","privacy_policy","privacy_policy_link"],"properties":{"lastfirst_mandatory":{"type":"boolean","description":"Require first name and last name during the registration"},"allow_quick_registration":{"type":"boolean","description":"Is quick registration (require only an e-mail in order to register) allowed"},"privacy_policy":{"type":"boolean","description":"Require accept the Privacy policy"},"privacy_policy_link":{"type":"string","description":"Privacy policy link. Empty string if the accepting the privacy policy is not required"},"terms_and_conditions":{"type":"boolean","description":"Is it required, for the user, to agree with the terms and conditions"},"terms_and_conditions_link":{"type":"string","description":"Terms &amp; Conditions link. Empty string if the accepting the terms and conditions is not required"}}},"ManageMobileBootstrapRegistrationCodeUsage":{"required":["registration_code_type","mandatory_code"],"properties":{"registration_code_type":{"description":"Registration code type - none, manually entered branch code, branch code selected from a list, combination of branch and course code entered manually","enum":["0","tree_man","tree_drop","tree_course"],"type":"string"},"mandatory_code":{"type":"boolean","description":"If active and registration code usage is enabled, the users are forced to enter the registration code"}}},"ManageMobileBootstrapErp":{"required":["url","id","installation_type"],"properties":{"url":{"type":"string","description":"erp url."},"id":{"type":"string","description":"erp installation id."},"installation_type":{"type":"string","description":"erp installation id."}}},"ManageMobileBootstrapCurrencySettings":{"required":["stripe_type"],"properties":{"stripe_type":{"type":"string","description":"stripe_type setting, can be simple, advanced or &#039;&#039;, if stripe is not enabled"}}},"ManageMobileBootstrapElearning":{"required":["test_force_multichoice"],"properties":{"test_force_multichoice":{"type":"boolean","description":"If this option is enabled, a multiple choice test question that is only partially correct will be marked as incorrect"}}},"ManageMobileBootstrapAiConfiguration":{"properties":{"neural_search":{"type":"boolean","description":"Whether the Neural Search (Harmony Search) is active. Only returned if the respective toggle is active."},"neural_search_general_knowledge":{"type":"boolean","description":"Whether the general knowledge is enabled in the Neural Search (Harmony Search). Only returned if the Neural Search toggle is active."},"harmony_copilot":{"type":"boolean","description":"Whether Harmony Copilot is active. Only returned if the respective toggle is active."},"neural_search_catalog_inclusion":{"type":"boolean","description":"Whether Catalog inclusion for Neural Search (Harmony Search) is active."}}},"ManageMobileBootstrapEcommerceSettings":{"properties":{"currency_configuration":{"$ref":"#/definitions/ManageMobileBootstrapCurrencyConfiguration","description":"Only when toggle release/weekly/multi-currency is ON"}}},"ManageMobileBootstrapCurrencyConfiguration":{"required":["user_can_change_currency","client_configuration"],"properties":{"user_can_change_currency":{"type":"boolean","description":"Whether users can change their currency (main domain value)"},"client_configuration":{"$ref":"#/definitions/ManageMobileBootstrapClientConfiguration","description":""}}},"ManageMobileBootstrapClientConfiguration":{"required":["user_can_change_currency"],"properties":{"user_can_change_currency":{"type":"boolean","description":"Effective value for the current domain (inherits main domain if no custom ecommerce settings)"}}},"ManageMobileBootstrapCatalogSettings":{"properties":{"catalog_type":{"type":"string","description":"Type of catalog"},"on_catalogue_empty":{"type":"boolean","description":"On catalog empty"},"catalog_external":{"type":"boolean","description":"Show/hide catalogue for authenticated users."},"catalog_use_categories_tree":{"type":"boolean","description":"Should catalog use categories tree"},"show_course_details_dedicated_page":{"type":"boolean","description":"Should it show course details as dedicated page"},"catalog_external_selected_catalogs":{"type":"string","description":"List of catalogues for authenticated users"},"catalog_sorting":{"type":"string","description":"Default sorting for catalogs"}},"required":["catalog_use_categories_tree"]},"ManageMobileBootstrapSsoProviders":{"required":["key","color","title","title_category","title_translated","redirect_url","should_perform_mobile_auto_login"],"properties":{"key":{"type":"string","description":"String identifier of the provider"},"color":{"type":"string","description":"Hex color for the icon and text"},"title":{"type":"string","description":"The translatable key of the button for this sso provider"},"title_category":{"type":"string","description":"The translatable category of the button for this sso provider"},"title_translated":{"type":"string","description":"The translated text of the button for this sso provider"},"redirect_url":{"type":"string","description":"The absolute URL to redirect to when clicking on the button"},"logout_from_idp":{"type":"boolean","description":"The SAML logout setting value"},"should_perform_mobile_auto_login":{"type":"boolean","description":"Indicates whether the Frontend should automatically initiate the login process with the Identity Provider (IDP) instead of displaying the standard login page"}}},"ManageMobileBootstrapActiveLanguages":{"required":["code","description","browsercode","is_rtl"],"properties":{"code":{"type":"string","description":"Language code"},"description":{"type":"string","description":"Language description"},"browsercode":{"type":"string","description":"Language Shortcode - bg, en"},"is_rtl":{"type":"boolean","description":"Is the language Right-To-Left(RTL)."}}},"ManageMobileBootstrapActivePlugins":{"required":["name","settings"],"properties":{"name":{"type":"string","description":"Plugin name"},"settings":{"type":"array","description":"Plugin settings","items":{"$ref":"#/definitions/ManageMobileBootstrapSettingsL2"}}}},"ManageMobileBootstrapSettingsL2":{},"ManageMobileBootstrapCoachAndShare":{"required":["allow_private_assets","set_duration_limits"],"properties":{"allow_private_assets":{"type":"boolean","description":"Indicates if the users are allowed to create private assets"},"set_duration_limits":{"type":"boolean","description":"Indicates if there are limitations for the video duration for assets of type video"},"video_not_shorter_time":{"type":"integer","description":"The minimum duration time for a video asset in seconds. Not present if this limitation has not been set"},"video_not_longer_time":{"type":"integer","description":"The maximum duration time for a video asset in seconds. Not present if this limitation has not been set"}}},"ManageMobileBootstrapEnabledFeatureToggles":{"properties":{"feature_toggle":{"type":"string","description":"the name of an enabled toggle for mobile features."}}},"ManageMobileBootstrapCommunitySettings":{"required":["community_id","is_active","is_published","is_publicly_visible"],"properties":{"community_id":{"type":"string","description":"The id fo the community associated with the current domain."},"is_active":{"type":"boolean","description":"Whether the community is active or not."},"is_published":{"type":"boolean","description":"Whether the community is published or not."},"is_publicly_visible":{"type":"boolean","description":"Whether the community&#039;s content should be accessible by anon viewers."}}},"ManageMobileBootstrapPaas":{"properties":{"notification":{"$ref":"#/definitions/ManageMobileBootstrapNotification","description":""},"sso_be":{"$ref":"#/definitions/ManageMobileBootstrapSsoBe","description":""},"user_be":{"$ref":"#/definitions/ManageMobileBootstrapUserBe","description":""}}},"ManageMobileBootstrapNotification":{"properties":{"userApiUrl":{"type":"string","description":"Base url for paas notification user api"}}},"ManageMobileBootstrapSsoBe":{"properties":{"host":{"type":"string","description":""}}},"ManageMobileBootstrapUserBe":{"properties":{"host":{"type":"string","description":""}}},"ManageMobileBootstrapDocetConfiguration":{"properties":{"api_gateway_url":{"type":"string","description":"The url of aws api gateway"},"get_token_url":{"type":"string","description":"The url of the token url"}}},"ManageMobileBootstrapLinks":{},"ManageMobileDeeplinkSchema":{"type":"object"},"ManageMobileDeeplinkResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageMobileDeeplinkData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageMobileDeeplinkData":{"required":["deep_link"],"properties":{"deep_link":{"type":"string","description":"Deep link"},"duration":{"type":"integer","description":"Time-to-live (TTL) of the token within the deep link, expressed in seconds."}}},"ManageMultidomainIndexResponse":{"required":["data","version","extra_data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageMultidomainIndexData","description":"List of all retrieved data"},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"type":"array","description":"Array with extra data for preselected domains","items":{"$ref":"#/definitions/ManageMultidomainIndexExtraData"}},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageMultidomainIndexLinks"}}}},"ManageMultidomainIndexData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"$ref":"#/definitions/ManageMultidomainIndexItems","description":"Array of multidomain client info objects"},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items returned. Returned if get_total_count parameter is 1"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageMultidomainIndexSort"}}}},"ManageMultidomainIndexItems":{"required":["id","name","logo","domain","domain_type","org_chart","logo_url","domain_url","branch_path"],"properties":{"id":{"type":"integer","description":"ID of the client"},"name":{"type":"string","description":"Name of the client"},"logo":{"type":"string","description":"The asset ID of the logo for the Legacy theme or the filename of the logo file uploaded on S3 for Docebo 7.0 theme"},"domain":{"type":"string","description":"The domain of the client"},"domain_type":{"type":"string","description":"The domain type of the client [&#039;subdomain&#039;/&#039;subfolder&#039;/&#039;customdomain&#039;]"},"org_chart":{"type":"integer","description":"The ID of the org chart node, assigned to the client"},"logo_url":{"type":"string","description":"The url of the client logo"},"domain_url":{"type":"string","description":"The url of the multidomain client"},"branch_path":{"type":"array","description":"The path to the assigned chart node from the root node","items":{"type":"string"}}}},"ManageMultidomainIndexSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageMultidomainIndexExtraData":{},"ManageMultidomainIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageNotificationExternalNotificationSchema":{"type":"object","properties":{"user_id":{"type":"integer","description":"Recipient of the email identified by internal Docebo ID."},"username":{"type":"string","description":"Recipient of the email identified by username."},"uuid":{"type":"string","description":"Recipient of the email identified by UUID."},"course_id":{"type":"integer","description":"ID of a course for this notification."},"session_id":{"type":"integer","description":"ID of a course session (for a Classroom)."},"session_type":{"description":"What type of session is being used.","enum":["classroom"],"type":"string"},"learning_plan_id":{"type":"integer","description":"Identifier of a learning plan."}}},"ManageNotificationExternalNotificationResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageNotificationExternalNotificationData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageNotificationExternalNotificationData":{},"ManageOauth2CreateClientSchema":{"type":"object","required":["app_name","app_description","client_id","redirect_uri","grant_type"],"properties":{"app_name":{"type":"string","description":"The name of the new client"},"app_description":{"type":"string","description":"The description of the new client"},"client_id":{"type":"string","description":"The client id of the new client"},"redirect_uri":{"type":"string","description":"The URL where to redirect the client after the login"},"grant_type":{"type":"array","description":"One or more grant types. Possible values are: &quot;authorization_code_implicit_grant&quot;, &quot;resource_owner_password_credentials&quot;, &quot;client_credentials&quot;, &quot;jwt_bearer&quot;","items":{"type":"string"}},"enabled":{"type":"boolean","description":"Set to true for the client to be enabled. Default value is true."},"public_key":{"type":"string","description":"The public key to associate to the client for JWT grant type. The parameter is ignored when the grant type is not jwt_bearer"}}},"ManageOauth2CreateClientResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageOauth2CreateClientData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageOauth2CreateClientData":{"required":["success","secret"],"properties":{"success":{"type":"boolean","description":"true if the request has been successful"},"secret":{"type":"string","description":"The secret of the newly created OAuth2 client"}}},"ManageOauth2DeleteClientResponse":{"required":["success","version"],"properties":{"success":{"type":"boolean","description":"The operation success status"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageOauth2ListClientsResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageOauth2ListClientsData","description":"List of all retrieved groups"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageOauth2ListClientsLinks"}}}},"ManageOauth2ListClientsData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"$ref":"#/definitions/ManageOauth2ListClientsItems","description":"Array of OAuth2 client items"},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageOauth2ListClientsSort"}}}},"ManageOauth2ListClientsItems":{"properties":{"client_id":{"type":"integer","description":"The ID of the OAuth2 client"},"app_name":{"type":"string","description":"Name of the client"},"app_description":{"type":"string","description":"Description of the client"},"redirect_uri":{"type":"string","description":"The redirect URI for the associated OAuth2 client"},"grant_type":{"type":"array","description":"Array of grant types associated to the OAuth2 client","items":{"type":"string"}},"enabled":{"type":"boolean","description":"Flag set to true if the OAuth2 client is enabled or not"},"public_key":{"type":"string","description":"Optional public_key associated to the client in case a JWT grant type is selected"}},"required":["redirect_uri","grant_type","enabled"]},"ManageOauth2ListClientsSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageOauth2ListClientsLinks":{"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageOauth2UpdateClientSchema":{"type":"object","required":["app_name","app_description","redirect_uri","grant_type"],"properties":{"app_name":{"type":"string","description":"The name of the new client"},"app_description":{"type":"string","description":"The description of the new client"},"redirect_uri":{"type":"string","description":"The URL where to redirect the client after the login"},"grant_type":{"type":"array","description":"One or more grant types. Possible values are: &quot;authorization_code_implicit_grant&quot;, &quot;resource_owner_password_credentials&quot;, &quot;client_credentials&quot;, &quot;jwt_bearer&quot;","items":{"type":"string"}},"enabled":{"type":"boolean","description":"Set to true for the client to be enabled. Default value is true"},"public_key":{"type":"string","description":"The public key to associate to the client for JWT grant type. The parameter is ignored when the grant type is not jwt_bearer"}}},"ManageOauth2UpdateClientResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageOauth2UpdateClientData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageOauth2UpdateClientData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"true if the request has been successful"}}},"ManageObjectivesUpdateProfileSchema":{"type":"object","properties":{"occupation":{"$ref":"#/definitions/ManageObjectivesUpdateProfileOccupation","description":"Object containing occupation data"},"areas_of_improvement":{"type":"array","description":"List of areas of improvement object. It can be empty.","items":{"$ref":"#/definitions/ManageObjectivesUpdateProfileAreasOfImprovement"}}},"required":["areas_of_improvement"]},"ManageObjectivesUpdateProfileOccupation":{"required":["code","name","canonical_code","canonical_name","is_custom"],"properties":{"code":{"type":"string","description":"Occupation code"},"name":{"type":"string","description":"Occupation name"},"canonical_code":{"type":"string","description":"Occupation canonical code"},"canonical_name":{"type":"string","description":"Occupation canonical name"},"is_custom":{"type":"boolean","description":"True if the occupation is custom"}}},"ManageObjectivesUpdateProfileAreasOfImprovement":{"properties":{"code":{"type":"string","description":"The code of the area of improvement. Is optional when is_custom attribute is true"},"name":{"type":"string","description":"The name of the area of improvement"},"is_custom":{"type":"boolean","description":"True if the area of improvement is custom"},"is_suggested":{"type":"boolean","description":"True if the area of improvement is suggested by AI"},"expertise":{"type":"integer","description":"The level of expertise for the area of improvement. Allowed values are 1,2,3 or 4"},"target_expertise":{"type":"integer","description":"The target level of expertise for the area of improvement. Allowed values are 2,3 or 4. This parameter is accepted only if the Skill Gap toggle is active."}},"required":["name","is_custom","is_suggested","expertise"]},"ManageObjectivesUpdateProfileResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageObjectivesUpdateProfileData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageObjectivesUpdateProfileData":{"required":["success","occupation","areas_of_improvement"],"properties":{"success":{"type":"boolean","description":"true if the request has been successful"},"occupation":{"$ref":"#/definitions/ManageObjectivesUpdateProfileOccupationL2","description":"Represent the newly created occupation object"},"areas_of_improvement":{"type":"array","description":"List of created areas of improvement","items":{"$ref":"#/definitions/ManageObjectivesUpdateProfileAreasOfImprovementL2"}}}},"ManageObjectivesUpdateProfileOccupationL2":{"required":["id","code","name","canonical_code","canonical_name","is_custom"],"properties":{"id":{"type":"integer","description":"Occupation id"},"code":{"type":"string","description":"Occupation code"},"name":{"type":"string","description":"Occupation name"},"canonical_code":{"type":"string","description":"Occupation Canonical code"},"canonical_name":{"type":"string","description":"Occupation Canonical name"},"is_custom":{"type":"boolean","description":"True if the Occupation is custom"}}},"ManageObjectivesUpdateProfileAreasOfImprovementL2":{"required":["code","name","description","is_custom","is_suggested","expertise"],"properties":{"code":{"type":"string","description":"The code of the area of improvement"},"name":{"type":"string","description":"The name of the area of improvement"},"description":{"type":"string","description":"The description of the area of improvement"},"is_custom":{"type":"boolean","description":"True if the area of improvement is custom"},"is_suggested":{"type":"boolean","description":"True if the area of improvement is suggested by AI"},"expertise":{"type":"integer","description":"The level of expertise for the area of improvement. Allowed values are 1,2,3 or 4"},"target_expertise":{"type":"integer","description":"The target level of expertise for the area of improvement. Allowed values are 2,3 or 4. This item is visible only if the Skill Gap toggle is active."}}},"ManageOpengraphListResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageOpengraphListData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageOpengraphListData":{"required":["ogTags"],"properties":{"ogTags":{"type":"array","description":"The list of Open Graph tags found","items":{"type":"string"}}}},"ManageOrgchartCreateSchema":{"type":"object","properties":{"code":{"type":"string","description":"The code of the branch"},"id_parent":{"type":"integer","description":"The parent branch ID under which to put the new created branch. By default the parent branch is the root branch"},"use_secondary_identifier":{"type":"boolean","description":"Set to true to specify that id_parent is referencing to a branch code rather than an ID. Default value: false"},"translations":{"$ref":"#/definitions/ManageOrgchartCreateTranslations","description":"The translated names of the node."}},"required":["translations"]},"ManageOrgchartCreateTranslations":{"required":["en"],"properties":{"en":{"type":"string","description":"A list of translations of the branch name. The key of the array represents the language code and the value is the translated name (ex. &#039;en&#039;: &#039;Branch name&#039;, &#039;it&#039;: &#039;Nome del branch&#039;). You can use &#039;all&#039; as key to represents all languages (ex. &#039;all&#039;: &#039;Branch name&#039;)"}}},"ManageOrgchartCreateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageOrgchartCreateData","description":"Response data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageOrgchartCreateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageOrgchartCreateData":{"required":["branch_id"],"properties":{"branch_id":{"type":"integer","description":"The idOrg of the newly created node"}}},"ManageOrgchartCreateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/ManageOrgchartCreateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ManageOrgchartCreateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ManageOrgchartCreateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ManageOrgchartCreateLast","description":"Link to the last page"}}},"ManageOrgchartCreateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"ManageOrgchartCreateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"ManageOrgchartCreateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"ManageOrgchartCreateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"ManageOrgchartDeleteSchema":{"type":"object","properties":{"use_secondary_identifier":{"type":"boolean","description":"Interpret id param as secondary identifier (i.e. alphanumeric branch code), default is false"}}},"ManageOrgchartDeleteResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageOrgchartDeleteData","description":"Deleted Branch data"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageOrgchartDeleteData":{"required":["deleted_branch_id"],"properties":{"deleted_branch_id":{"type":"integer","description":"the deleted branch id"}}},"ManageOrgchartIndexResponse":{"required":["data","version","version","version","extra_data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageOrgchartIndexData","description":"Array of branches that are direct descendants of the branch"},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"$ref":"#/definitions/ManageOrgchartIndexExtraData","description":"the root node"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageOrgchartIndexLinks"}}}},"ManageOrgchartIndexData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of subscription records info objects","items":{"$ref":"#/definitions/ManageOrgchartIndexItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters - can be empty"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageOrgchartIndexSort"}}}},"ManageOrgchartIndexItems":{"required":["id","code","title","lev","iLeft","iRight","selection_status","selectable","actions","has_children","can_manage","icon","color","tooltip","parent_id","parent_code","can_manage_all_children"],"properties":{"id":{"type":"integer","description":"ID of the branch"},"code":{"type":"string","description":"Code of the branch"},"title":{"type":"string","description":"Title of the branch"},"lev":{"type":"integer","description":"Selected level of the branch"},"iLeft":{"type":"integer","description":"Scope from the left border of the branch"},"iRight":{"type":"integer","description":"Scope to the right border of the branch"},"selection_status":{"type":"integer","description":"Subscription Plan ID"},"selectable":{"type":"integer","description":"If Superadmin is logged-in - always = 1. If Power User is logged-in - 1 - if the user is an admin of the branch; 0 - if the user is not an admin of the branch, but is an admin of some child/children of the branch."},"actions":{"type":"array","description":"old parameter originally used by frontend to determine actions available for the branch, currently unused and returned as an empty array","items":{"type":"string"}},"has_children":{"type":"boolean","description":"True if the branch has child branches, false otherwise (false is default)"},"can_manage":{"type":"boolean","description":"Flag used to determine whether the caller can manage the current branch"},"icon":{"type":"string","description":"Parameter used by the frontend to determine which icon is used, currently forced to the default &#039;folder-outline&#039;"},"color":{"type":"string","description":"Old parameter (not used anymore) to determine branch background color in the frontend, default is empty string"},"tooltip":{"type":"string","description":"old parameter (not used anymore) to populate the tooltip of the branch, default is empty string"},"parent_id":{"type":"integer","description":"The id of the parent branch"},"parent_code":{"type":"string","description":"The code of the parent branch, or an empty string if parent branch has no code"},"can_manage_all_children":{"type":"boolean","description":"True if current branch or any ancestor of it is assigned to SPU with descendants, false otherwise and false if branch has not any child. Always true for SA"},"path_ids":{"type":"string","description":"the path ids of the branch hierarchy. This is valorized only if include_path parameter is set to true"}}},"ManageOrgchartIndexSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageOrgchartIndexExtraData":{"required":["id","code","title","id_parent","title_parent","lev","iLeft","iRight","is_root","root_node_id"],"properties":{"id":{"type":"integer","description":"The id of the parent branch"},"code":{"type":"string","description":"Code of the branch - can be empty"},"title":{"type":"string","description":"The title of the branch"},"id_parent":{"type":"integer","description":"The id of the parent branch. If branch is already top level, 0"},"title_parent":{"type":"string","description":"The title of the parent branch. If branch is already top level, same as &#039;title&#039;"},"lev":{"type":"integer","description":"level of the current branch, 1 if top level"},"iLeft":{"type":"integer","description":"Scope from the left border of the branch"},"iRight":{"type":"integer","description":"Scope from the right border of the branch"},"is_root":{"type":"boolean","description":"True if the selected branch is the root node, false otherwise (false is default)"},"root_node_id":{"type":"integer","description":"Id of the root node"},"can_manage":{"type":"boolean","description":"True for SA. True for PU or SPU if the root branch is assigned to them. False otherwise."},"path_ids":{"type":"string","description":"the path ids of the branch hierarchy. This is valorized only if include_path parameter is set to true"}}},"ManageOrgchartIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageOrgchartUpdateSchema":{"type":"object","properties":{"use_secondary_identifier":{"type":"boolean","description":"Interpret branch_id param as secondary identifier (i.e. alphanumeric branch code). Default is false"},"code":{"type":"string","description":"Codename of the branch"},"translations":{"$ref":"#/definitions/ManageOrgchartUpdateTranslations","description":"The translated names of the node."}},"required":["translations"]},"ManageOrgchartUpdateTranslations":{"required":["en"],"properties":{"en":{"type":"string","description":"A list of translations of the branch name. The key of the array represents the language code and the value is the translated name (ex. &#039;en&#039;: &#039;Branch name&#039;, &#039;it&#039;: &#039;Nome del branch&#039;)"}}},"ManageOrgchartUpdateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageOrgchartUpdateData","description":"ID of updated record"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageOrgchartUpdateData":{"required":["branch_id"],"properties":{"branch_id":{"type":"integer","description":"The idOrg of the updated branch"}}},"ManageOrgchartViewResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageOrgchartViewData","description":"Branch data"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageOrgchartViewData":{"required":["idOrg","path","lev","iLeft","iRight","code","idst_oc","idst_ocd","translations"],"properties":{"idOrg":{"type":"integer","description":"The idOrg of the newly created node"},"idParent":{"type":"integer","description":"idOrg of the parent node."},"path":{"type":"string","description":"path of the org chart node (default is an empty string). This is valorized only if include_path parameter is set to true"},"path_ids":{"type":"string","description":"the path ids of the branch hierarchy. This is valorized only if include_path parameter is set to true"},"lev":{"type":"integer","description":"the level of the node in the org chart tree"},"iLeft":{"type":"integer","description":"id for the branch node used as the left index of the nested set for the orgchart tree"},"iRight":{"type":"integer","description":"id for the branch node used as the right index of the nested set for the orgchart tree"},"code":{"type":"string","description":"Code for the branch"},"idst_oc":{"type":"integer","description":"id of the organization chart hidden group used as the left index of the nested set for the orgchart tree"},"idst_ocd":{"type":"integer","description":"id of the organization chart hidden group used as the right index of the nested set for the orgchart tree"},"translations":{"$ref":"#/definitions/ManageOrgchartViewTranslations","description":"Translations for the branch name: key is language code, value is translated name"}}},"ManageOrgchartViewTranslations":{"required":["associated_policy","associated_template"],"properties":{"associated_policy":{"type":"integer","description":"Old deprecated field, default is null"},"associated_template":{"type":"string","description":"Old deprecated field, default is null"}}},"ManageOrgchartGetUsersInBranchResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageOrgchartGetUsersInBranchData","description":"Response success or failure to find users"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageOrgchartGetUsersInBranchLinks"}}}},"ManageOrgchartGetUsersInBranchData":{"properties":{"items":{"type":"array","description":"List of Users","items":{"$ref":"#/definitions/ManageOrgchartGetUsersInBranchItems"}}}},"ManageOrgchartGetUsersInBranchItems":{"required":["user_id","username","firs_name","last_name","email"],"properties":{"user_id":{"type":"integer","description":"The ID of the user"},"username":{"type":"string","description":"Username of the user"},"firs_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email of the user"}}},"ManageOrgchartGetUsersInBranchLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageOrgchartAssignUsersSchema":{"type":"object","required":["id_org","id_users"],"properties":{"id_org":{"type":"integer","description":"node id"},"id_users":{"type":"string","description":"comma separated list of user ids"},"use_secondary_identifier":{"type":"boolean","description":"Set to true to specify a branch code instead that its id for &quot;id_org&quot; parameter. Default is false."},"skip_if_in_subtree":{"type":"boolean","description":"When true, users that are already members of the target branch or any of its descendants are skipped (not added/moved). Their ids are returned in the &quot;skipped_users&quot; response field. Default is false. Used by the SAML SSO microservice to preserve existing sub-branch assignments when no branch claim is provided."}}},"ManageOrgchartAssignUsersResponse":{"required":["success","errors","users_not_exist","already_assigned_users","skipped_users"],"properties":{"success":{"type":"array","description":"Array of user ids successfully assigned","items":{"type":"integer"}},"errors":{"type":"array","description":"Array of user ids fail to assign","items":{"type":"integer"}},"users_not_exist":{"type":"array","description":"Array of user ids who not exist","items":{"type":"integer"}},"already_assigned_users":{"type":"array","description":"Array of user ids who already assigned","items":{"type":"integer"}},"skipped_users":{"type":"array","description":"Array of user ids skipped because they were already members of the target branch subtree (only populated when &quot;skip_if_in_subtree&quot; is true)","items":{"type":"integer"}}}},"ManageOrgchartMoveSchema":{"type":"object","required":["id_new_parent","version"],"properties":{"id_new_parent":{"type":"integer","description":"idOrtg of the parent node under which to put the node."},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageOrgchartMoveResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageOrgchartMoveData","description":"Response result"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageOrgchartMoveData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"The status of the request"}}},"ManageOrgchartAssignFieldSchema":{"type":"object","required":["user_fields","all"],"properties":{"user_fields":{"type":"array","description":"Array with field Ids","items":{"type":"integer"}},"all":{"type":"boolean","description":"Whether all the user fields are selected. Default value: false"}}},"ManageOrgchartAssignFieldResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageOrgchartAssignFieldData","description":"Results of the assign process"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageOrgchartAssignFieldData":{"required":["user_fields","errors"],"properties":{"user_fields":{"type":"integer","description":"List with all user fields for provided branch/group"},"errors":{"type":"array","description":"Errors during process","items":{"$ref":"#/definitions/ManageOrgchartAssignFieldErrors"}}}},"ManageOrgchartAssignFieldErrors":{"required":["id","error"],"properties":{"id":{"type":"integer","description":"The ID of the user field requested to process that generated an error"},"error":{"type":"string","description":"Details of the error, e.g. user field does not exist..."}}},"ManageOrgchartBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array of branch objects to be imported.","items":{"$ref":"#/definitions/ManageOrgchartBatchItems"}},"options":{"$ref":"#/definitions/ManageOrgchartBatchOptions","description":"Batch import options."}}},"ManageOrgchartBatchItems":{"required":["code","translations"],"properties":{"code":{"type":"string","description":"Branch code."},"translations":{"$ref":"#/definitions/ManageOrgchartBatchTranslations","description":"Localizable branch name. Such object is structured as {&quot;language_code&quot;: &quot;branch name in this language&quot;}, where &quot;language_code&quot; is a valid language code (e.g. english, italian) or the &quot;all&quot; selector (i.e. same name for all languages). You can mix real language codes with &quot;all&quot; to override specific languages (e.g. {&quot;all&quot;: &quot;Common Name&quot;, &quot;italian&quot;: &quot;Nome italiano&quot;})."},"sibling":{"type":"string","description":"An optional branch code to keep synched with the current branch (only applicable if branch synchronization is available)."},"parent_code":{"type":"string","description":"The code of the parent branch. If empty, it will be created under the root branch."}}},"ManageOrgchartBatchTranslations":{"required":["language_code"],"properties":{"language_code":{"type":"string","description":"The key is code of the language or all - the value is title. For example english, all"}}},"ManageOrgchartBatchOptions":{"properties":{"update":{"type":"boolean","description":"When set to TRUE, it will update an already existing branch instead of skipping it. Default value is FALSE (i.e. skip already existing branches)."}}},"ManageOrgchartBatchResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Result of action (insert/update) of every single row of provided data","items":{"$ref":"#/definitions/ManageOrgchartBatchData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageOrgchartBatchData":{"required":["row_index","success","message"],"properties":{"row_index":{"type":"integer","description":"Index of the row"},"success":{"type":"boolean","description":"Status of operation"},"message":{"type":"string","description":"Returned additional info for status of operation"}}},"ManageOrgchartBatchRemoveUsersSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Associative array containing key/value pairs to be unassigned","items":{"$ref":"#/definitions/ManageOrgchartBatchRemoveUsersItems"}}}},"ManageOrgchartBatchRemoveUsersItems":{"required":["id_user"],"properties":{"id_user":{"type":"integer","description":"The numeric id for an existing user"},"id_branch":{"type":"integer","description":"The numeric id for an existing branch. Required only if the branch_code is not specified."},"branch_code":{"type":"string","description":"The alphanumeric identifier for an existing branch. Required only if the id_branch is not specified."}}},"ManageOrgchartBatchRemoveUsersResponse":{"required":["response","version"],"properties":{"response":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/ManageOrgchartBatchRemoveUsersResponseL2"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageOrgchartBatchRemoveUsersResponseL2":{"required":["row_index","message","success"],"properties":{"row_index":{"type":"integer","description":"ID for the current record"},"message":{"type":"string","description":"Optional error message: 1001 - Invalid parameter: user_id, 1002 - Parameters id_branch and branch_code cannot be used at the same time, 1003 - Missing required parameters: id_branch or branch_code, 1004 - Invalid parameter - id_branch | branch_code, 1005 - Branch does not have user assigned to it, 1006 - Error while trying to remove user from branch"},"success":{"type":"boolean","description":"True if the record has been imported, false otherwise"},"output":{"$ref":"#/definitions/ManageOrgchartBatchRemoveUsersOutput","description":"An output object, empty if not used in current api"}}},"ManageOrgchartBatchRemoveUsersOutput":{},"ManageOrgchartBatchDeleteBranchesSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array of branch objects to be deleted.","items":{"$ref":"#/definitions/ManageOrgchartBatchDeleteBranchesItems"}}}},"ManageOrgchartBatchDeleteBranchesItems":{"required":["id"],"properties":{"id":{"type":"integer","description":"Branch id"}}},"ManageOrgchartBatchDeleteBranchesResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Result of action (delete) of every single row of provided data","items":{"$ref":"#/definitions/ManageOrgchartBatchDeleteBranchesData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageOrgchartBatchDeleteBranchesData":{"required":["row_index","success","message"],"properties":{"row_index":{"type":"integer","description":"Index of the row"},"success":{"type":"boolean","description":"Status of operation"},"message":{"type":"string","description":"Additional info for status of operation"}}},"ManageOrgchartDropdownOptionsData":{},"ManageOrgchartDropdownOptionsResponse":{"properties":{"data":{"$ref":"#/definitions/ManageOrgchartDropdownOptionsData","description":"Branch codes associated with their translations"},"version":{"type":"string","required":"required","description":"Current API version"}},"required":["version"]},"ManageOrgchartImporterFieldsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageOrgchartImporterFieldsData","description":"Response success or failure to find users"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageOrgchartImporterFieldsData":{"properties":{"fields":{"type":"array","description":"Associative array containing column names and translations","items":{"$ref":"#/definitions/ManageOrgchartImporterFieldsFields"}}}},"ManageOrgchartImporterFieldsFields":{},"ManagePlayerGetLicenseResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManagePlayerGetLicenseData","description":"Results of the process"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManagePlayerGetLicenseData":{"required":["key"],"properties":{"key":{"type":"string","description":"License key"}}},"ManagePolicyCreateSchema":{"type":"object","required":["policy"],"properties":{"policy":{"$ref":"#/definitions/ManagePolicyCreatePolicy","description":"The Policy data, e.g. &quot;policy&quot;: { &quot;policy_name&quot;: {&quot;en&quot;: &quot;Policy en name&quot;,&quot;bg&quot;: &quot;Policy bg name&quot;}, &quot;policy_acceptance_message&quot;: {&quot;en&quot;: &quot;en acceptance message&quot;},&quot;policy_body&quot;: {&quot;en&quot;: &quot;en body&quot;} }"},"sub_policy":{"type":"array","description":"The Sub-Policy data, e.g. &quot;sub_policy&quot;: [ {&quot;sub_policy_acceptance_message&quot;: {&quot;all&quot;: &quot;sub_policy 1 all&quot;}, &quot;mandatory&quot;:1}, {&quot;sub_policy_acceptance_message&quot;: {&quot;en&quot;: &quot;sub_policy 2 en&quot;, &quot;bg&quot;: &quot;sub_pol 2 bg&quot;}&quot;mandatory&quot;:0}, {&quot;sub_policy_acceptance_message&quot;: {&quot;en&quot;: &quot;sub_policy 3 en&quot;}} ]","items":{"$ref":"#/definitions/ManagePolicyCreateSubPolicy"}}}},"ManagePolicyCreatePolicy":{"required":["policy_name","policy_acceptance_message","policy_body","enable_sub_policies"],"properties":{"policy_name":{"$ref":"#/definitions/localizable","description":"Policy name  e.g. policy_name: {&quot;en&quot;: &quot;English Policy name&quot;}. Required only in the default language."},"policy_header":{"$ref":"#/definitions/localizable","description":"Policy header  e.g. - policy_header: {&quot;en&quot;: &quot;English Policy header&quot;}."},"policy_acceptance_message":{"$ref":"#/definitions/localizable","description":"e.g. - policy_acceptance_message: {&quot;en&quot;: &quot;English Policy acceptance message&quot;}. Required only in the default language."},"policy_body":{"$ref":"#/definitions/localizable","description":"e.g. - policy_body: {&quot;en&quot;: &quot;English Policy body&quot;}. Required only in the default language."},"enable_sub_policies":{"type":"boolean","description":"Define if this policy can have sub-policies"}}},"ManagePolicyCreateSubPolicy":{"properties":{"sub_policy_acceptance_message":{"$ref":"#/definitions/localizable","description":"e.g. - sub_policy_acceptance_message: {&quot;en&quot;: &quot;English Sub-policy acceptance_message&quot;}. If it&#039;s provided, it&#039;s required in the default language."},"mandatory":{"type":"boolean","description":"Define if this Sub-Policy is mandatory"}}},"ManagePolicyCreateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManagePolicyCreateData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManagePolicyCreateData":{"required":["success","policy_id"],"properties":{"success":{"type":"boolean","description":"Is operation successful"},"policy_id":{"type":"integer","description":"New created Policy ID"}}},"ManagePolicyDeleteResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManagePolicyDeleteData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManagePolicyDeleteData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Is operation successful"}}},"ManagePolicyIndexResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManagePolicyIndexData","description":"Array of policies"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManagePolicyIndexLinks"}}}},"ManagePolicyIndexData":{"properties":{"items":{"type":"array","description":"List of policies","items":{"$ref":"#/definitions/ManagePolicyIndexItems"}}}},"ManagePolicyIndexItems":{"required":["id","name","default","multidomains","last_updated","version","actions"],"properties":{"id":{"type":"integer","description":"The ID of the policy"},"name":{"type":"string","description":"The name of the policy"},"default":{"type":"boolean","description":"Is the policy default"},"multidomains":{"type":"string","description":"Number of the domains the policy is assigned to"},"last_updated":{"type":"string","format":"date","description":"The last updated date of the policy"},"version":{"type":"integer","description":"The version of the policy"},"actions":{"type":"array","description":"List of actions: edit|delete","items":{"$ref":"#/definitions/ManagePolicyIndexActions"}}}},"ManagePolicyIndexActions":{"required":["action"],"properties":{"action":{"type":"string","description":"Action name"}}},"ManagePolicyIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManagePolicyUpdateSchema":{"type":"object","required":["policy"],"properties":{"policy":{"$ref":"#/definitions/ManagePolicyUpdatePolicy","description":"The Policy data, e.g. &quot;policy&quot;: { &quot;policy_name&quot;: {&quot;en&quot;: &quot;Policy en name&quot;,&quot;bg&quot;: &quot;Policy bg name&quot;}, &quot;policy_acceptance_message&quot;: {&quot;en&quot;: &quot;en acceptance message&quot;},&quot;policy_body&quot;: {&quot;en&quot;: &quot;en body&quot;} }"},"sub_policy":{"type":"array","description":"The Sub-Policy data, e.g. &quot;sub_policy&quot;: [ {&quot;sub_policy_acceptance_message&quot;: {&quot;all&quot;: &quot;sub_policy 1 all&quot;}, &quot;mandatory&quot;:1}, {&quot;sub_policy_acceptance_message&quot;: {&quot;en&quot;: &quot;sub_policy 2 en&quot;, &quot;bg&quot;: &quot;sub_pol 2 bg&quot;}&quot;mandatory&quot;:0}, {&quot;sub_policy_acceptance_message&quot;: {&quot;en&quot;: &quot;sub_policy 3 en&quot;}} ]","items":{"$ref":"#/definitions/ManagePolicyUpdateSubPolicy"}},"check_only_is_new_version":{"type":"boolean","description":"If this parameter is provided API just will check if it&#039;s new version or just update of the name BUT nothing will be changed"}}},"ManagePolicyUpdatePolicy":{"required":["policy_name","policy_acceptance_message","policy_body","enable_sub_policies"],"properties":{"policy_name":{"$ref":"#/definitions/ManagePolicyUpdatePolicyName","description":"The key is language code, the value is translated Policy Name. If provided key is &#039;all&#039; it will be considered as translation for all active languages"},"policy_acceptance_message":{"$ref":"#/definitions/ManagePolicyUpdatePolicyAcceptanceMessage","description":"The key is language code, the value is translated Policy Acceptance Message. If provided key is &#039;all&#039; it will be considered as translation for all active languages"},"policy_body":{"$ref":"#/definitions/ManagePolicyUpdatePolicyBody","description":"The key is language code, the value is translated Policy Body. If provided key is &#039;all&#039; it will be considered as translation for all active languages"},"enable_sub_policies":{"type":"integer","description":"Define if this policy can have sub-policies. Options: &#039;1&#039; - to allow Sub Policies, &#039;0&#039; - to disable Sub Policies"}}},"ManagePolicyUpdatePolicyName":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation e.g. - policy_name: {&quot;en&quot;: &quot;English Policy name&quot;}. Required only in the default language."}}},"ManagePolicyUpdatePolicyAcceptanceMessage":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation e.g. - policy_acceptance_message: {&quot;en&quot;: &quot;English Policy acceptance message&quot;}. Required only in the default language."}}},"ManagePolicyUpdatePolicyBody":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation e.g. - policy_body: {&quot;en&quot;: &quot;English Policy body&quot;}. Required only in the default language."}}},"ManagePolicyUpdateSubPolicy":{"properties":{"sub_policy_acceptance_message":{"$ref":"#/definitions/ManagePolicyUpdateSubPolicyAcceptanceMessage","description":"The key is language code, the value is translated Sub-Policy Acceptance Message. If provided key is &#039;all&#039; it will be considered as translation for all active languages"},"mandatory":{"type":"boolean","description":"Define if this Sub-Policy is mandatory"}}},"ManagePolicyUpdateSubPolicyAcceptanceMessage":{"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation e.g. - sub_policy_acceptance_message: {&quot;en&quot;: &quot;English Sub-policy acceptance_message&quot;}. If it&#039;s provided, it&#039;s required in the default language."}}},"ManagePolicyUpdateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManagePolicyUpdateData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManagePolicyUpdateData":{"required":["success","policy_id","action"],"properties":{"success":{"type":"boolean","description":"Is operation successful"},"policy_id":{"type":"integer","description":"New created or updated Policy ID"},"action":{"type":"string","description":"It shows if new version is created or updated existing one. Options: &#039;create_new_version&#039; and &#039;update&#039;"}}},"ManagePolicyAssignSchema":{"type":"object","required":["multidomain_ids"],"properties":{"multidomain_ids":{"type":"array","description":"Array of multi domains Ids","items":{"type":"integer"}}}},"ManagePolicyAssignResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManagePolicyAssignData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManagePolicyAssignData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Is operation successful"}}},"ManagePolicyTrackSchema":{"type":"object","required":["policy"],"properties":{"policy":{"$ref":"#/definitions/ManagePolicyTrackPolicy","description":"The Policy data, e.g. &quot;policy&quot;: { &quot;policy&quot;: { &quot;id&quot;: 37,&quot;answer&quot;: 1,&quot;sub_policies&quot;: { &quot;151&quot;: 1,&quot;153&quot;: 1,&quot;1111&quot;: 1,&quot;2222&quot;: 1}} }"},"client_id":{"type":"integer","description":"The ID of the multidomain client."}}},"ManagePolicyTrackPolicy":{"required":["id","answer"],"properties":{"id":{"type":"integer","description":"Policy ID"},"answer":{"type":"integer","description":"Answer. Options 1 - accept, 0 - not accept"},"sub_policies":{"type":"array","description":"Example : [{id: 10, answer: 0}, {id: 11, answer: 1}, {id: 12, answer: 0}] Where &#039;id&#039; is the id of the sub policy.","items":{"$ref":"#/definitions/ManagePolicyTrackSubPolicies"}}}},"ManagePolicyTrackSubPolicies":{"properties":{"id":{"type":"integer","description":"ID of the Sub Policy"},"answer":{"type":"integer","description":"Answer. Options: 1 - accept, 0 - not accept"}}},"ManagePolicyTrackResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManagePolicyTrackData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManagePolicyTrackLinks"}}}},"ManagePolicyTrackData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Is operation successful"},"invalid_sub_policy_ids":{"type":"array","description":"The IDs of provided invalid Sub-Policies","items":{"type":"integer"}}}},"ManagePolicyTrackLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManagePolicyLastVersionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManagePolicyLastVersionData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManagePolicyLastVersionData":{"required":["policy","sub_policy"],"properties":{"policy":{"$ref":"#/definitions/ManagePolicyLastVersionPolicy","description":"Policy info"},"sub_policy":{"type":"array","description":"List with sub_policies for this policy","items":{"$ref":"#/definitions/ManagePolicyLastVersionSubPolicy"}}}},"ManagePolicyLastVersionPolicy":{"required":["policy_id","default_policy","policy_name","policy_acceptance_message","policy_body","policy_created_timestamp","policy_version","policy_version_id","creator_username","creator_name","creator_initials","enable_sub_policies","creator_avatar"],"properties":{"policy_id":{"type":"integer","description":"The ID of the policy"},"default_policy":{"type":"boolean","description":"Is the policy default"},"policy_name":{"$ref":"#/definitions/ManagePolicyLastVersionPolicyName","description":"The name of the policy of all languages"},"policy_acceptance_message":{"$ref":"#/definitions/ManagePolicyLastVersionPolicyAcceptanceMessage","description":"The acceptance message of the policy of all languages"},"policy_body":{"$ref":"#/definitions/ManagePolicyLastVersionPolicyBody","description":"The body of the policy of all languages"},"policy_created_timestamp":{"type":"string","format":"date","description":"The created date of the policy, formatted as &quot;yyyy-mm-dd hh:mm:ss&quot;, UTC timezone"},"policy_version":{"type":"integer","description":"The version of the policy"},"policy_version_id":{"type":"integer","description":"The version id of the policy"},"creator_username":{"type":"string","description":"The username of creator of policy"},"creator_name":{"type":"string","description":"The first and last name of creator, if they didn&#039;t exist set username."},"creator_initials":{"type":"string","description":"The first letters of first and last name of a creator."},"enable_sub_policies":{"type":"boolean","description":"Is enabled Sub Policies."},"creator_avatar":{"type":"string","description":"The avatar of creator of policy, image url."}}},"ManagePolicyLastVersionPolicyName":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManagePolicyLastVersionPolicyAcceptanceMessage":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManagePolicyLastVersionPolicyBody":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManagePolicyLastVersionSubPolicy":{"required":["sub_policy_acceptance_message","mandatory"],"properties":{"sub_policy_acceptance_message":{"$ref":"#/definitions/ManagePolicyLastVersionSubPolicyAcceptanceMessage","description":"The acceptance message of the sub policy of all languages"},"mandatory":{"type":"boolean","description":"Is the sub policy is mandatory"}}},"ManagePolicyLastVersionSubPolicyAcceptanceMessage":{"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManagePolicyGetVersionsResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManagePolicyGetVersionsData","description":"Array of policies"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManagePolicyGetVersionsLinks"}}}},"ManagePolicyGetVersionsData":{"required":["id","name","default","versions"],"properties":{"id":{"type":"integer","description":"The ID of the policy"},"name":{"$ref":"#/definitions/ManagePolicyGetVersionsName","description":"The name of the policy"},"default":{"type":"boolean","description":"Is the policy default"},"versions":{"$ref":"#/definitions/ManagePolicyGetVersionsVersions","description":"Array of the version objects of the policy"}}},"ManagePolicyGetVersionsName":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManagePolicyGetVersionsVersions":{"required":["id","acceptance_message","body","version","creator","creation_date","sub_policies","creator_first_name","creator_last_name","creator_avatar"],"properties":{"id":{"type":"integer","description":"Version ID"},"acceptance_message":{"$ref":"#/definitions/ManagePolicyGetVersionsAcceptanceMessage","description":"The key is language code, the value is translated Policy Acceptance Message."},"body":{"$ref":"#/definitions/ManagePolicyGetVersionsBody","description":"The key is language code, the value is translated Policy Body."},"version":{"type":"string","description":"The Policy version"},"creator":{"type":"string","description":"ID of the user that created this version"},"creation_date":{"type":"string","format":"date","description":"The created date of the policy, formatted as &quot;yyyy-mm-dd hh:mm:ss&quot;, UTC timezone"},"sub_policies":{"$ref":"#/definitions/ManagePolicyGetVersionsSubPolicies","description":"Sub-policies"},"creator_first_name":{"type":"string","description":"The first name of the user that created this version"},"creator_last_name":{"type":"string","description":"The last name of the user that created this version"},"creator_avatar":{"type":"string","description":"The avatar of the user that created this version"}}},"ManagePolicyGetVersionsAcceptanceMessage":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManagePolicyGetVersionsBody":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManagePolicyGetVersionsSubPolicies":{"required":["condition","mandatory"],"properties":{"condition":{"$ref":"#/definitions/ManagePolicyGetVersionsCondition","description":"Condition"},"mandatory":{"type":"integer","description":"Is mandatory. Options: 0, 1"}}},"ManagePolicyGetVersionsCondition":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManagePolicyGetVersionsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManagePolicyUnassignSchema":{"type":"object","required":["multidomain_ids"],"properties":{"multidomain_ids":{"type":"array","description":"Array of multidomains IDs","items":{"type":"integer"}}}},"ManagePolicyUnassignResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManagePolicyUnassignData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManagePolicyUnassignData":{"required":["success","updated_rows"],"properties":{"success":{"type":"boolean","description":"Is operation successful"},"updated_rows":{"type":"integer","description":"The number of successfully updated rows"},"warnings":{"$ref":"#/definitions/ManagePolicyUnassignWarnings","description":"The number of successfully updated rows"}}},"ManagePolicyUnassignWarnings":{"required":["invalid_miltidmains"],"properties":{"invalid_miltidmains":{"$ref":"#/definitions/ManagePolicyUnassignInvalidMiltidmains","description":"Invalid miltidmains"}}},"ManagePolicyUnassignInvalidMiltidmains":{"required":["ids","message"],"properties":{"ids":{"type":"array","description":"The IDs of invalid miltidmains","items":{"type":"integer"}},"message":{"type":"string","description":"A relevant message of error is returned"}}},"ManagePolicyAssignListResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManagePolicyAssignListData","description":"Array of policies"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManagePolicyAssignListLinks"}}}},"ManagePolicyAssignListData":{"properties":{"items":{"type":"array","description":"List of policies","items":{"$ref":"#/definitions/ManagePolicyAssignListItems"}}}},"ManagePolicyAssignListItems":{"required":["id","name","domain_name","policy_associated_date"],"properties":{"id":{"type":"string","description":"The ID of the policy"},"name":{"type":"string","description":"The name of the domain"},"domain_name":{"type":"string","description":"Domain name"},"policy_associated_date":{"type":"string","description":"Date when the policy was associated to a domain"}}},"ManagePolicyAssignListLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManagePolicyClientsResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManagePolicyClientsData","description":"Array of clients"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManagePolicyClientsLinks"}}}},"ManagePolicyClientsData":{"properties":{"items":{"type":"array","description":"List of policies","items":{"$ref":"#/definitions/ManagePolicyClientsItems"}}}},"ManagePolicyClientsItems":{"required":["id","name","domain","policy_id","policy_name","is_assigned","date_assign"],"properties":{"id":{"type":"integer","description":"The ID of the client"},"name":{"type":"string","description":"The name of the client"},"domain":{"type":"string","description":"The domain name of the client"},"policy_id":{"type":"string","description":"The id of the assigned policy"},"policy_name":{"type":"string","description":"The name of the assigned policy"},"is_assigned":{"type":"boolean","description":"Is the client already assigned to the requested policy"},"date_assign":{"type":"string","description":"The date of assignment"}}},"ManagePolicyClientsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManagePolicyViewTrackResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManagePolicyViewTrackData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManagePolicyViewTrackData":{"required":["policy","sub_policy"],"properties":{"policy":{"$ref":"#/definitions/ManagePolicyViewTrackPolicy","description":"Policy info"},"sub_policy":{"type":"array","description":"List with sub_policies for this policy","items":{"$ref":"#/definitions/ManagePolicyViewTrackSubPolicy"}}}},"ManagePolicyViewTrackPolicy":{"required":["track_id","answer","policy_id","id_policy_version","default_policy","policy_name","policy_acceptance_message","policy_body","policy_created_timestamp","policy_version"],"properties":{"track_id":{"type":"integer","description":"The ID of tracking"},"answer":{"type":"boolean","description":"Is policy is accepted"},"policy_id":{"type":"integer","description":"The ID of the policy"},"id_policy_version":{"type":"integer","description":"The ID of privacy policy version"},"default_policy":{"type":"boolean","description":"Is the policy default"},"policy_name":{"$ref":"#/definitions/ManagePolicyViewTrackPolicyName","description":"The name of the policy of all languages"},"policy_acceptance_message":{"$ref":"#/definitions/ManagePolicyViewTrackPolicyAcceptanceMessage","description":"The acceptance message of the policy of all languages"},"policy_body":{"$ref":"#/definitions/ManagePolicyViewTrackPolicyBody","description":"The body of the policy of all languages"},"policy_created_timestamp":{"type":"string","format":"date","description":"The created date of the policy"},"policy_version":{"type":"integer","description":"The version of the policy"}}},"ManagePolicyViewTrackPolicyName":{"properties":{"en":{"type":"string","description":"Language key and translation e.g. - policy_name: {&quot;en&quot;: &quot;English Policy name&quot;}"}}},"ManagePolicyViewTrackPolicyAcceptanceMessage":{"properties":{"en":{"type":"string","description":"Language key and translation e.g. - policy_name: {&quot;en&quot;: &quot;English Policy acceptance message&quot;}"}}},"ManagePolicyViewTrackPolicyBody":{"properties":{"en":{"type":"string","description":"Language key and translation e.g. - policy_name: {&quot;en&quot;: &quot;English Policy body&quot;}"}}},"ManagePolicyViewTrackSubPolicy":{"required":["id","mandatory","answer","sub_policy_acceptance_message"],"properties":{"id":{"type":"integer","description":"The ID of the sub policy"},"mandatory":{"type":"boolean","description":"Is the sub policy is mandatory"},"answer":{"type":"boolean","description":"Is the sub policy is accepted"},"sub_policy_acceptance_message":{"$ref":"#/definitions/ManagePolicyViewTrackSubPolicyAcceptanceMessage","description":"The acceptance message of the sub policy of all languages"}}},"ManagePolicyViewTrackSubPolicyAcceptanceMessage":{"properties":{"en":{"type":"string","description":"Language key, e.g. &#039;en&#039;"}}},"ManagePolicyUpdateTrackSchema":{"type":"object","required":["id_policy_version","track_answer","sub_policy"],"properties":{"id_policy_version":{"type":"integer","description":"Id of last policy version"},"track_answer":{"type":"integer","description":"Answer for policy (0 - not agree, 1 - agree)"},"sub_policy":{"type":"array","description":"Array with sub policies information","items":{"$ref":"#/definitions/ManagePolicyUpdateTrackSubPolicy"}}}},"ManagePolicyUpdateTrackSubPolicy":{"required":["id","answer"],"properties":{"id":{"type":"integer","description":"ID of sub policy"},"answer":{"type":"integer","description":"Answer for sub policy (0 - not agree, 1 - agree)"}}},"ManagePolicyUpdateTrackResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure to update tracking with error messages (optional)","items":{"$ref":"#/definitions/ManagePolicyUpdateTrackData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManagePolicyUpdateTrackData":{"required":["success","message"],"properties":{"success":{"type":"boolean","description":"Success or failure to update tracking"},"logout":{"type":"boolean","description":"Log out the user from the system or not"},"message":{"type":"string","description":"Error message"}}},"ManagePolicyGetLastPolicyByDomainResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManagePolicyGetLastPolicyByDomainData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManagePolicyGetLastPolicyByDomainData":{"required":["policy_id"],"properties":{"policy_id":{"type":"integer","description":"The ID of the policy"}}},"ManagePolicyCheckAcceptanceResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManagePolicyCheckAcceptanceData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManagePolicyCheckAcceptanceData":{"required":["policy"],"properties":{"policy":{"$ref":"#/definitions/ManagePolicyCheckAcceptancePolicy","description":"False if no need to accept privacy policy, otherwise the policy object"}}},"ManagePolicyCheckAcceptancePolicy":{"required":["policy_id","default_policy","policy_name","policy_acceptance_message","policy_body","policy_version","policy_version_id","policy_created_timestamp","creator_username","creator_name","creator_initials","enable_sub_policies","creator_avatar"],"properties":{"policy_id":{"type":"integer","description":"The ID of the policy"},"default_policy":{"type":"integer","description":"Is default Policy. Options: 0, 1"},"policy_name":{"$ref":"#/definitions/ManagePolicyCheckAcceptancePolicyName","description":"Policy name"},"policy_acceptance_message":{"$ref":"#/definitions/ManagePolicyCheckAcceptancePolicyAcceptanceMessage","description":"The key is language code, the value is translated Policy Acceptance Message."},"policy_body":{"$ref":"#/definitions/ManagePolicyCheckAcceptancePolicyBody","description":"The key is language code, the value is translated Policy Body."},"policy_version":{"type":"integer","description":"The Policy version"},"policy_version_id":{"type":"integer","description":"The Policy version id"},"policy_created_timestamp":{"type":"string","format":"date","description":"The created date of the policy, formatted as &quot;yyyy-mm-dd hh:mm:ss&quot;, UTC timezone"},"creator_username":{"type":"string","description":"The username of creator of policy"},"creator_name":{"type":"string","description":"The first and last name of creator, if they didn&#039;t exist set username."},"creator_initials":{"type":"string","description":"The first letters of first and last name of a creator."},"enable_sub_policies":{"type":"boolean","description":"Is enabled Sub Policies."},"creator_avatar":{"type":"string","description":"The avatar of creator of policy, image url."}}},"ManagePolicyCheckAcceptancePolicyName":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManagePolicyCheckAcceptancePolicyAcceptanceMessage":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManagePolicyCheckAcceptancePolicyBody":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManageSiteBootstrapResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"response","items":{"$ref":"#/definitions/ManageSiteBootstrapData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageSiteBootstrapData":{"required":["is_ip_access_allowed","theme","active_theme","default_platform_language","default_platform_timezone","translations_cdn_url","platform_version","policy_id","active_languages","active_plugins","in_maintenance_mode","setup_finished","use_https","ua_mobile","platform_urls","ws_settings","is_oem_enabled","enabled_feature_toggles","enabled_flow_feature_toggles"],"properties":{"is_ip_access_allowed":{"type":"boolean","description":"Whether the IP from which, the current request is made, has access to the platform (the IP is in platform&#039;s whitelist or not)"},"theme":{"type":"string","description":"The current theme being loaded for the requested main domain or multidomain client"},"active_theme":{"type":"string","description":"The current active theme assigned to requested main domain or multidomain client. It can be different from &quot;theme&quot; when previewing themes."},"default_platform_language":{"type":"string","description":"Default platform language in short format - bg, en etc."},"default_platform_timezone":{"type":"string","description":"Default platform timezone"},"translations_cdn_url":{"type":"string","description":"URL of the CDN from which to fetch translations"},"platform_version":{"type":"string","description":"Platform current version from core_setting =&gt; core_version"},"policy_id":{"type":"integer","description":"Id of policy. If it is a 0, no policy is required to be signed for this domain client."},"tc_id":{"type":"integer","description":"Id of a terms and conditions record. If it is a 0, no terms and conditions are required to be agreed with for this domain client."},"active_languages":{"type":"array","description":"Array with active languages","items":{"$ref":"#/definitions/ManageSiteBootstrapActiveLanguages"}},"active_plugins":{"type":"array","description":"Array with active plugins","items":{"$ref":"#/definitions/ManageSiteBootstrapActivePlugins"}},"branding_elements":{"$ref":"#/definitions/ManageSiteBootstrapBrandingElements","description":"Main branding elements of current LMS"},"settings":{"$ref":"#/definitions/ManageSiteBootstrapSettings","description":""},"catalog_settings":{"$ref":"#/definitions/ManageSiteBootstrapCatalogSettings","description":""},"datadog_rum_settings":{"$ref":"#/definitions/ManageSiteBootstrapDatadogRumSettings","description":"Params used by the Datadog Real User Monitoring script. Only with toggle TOGGLE_DATADOG_REAL_USER_MONITORING enabled"},"footer":{"$ref":"#/definitions/ManageSiteBootstrapFooter","description":"Main elements of the footer"},"header":{"$ref":"#/definitions/ManageSiteBootstrapHeaderL2","description":""},"billing":{"$ref":"#/definitions/ManageSiteBootstrapBilling","description":"Set of flags related to the LMS billing"},"is_logged_in":{"type":"boolean","description":"whether the user is logged"},"access_token":{"type":"string","description":"An oauth2 access token generated in case the user is logged in"},"in_maintenance_mode":{"type":"boolean","description":"If the LMS is in maintenance mode"},"setup_finished":{"type":"boolean","description":"If the LMS has been installed fully"},"setup_redirect":{"type":"string","description":"If the LMS installation was not finished this is the URL to be used to redirect the user"},"use_https":{"type":"boolean","description":"Whether or not to force usage of HTTPs"},"ua_mobile":{"type":"array","description":"A comma An array of browser user agents that are considered as &quot;mobile&quot;","items":{"$ref":"#/definitions/ManageSiteBootstrapUaMobile"}},"platform_urls":{"$ref":"#/definitions/ManageSiteBootstrapPlatformUrls","description":"The urls of the platform"},"sso_providers":{"type":"array","description":"It contains the array of SSO providers to display as buttons","items":{"$ref":"#/definitions/ManageSiteBootstrapSsoProviders"}},"user_settings":{"$ref":"#/definitions/ManageSiteBootstrapUserSettings","description":""},"ws_settings":{"$ref":"#/definitions/ManageSiteBootstrapWsSettings","description":""},"is_oem_enabled":{"type":"boolean","description":"Flagged true if the LMS is in embedded mode. Default is false"},"enabled_feature_toggles":{"type":"array","description":"An array of frontend feature toggles enabled for the LMS. Empty if no toggles are enabled.","items":{"$ref":"#/definitions/ManageSiteBootstrapEnabledFeatureToggles"}},"enabled_flow_feature_toggles":{"type":"array","description":"An array of feature toggles enabled for the FLOW. Empty if no toggles are enabled.","items":{"$ref":"#/definitions/ManageSiteBootstrapEnabledFlowFeatureToggles"}},"session_id":{"type":"string","description":"the session uuid"},"ip_country":{"type":"string","description":"the country base"},"enable_setup_button":{"type":"boolean","description":"if true, the &quot;Setup Guide&quot; button in main menu is visible (default value is &#039;true&#039;)"},"disable_simultaneous_access":{"type":"boolean","description":"Whether the referred advanced setting is enabled"},"cookie_policy_lastupdate":{"type":"string","description":"Cookie policy last update date, if the new cookie policy management is active"},"docet_configuration":{"type":"array","description":"This array return only when toggle TOGGLE_ENABLE_DOCET_TRACKING is enabled and contains docet configurations","items":{"$ref":"#/definitions/ManageSiteBootstrapDocetConfiguration"}},"more_user_dropdown_options_limit":{"type":"integer","description":"Maximum number of options for a user field of type dropdown"},"ecommerce_cart":{"$ref":"#/definitions/ManageSiteBootstrapEcommerceCart","description":"Only show if an external cart is assigned to the current domain"},"paas":{"$ref":"#/definitions/ManageSiteBootstrapPaas","description":""},"mfe_config":{"$ref":"#/definitions/ManageSiteBootstrapMfeConfig","description":""},"community_settings":{"$ref":"#/definitions/ManageSiteBootstrapCommunitySettings","description":"Only show if the community app is enabled, null if no community are configured for the current domain."},"communities_base_url":{"type":"string","description":"URL that community app should use to make API calls to and load JS from."},"peerboard_base_url":{"type":"string","description":"The peerboard base url used to make API calls."},"ecommerce_settings":{"$ref":"#/definitions/ManageSiteBootstrapEcommerceSettings","description":"Only show if the ecommerce app and toggle RELEASE/2023.12/REDESIGNED-PRICE-STORAGE are enabled"},"aivc":{"$ref":"#/definitions/ManageSiteBootstrapAivc","description":"Object containing URLs needed by AI Virtual Coach features"},"ai":{"$ref":"#/definitions/ManageSiteBootstrapAi","description":"Object containing URLs needed by various AI features to work"}}},"ManageSiteBootstrapActiveLanguages":{"required":["code","description","browsercode","is_rtl"],"properties":{"code":{"type":"string","description":"Language code"},"description":{"type":"string","description":"Language description"},"browsercode":{"type":"string","description":"Language Shortcode - bg, en"},"is_rtl":{"type":"boolean","description":"Is the language Right-To-Left(RTL)."}}},"ManageSiteBootstrapActivePlugins":{"required":["plugin_name","plugin_title"],"properties":{"plugin_name":{"type":"string","description":"Plugin name"},"plugin_title":{"type":"string","description":"Plugin title"}}},"ManageSiteBootstrapBrandingElements":{"required":["colors","header","signin","styles","course_player","home_page_texts","home_page_descriptions"],"properties":{"colors":{"$ref":"#/definitions/ManageSiteBootstrapColors","description":"Object containing the set of colors for the current theme"},"header":{"$ref":"#/definitions/ManageSiteBootstrapHeader","description":"Object containing values for the theme &quot;header&quot; configuration set"},"signin":{"$ref":"#/definitions/ManageSiteBootstrapSignin","description":"Object containing values for the theme &quot;signin&quot; configuration set"},"styles":{"$ref":"#/definitions/ManageSiteBootstrapStyles","description":"Object containing values for the theme &quot;styles&quot; configuration set"},"white_label":{"$ref":"#/definitions/ManageSiteBootstrapWhiteLabel","description":""},"course_player":{"$ref":"#/definitions/ManageSiteBootstrapCoursePlayer","description":""},"marketplace":{"$ref":"#/definitions/ManageSiteBootstrapMarketplace","description":""},"home_page_texts":{"type":"array","description":"Custom texts for the login form indexed by the language code.","items":{"$ref":"#/definitions/ManageSiteBootstrapHomePageTexts"}},"home_page_descriptions":{"type":"array","description":"Custom descriptions for the login form by the language code.","items":{"$ref":"#/definitions/ManageSiteBootstrapHomePageDescriptions"}}}},"ManageSiteBootstrapColors":{"required":["mainColor","actionColor","warningColor","errorColor","mainTextColor","secondaryColor","bordersColor","backgroundColor","accentTextColor"],"properties":{"mainColor":{"type":"string","description":"Main color"},"actionColor":{"type":"string","description":"Confirmations color"},"warningColor":{"type":"string","description":"Warnings color"},"errorColor":{"type":"string","description":"Errors color"},"mainTextColor":{"type":"string","description":"Main text color"},"secondaryColor":{"type":"string","description":"Secondary color"},"bordersColor":{"type":"string","description":"Borders and lines color"},"backgroundColor":{"type":"string","description":"Background and hover items color"},"accentTextColor":{"type":"string","description":"Accent text color"}}},"ManageSiteBootstrapHeader":{"required":["logo","title","favicon","header_message"],"properties":{"logo":{"type":"string","description":"Link for logo image"},"title":{"type":"string","description":"Page title"},"favicon":{"type":"string","description":"Link for favIcon image"},"header_message":{"type":"string","description":"Message for the header"}}},"ManageSiteBootstrapSignin":{"required":["background_type","background_value","hide_signin_form"],"properties":{"background_type":{"description":"The type of background for the signin form. Possible values = &quot;color&quot;, &quot;image&quot;, &quot;video&quot;","enum":["color","image","video"],"type":"string"},"background_value":{"type":"string","description":"The value of the background setting (for &quot;color&quot; type it&#039;s the hex color, for &quot;image&quot; type it&#039;s the image URL, for &quot;video&quot; type it&#039;s the video URL"},"background_fallback_image":{"type":"string","description":"The URL of background image to use if video is broken"},"hide_signin_form":{"type":"boolean","description":"Indicates whether username/password login is to be hidden. Default = false"}}},"ManageSiteBootstrapStyles":{"required":["custom_css","custom_css_url"],"properties":{"custom_css":{"type":"string","description":"The custom css configured for this theme"},"custom_css_url":{"type":"string","description":"The custom css cloudfront url that contains the custom stylesheet. See custom_css param above."},"custom_css_69":{"type":"string","description":"Custom CSS for 69 theme"}}},"ManageSiteBootstrapWhiteLabel":{"properties":{"whitelabel_naming":{"type":"integer","description":"is option for replacing word &quot;Docebo&quot; active or not"},"whitelabel_disable_naming":{"type":"integer","description":"should we do not replace the word &quot;Docebo&quot; in hyperlinks"},"whitelabel_naming_text":{"type":"string","description":"text, which have to replace the word &quot;Docebo&quot;"},"whitelabel_naming_site_enable":{"type":"integer","description":"is option for replacing original site active or not"},"whitelabel_naming_site":{"type":"string","description":"website, which have to replace the www.docebo.com site link"},"whitelabel_menu_userid":{"type":"integer","description":"ID of the White Label App manager"}}},"ManageSiteBootstrapCoursePlayer":{"required":["show_prepage","show_table_of_contents","background_image","stretch_image_to_page","custom_html_css","player_appearance","focus_mode"],"properties":{"show_prepage":{"type":"boolean","description":"Whether the Overview page should be shown for E-Learning courses"},"show_table_of_contents":{"type":"boolean","description":"Whether the Table of contents should be visible by default when loading a course"},"background_image":{"type":"string","description":"The player background image"},"stretch_image_to_page":{"type":"boolean","description":"Whether the player background image should stretch to fit the page"},"custom_html_css":{"type":"string","description":"The custom CSS to be applied to HTML lessons"},"player_appearance":{"description":"The player color scheme","enum":["light","dark"],"type":"string"},"focus_mode":{"type":"boolean","description":"Whether the focus mode is active in the platform"}}},"ManageSiteBootstrapMarketplace":{"properties":{"host":{"type":"integer","description":"is option for replacing word &quot;Docebo&quot; active or not"}}},"ManageSiteBootstrapHomePageTexts":{},"ManageSiteBootstrapHomePageDescriptions":{},"ManageSiteBootstrapSettings":{"required":["allow_only_password_change","remember_me_is_enabled","show_first_name_first","allow_user_dateformat_override","request_mandatory_fields_completion","currency_settings","send_immediate_notification","show_mobile_theme_settings","share_this_view_button","show_redirect_mobile_dialog","team_and_managers_settings","show_tincan_options","skills_third_party_enabled","content_curation_enabled","soft_deadline_enabled","new_certification_enabled","show_contact_us","elearning","enable_quick_enrollment_elearning_course","ai_configuration"],"properties":{"allow_only_password_change":{"type":"boolean","description":"Whether or not users can only change their password of their profile (and nothing else)"},"remember_me_is_enabled":{"type":"boolean","description":"Whether or not the &quot;Remember me&quot; functionality is on"},"show_first_name_first":{"type":"boolean","description":""},"timezone_allow_user_override":{"type":"boolean","description":""},"allow_user_dateformat_override":{"type":"boolean","description":""},"registration_settings":{"$ref":"#/definitions/ManageSiteBootstrapRegistrationSettings","description":""},"request_mandatory_fields_completion":{"type":"boolean","description":"- Whether or not users need to fill any unfilled user additional fields before being able to use the platform."},"saml_login_redirect_url":{"type":"string","description":"URL for automatic redirect to identity provider"},"currency_settings":{"$ref":"#/definitions/ManageSiteBootstrapCurrencySettings","description":""},"send_immediate_notification":{"type":"boolean","description":"Whether to send immediate notification digest on massive enrollment action"},"dateformat_locale":{"type":"string","description":""},"timezone":{"type":"string","description":""},"show_mobile_theme_settings":{"type":"boolean","description":"If the mobile settings tab in the theme settings should be shown"},"share_this_view_button":{"type":"boolean","description":"Enable users to share the view of the catalog together with all the filters applied directly from this page, by showing the corresponding button in the top right corner"},"show_redirect_mobile_dialog":{"type":"boolean","description":"Whether or not the &quot;Redirect Mobile Dialog Window&quot; functionality is on"},"allow_password_change":{"description":"Users settings parameter used by admin, the allow/not allow to change users password, possible value: never, always","enum":["never","always"],"type":"string"},"team_and_managers_settings":{"$ref":"#/definitions/ManageSiteBootstrapTeamAndManagersSettings","description":"Object containing values for the Teams and Managers configuration set"},"mobileapp_android_schema":{"type":"string","description":"The schema used to launch native Android mobile app from browser"},"mobileapp_ios_schema":{"type":"string","description":"The schema used to launch native iOS mobile app from browser"},"show_tincan_options":{"type":"boolean","description":"Whether or not to show the tincan mobile settings in Advanced Settings / mobile tab"},"google_analytics_tracking_codes":{"type":"array","description":"Google Analytics tracking codes","items":{"type":"string"}},"injected_js_code":{"type":"string","description":"javascript string code to inject in the LMS at bootstrap"},"content_library_custom_name":{"type":"string","description":"If set, it replaces all occurrences of the &quot;Docebo Content&quot; label with the value of this property"},"enable_rsvp_option":{"type":"string","description":"Whether or not rsvp functionalities have been activated for ILT courses (returned when toggle release/weekly/vilt-rsvp is on)"},"skills_third_party_enabled":{"type":"boolean","description":"If the third party setting is enabled for skills"},"content_curation_enabled":{"type":"boolean","description":"Whether Content Curation is active"},"soft_deadline_enabled":{"type":"boolean","description":"Whether soft deadline is enabled"},"new_certification_enabled":{"type":"boolean","description":"Whether new certifications are enabled"},"show_contact_us":{"type":"boolean","description":"Show contact us section on FE"},"elearning":{"$ref":"#/definitions/ManageSiteBootstrapElearning","description":"E-learning Settings"},"enable_quick_enrollment_elearning_course":{"type":"boolean","description":"Enable users to play an e-learning course with quick enrollment."},"lp_enrollment_api_limits":{"$ref":"#/definitions/ManageSiteBootstrapLpEnrollmentApiLimits","description":"Object containing the thresholds in place for all learning plan enrollment operations"},"ai_configuration":{"$ref":"#/definitions/ManageSiteBootstrapAiConfiguration","description":"Activation status of AI features"}}},"ManageSiteBootstrapRegistrationSettings":{"properties":{"registration_type":{"type":"string","description":"User registration type (self, moderate, admin only)"},"options":{"$ref":"#/definitions/ManageSiteBootstrapOptions","description":""},"registration_code_usage":{"$ref":"#/definitions/ManageSiteBootstrapRegistrationCodeUsage","description":""}}},"ManageSiteBootstrapOptions":{"properties":{"lastfirst_mandatory":{"type":"boolean","description":"Require first name and last name during the registration"},"privacy_policy":{"type":"boolean","description":"Require accept the Privacy policy"},"privacy_policy_link":{"type":"string","description":"Privacy policy link"},"terms_and_conditions":{"type":"boolean","description":"Is it required, for the user, to agree with the terms and conditions"},"terms_and_conditions_link":{"type":"string","description":"Terms &amp; Conditions link. Empty string if the accepting the terms and conditions is not required"}}},"ManageSiteBootstrapRegistrationCodeUsage":{"properties":{"registration_code_type":{"type":"string","description":"Registration code usage"},"mandatory_code":{"type":"boolean","description":"If active and registration code usage is enabled, the users are forced to enter the registration code"}}},"ManageSiteBootstrapCurrencySettings":{"properties":{"currency":{"type":"string","description":"Returned only when toggle release/weekly/multi-currency is OFF"},"currency_symbol":{"type":"string","description":"Returned only when toggle release/weekly/multi-currency is OFF"},"stripe_type":{"type":"string","description":"stripe_type setting, can be simple, advanced or &#039;&#039;, if stripe is not enabled"}},"required":["stripe_type"]},"ManageSiteBootstrapTeamAndManagersSettings":{"required":["enable_subordinate_assign","enable_manager_assign","enable_manager_preview"],"properties":{"enable_subordinate_assign":{"type":"boolean","description":"Whether or not the managers could assign new subordinates"},"enable_manager_assign":{"type":"boolean","description":"Whether or not the subordinates could assign manager to themselves"},"enable_manager_preview":{"type":"boolean","description":"Whether or not the subordinates could view managers list"}}},"ManageSiteBootstrapElearning":{"required":["test_force_multichoice"],"properties":{"test_force_multichoice":{"type":"boolean","description":"If this option is enabled, a multiple choice test question that is only partially correct will be marked as incorrect"}}},"ManageSiteBootstrapLpEnrollmentApiLimits":{"required":["patch","post","delete","addCourseToLearningPlan"],"properties":{"patch":{"$ref":"#/definitions/ManageSiteBootstrapPatch","description":""},"post":{"$ref":"#/definitions/ManageSiteBootstrapPost","description":""},"delete":{"$ref":"#/definitions/ManageSiteBootstrapDelete","description":""},"addCourseToLearningPlan":{"$ref":"#/definitions/ManageSiteBootstrapAddCourseToLearningPlan","description":""}}},"ManageSiteBootstrapPatch":{"required":["threshold","chunk"],"properties":{"threshold":{"type":"integer","description":"The max number of operations that can be handled by a single enrollment update attempt"},"chunk":{"type":"integer","description":"The max size of a single page of operations handled by a single enrollment update attempt"}}},"ManageSiteBootstrapPost":{"required":["threshold","chunk"],"properties":{"threshold":{"type":"integer","description":"The max number of operations that can be handled by a single enrollment create attempt"},"chunk":{"type":"integer","description":"The max size of a single page of operations handled by a single enrollment create attempt"}}},"ManageSiteBootstrapDelete":{"required":["threshold","chunk"],"properties":{"threshold":{"type":"integer","description":"The max number of operations that can be handled by a single enrollment delete attempt"},"chunk":{"type":"integer","description":"The max size of a single page of operations handled by a single enrollment delete attempt"}}},"ManageSiteBootstrapAddCourseToLearningPlan":{"required":["chunk"],"properties":{"chunk":{"type":"integer","description":"The max size of a single page of operations handled when creating enrollments after adding courses to a learning plan"}}},"ManageSiteBootstrapAiConfiguration":{"properties":{"recommender":{"type":"boolean","description":"Whether the Recommender is active"},"auto_tagging":{"type":"boolean","description":"Whether the Auto-tagger is active"},"neural_search":{"type":"boolean","description":"Whether the Neural Search (Harmony Search) is active. Only returned if the respective toggle is active."},"neural_search_general_knowledge":{"type":"boolean","description":"Whether the general knowledge is enabled in the Neural Search (Harmony Search). Only returned if the Neural Search toggle is active."},"harmony_copilot":{"type":"boolean","description":"Whether Harmony Copilot is active. Only returned if the respective toggle is active."},"neural_search_catalog_inclusion":{"type":"boolean","description":"Whether Catalog inclusion for Neural Search (Harmony Search) is active."},"enable_ai_translation_course":{"type":"boolean","description":"Whether AI translation is enabled for Courses"},"enable_ai_translation_lp":{"type":"boolean","description":"Whether AI translation is enabled for LPs"},"companion_contextual_search_enabled":{"type":"boolean","description":"Whether AI Companion Contextual Search is enabled"}}},"ManageSiteBootstrapCatalogSettings":{"properties":{"catalog_type":{"type":"string","description":""},"on_catalogue_empty":{"type":"boolean","description":""},"catalog_external":{"type":"boolean","description":"Show/hide catalogue for authenticated users"},"catalog_use_categories_tree":{"type":"boolean","description":""},"show_course_details_dedicated_page":{"$ref":"#/definitions/ManageSiteBootstrapShowCourseDetailsDedicatedPage","description":""},"catalog_external_selected_catalogs":{"type":"string","description":"List of catalogues for authenticated users"},"country_default":{"type":"string","description":"the default country"},"catalog_show_alternative_learning_plans":{"type":"boolean","description":"if alternative LP should be showed"},"catalog_show_alternative_subscription_plans":{"type":"boolean","description":"if alternative subscription should be showed"},"catalog_show_buy_now":{"type":"boolean","description":"if tha buy now button should be showed"}},"required":["catalog_use_categories_tree"]},"ManageSiteBootstrapShowCourseDetailsDedicatedPage":{},"ManageSiteBootstrapDatadogRumSettings":{"properties":{"client_token":{"type":"string","description":"The RUM application ID"},"application_id":{"type":"string","description":"Datadog client token"},"site":{"type":"string","description":"The Datadog site parameter of your organization"},"service":{"type":"string","description":"The service name for your application. Follows the tag syntax requirements"},"env":{"type":"string","description":"The application’s environment"},"sample_rate":{"type":"integer","description":"The percentage of sessions to track: 100 for all, 0 for none"},"premium_sample_rate":{"type":"integer","description":"The percentage of tracked sessions with Browser Premium pricing features: 100 for all, 0 for none"},"session_replay_sample_rate":{"type":"integer","description":"The percentage of recorded sessions: 100 for all, 0 for none"},"track_interactions":{"type":"boolean","description":"Enables automatic collection of users actions"},"default_privacy_level":{"type":"string","description":"Default privacy options designed to protect end user privacy"},"track_frustrations":{"type":"boolean","description":"Enables automatic collection of user frustrations"}}},"ManageSiteBootstrapFooter":{"properties":{"footer_type":{"type":"string","description":"Footer type, possible values - &#039;show_docebo&#039;, &#039;hide_docebo&#039;, &#039;iframe&#039;, &#039;custom_text&#039;"},"iframe_height":{"type":"integer","description":"Height in px&#039;s for iframe link in the footer /0 if none/"},"iframe_url":{"type":"boolean","description":"Iframe link"},"custom_html":{"type":"boolean","description":"Custom footer html message"}}},"ManageSiteBootstrapHeaderL2":{"properties":{"iframe_active":{"type":"boolean","description":"should iframe active for header"},"iframe_url":{"type":"string","description":"url for header iframe"},"iframe_height":{"type":"integer","description":"height for the iframe in the header"},"header_message_active":{"type":"boolean","description":"should custom header message active for header"},"header_message":{"type":"string","description":"the custom header message"}}},"ManageSiteBootstrapBilling":{"properties":{"is_saas":{"type":"boolean","description":"If the LMS is SAAS"},"is_trial":{"type":"boolean","description":"If the LMS is in trial period"},"is_trial_period":{"type":"boolean","description":"Whether the platform is trial or not. It is a new parameter, the new trial and for now it will be used only on some places"},"is_trial_expired":{"type":"boolean","description":"If the trial period is expired"},"trial_remaining_days":{"type":"integer","description":"Days until trial period is valid"},"in_grace_period":{"type":"integer","description":""},"active_users":{"type":"integer","description":"Number of active users in the platform"},"bought_users":{"type":"integer","description":"Number of bought users in the platform"},"enable_user_billing":{"type":"boolean","description":"Enable option to buy more users"},"demo_platform":{"type":"boolean","description":"If it is demo platform"},"is_platform_expired":{"type":"boolean","description":"If the LMS subscription is expired"},"is_smb":{"type":"boolean","description":"for SMB company"}},"required":["is_trial_period","is_platform_expired","is_smb"]},"ManageSiteBootstrapUaMobile":{"required":["name"],"properties":{"name":{"type":"string","description":"The name of the user agent (e.g. &quot;android&quot;)"}}},"ManageSiteBootstrapPlatformUrls":{"required":["original_domain","actual_domain"],"properties":{"original_domain":{"type":"string","description":"The base url of the SaaS platform (typically *.docebosaas.com)"},"custom_domain":{"type":"string","description":"The base url of the platform as customized with the CustomDomain app. Null if the app is not installed or configured"},"actual_domain":{"type":"string","description":"The actual base url of the platform as customized with the CustomDomain and MultiDomain apps."}}},"ManageSiteBootstrapSsoProviders":{"required":["id","icon","color","title","redirect_url","should_perform_mobile_auto_login"],"properties":{"id":{"type":"string","description":"The ID of the SSO provider"},"icon":{"type":"string","description":"CSS class of font-awesome or material icon"},"color":{"type":"string","description":"Hex color for the icon and text"},"title":{"type":"string","description":"The text of the button for this sso provider"},"redirect_url":{"type":"string","description":"The absolute URL to redirect to when clicking on the button"},"behavior":{"type":"string","description":"The behavior of the provider - &#039;standard&#039; or &#039;redirect&#039; /if set/"},"should_perform_mobile_auto_login":{"type":"boolean","description":"Indicates whether the Frontend should automatically initiate the login process with the Identity Provider (IDP) instead of displaying the standard login page"}}},"ManageSiteBootstrapUserSettings":{"properties":{"timezone_allow_user_override":{"type":"boolean","description":"allow user override timezone"},"date_format":{"type":"string","description":"User date format - custom or user selected"},"user_levels":{"$ref":"#/definitions/ManageSiteBootstrapUserLevels","description":"{&quot;user_level&quot; : id_in_db} Object with key(string) value(number pairs"},"auto_calculate_password":{"type":"string","description":"For a new user, option for Automatically calculate password (on/off)"},"use_email_as_username":{"type":"string","description":"For a new user, option for Using an email as username (on/off)"},"auto_send_user_email_on_admin_creation":{"type":"string","description":"For a new user, option for Automatically send user creation email on admin creation (on/off)"},"max_delete_users":{"type":"integer","description":"Maximum number of users that can be deleted without running a background job"},"show_my_permissions_in_my_profile_for_pu":{"type":"string","description":"Allow Power Users to see My permissions tab in My Profile page"},"enable_super_pu":{"type":"string","description":"Allow Super Power Users feature"},"show_consistent_enrollment_count_for_pu":{"type":"string","description":"Allow Power Users to see the real number of enrolled users and their attendance in the course/sessions/events properties"},"disable_avatar_upload":{"type":"boolean","description":"Disable the upload of the avatar for any users. It will be returned only if the toggles &quot;toggle/social-learning/profile-image-moderation&quot; and &quot;toggle/social-learning/user-profile&quot; are enabled"}}},"ManageSiteBootstrapUserLevels":{},"ManageSiteBootstrapWsSettings":{"required":["host","port","secure"],"properties":{"host":{"type":"string","description":"Hostname to be use to establish WebSocket Connection"},"port":{"type":"string","description":"Port to be use to establish WebSocket Connection"},"secure":{"type":"boolean","description":"Whether the connection should be Secure or not"}}},"ManageSiteBootstrapEnabledFeatureToggles":{"properties":{"feature_toggle":{"type":"string","description":"the name of an enabled toggle for frontend features."}}},"ManageSiteBootstrapEnabledFlowFeatureToggles":{"properties":{"feature_toggle":{"type":"string","description":"the name of an enabled toggle for frontend features."}}},"ManageSiteBootstrapDocetConfiguration":{"properties":{"api_gateway_url":{"type":"string","description":"The url of aws api gateway"},"get_token_url":{"type":"string","description":"The url of the token url"}}},"ManageSiteBootstrapEcommerceCart":{"properties":{"history_page":{"$ref":"#/definitions/ManageSiteBootstrapHistoryPage","description":""},"subscription_page":{"$ref":"#/definitions/ManageSiteBootstrapSubscriptionPage","description":""}}},"ManageSiteBootstrapHistoryPage":{"properties":{"url":{"type":"string","description":"External url that shows the list of all the past purchases"}}},"ManageSiteBootstrapSubscriptionPage":{"properties":{"url":{"type":"string","description":"External url that shows the active subscriptions"}}},"ManageSiteBootstrapPaas":{"properties":{"notification":{"$ref":"#/definitions/ManageSiteBootstrapNotification","description":""},"sso_be":{"$ref":"#/definitions/ManageSiteBootstrapSsoBe","description":""},"user_be":{"$ref":"#/definitions/ManageSiteBootstrapUserBe","description":""}}},"ManageSiteBootstrapNotification":{"properties":{"userApiUrl":{"type":"string","description":"Base url for paas notification user api"}}},"ManageSiteBootstrapSsoBe":{"properties":{"host":{"type":"string","description":""}}},"ManageSiteBootstrapUserBe":{"properties":{"host":{"type":"string","description":""}}},"ManageSiteBootstrapMfeConfig":{"properties":{"catalog_management_host":{"type":"string","description":""}}},"ManageSiteBootstrapCommunitySettings":{"required":["community_id","is_active","is_published","is_publicly_visible"],"properties":{"community_id":{"type":"string","description":"The id fo the community associated with the current domain."},"is_active":{"type":"boolean","description":"Whether the community is active or not."},"is_published":{"type":"boolean","description":"Whether the community is published or not."},"is_publicly_visible":{"type":"boolean","description":"Whether the community&#039;s content should be accessible by anon viewers."}}},"ManageSiteBootstrapEcommerceSettings":{"properties":{"currency_configuration":{"$ref":"#/definitions/ManageSiteBootstrapCurrencyConfiguration","description":"Only when toggle release/weekly/multi-currency is ON"},"tc_configuration":{"$ref":"#/definitions/ManageSiteBootstrapTcConfiguration","description":"Training Credit feature global configuration"},"assignment_type_settings":{"$ref":"#/definitions/ManageSiteBootstrapAssignmentTypeSettings","description":"List of options for assignment type setting. It will be returned only if the toggles &quot;release/weekly/enrollment-attributes/assignment-type/api&quot; and &quot;release/weekly/enrollment-attributes/assignment-type/ui&quot; are enabled"}},"required":["tc_configuration"]},"ManageSiteBootstrapCurrencyConfiguration":{"required":["user_can_change_currency","client_configuration"],"properties":{"user_can_change_currency":{"type":"boolean","description":"Whether users can change their currency (main domain value)"},"client_configuration":{"$ref":"#/definitions/ManageSiteBootstrapClientConfiguration","description":""}}},"ManageSiteBootstrapClientConfiguration":{"required":["user_can_change_currency"],"properties":{"user_can_change_currency":{"type":"boolean","description":"Effective value for the current domain (inherits main domain if no custom ecommerce settings)"}}},"ManageSiteBootstrapTcConfiguration":{"required":["currency","decimal","symbol","show_tc_only","client_configuration"],"properties":{"currency":{"type":"string","description":"Hardcoded DTC string"},"decimal":{"type":"integer","description":"Count of decimal digits for Training Credit prices"},"symbol":{"type":"string","description":"Symbol for Training Credit currency"},"show_tc_only":{"type":"boolean","description":"When true, the LMS will only show Training Credit prices, hiding other currencies purchase options"},"client_configuration":{"$ref":"#/definitions/ManageSiteBootstrapClientConfigurationL2","description":"Training Credit feature domain specific configuration"}}},"ManageSiteBootstrapClientConfigurationL2":{"required":["symbol","show_tc_only","pack_shop_access_role"],"properties":{"symbol":{"type":"string","description":"Symbol for Training Credit currency"},"show_tc_only":{"type":"boolean","description":"When true, the LMS will only show Training Credit prices, hiding other currencies purchase options"},"pack_shop_access_role":{"type":"array","description":"List of roles that can access the training credit pack shop","items":{"$ref":"#/definitions/ManageSiteBootstrapPackShopAccessRole"}}}},"ManageSiteBootstrapPackShopAccessRole":{},"ManageSiteBootstrapAssignmentTypeSettings":{"required":["enable_for_enrollments","active_values","used_in","show_as_filter","show_in_card_details"],"properties":{"enable_for_enrollments":{"type":"boolean","description":"If the settings are enabled for enrollments"},"active_values":{"type":"array","description":"List of priorities assignable on the enrollments (1 = Mandatory, 2 = Required, 3 = Recommended, 4 = Optional)","items":{"type":"int"}},"used_in":{"type":"array","description":"The type of entity where the priorities can be assigned (1 = Courses + Learning Plans, 2 = Course, 3 = Learning Plan)","items":{"type":"int"}},"show_as_filter":{"type":"boolean","description":"Flag to set if the enrollment priorities can be seen as filters in the frontend sections"},"show_in_card_details":{"type":"boolean","description":"Flag to set if the enrollment priorities can be seen on the cards listing user enrollments (My Courses &amp; Learning Plan Page)"}}},"ManageSiteBootstrapAivc":{"required":["evaluation"],"properties":{"evaluation":{"$ref":"#/definitions/ManageSiteBootstrapEvaluation","description":"Object containing the AIVC evaluation micro-frontend URL"}}},"ManageSiteBootstrapEvaluation":{"required":["host"],"properties":{"host":{"type":"string","description":"The absolute remote AIVC evaluation micro-frontend URL (includes scheme; `https://` is prepended when config is scheme-less)"}}},"ManageSiteBootstrapAi":{"properties":{"geppetto":{"$ref":"#/definitions/ManageSiteBootstrapGeppetto","description":"Object containing URLs needed by Geppetto to work. Only returned if Harmony Search toggle is active."},"harmony":{"$ref":"#/definitions/ManageSiteBootstrapHarmony","description":"Object containing URLs needed by Harmony to work. Only returned if Harmony Copilot toggle is active."}}},"ManageSiteBootstrapGeppetto":{"required":["chat","global_search"],"properties":{"chat":{"$ref":"#/definitions/ManageSiteBootstrapChat","description":"Object containing Geppetto chat endpoint URLs"},"global_search":{"$ref":"#/definitions/ManageSiteBootstrapGlobalSearch","description":"Object containing Geppetto global search endpoint URLs"}}},"ManageSiteBootstrapChat":{"required":["auth_url","start_url","message_stream_url","chat_history"],"properties":{"auth_url":{"type":"string","description":"The endpoint URL to be used to authenticate against Geppetto"},"start_url":{"type":"string","description":"The endpoint URL to be used to start a new chat with Geppetto"},"message_stream_url":{"type":"string","description":"The endpoint URL to be used to send a message in a Geppetto chat"},"chat_history":{"type":"string","description":"The endpoint URL to be used to retrieve the messages history in a Geppetto chat"}}},"ManageSiteBootstrapGlobalSearch":{"required":["router"],"properties":{"router":{"type":"string","description":"The endpoint URL to be used to determine whether a prompt is conversational or not"}}},"ManageSiteBootstrapHarmony":{"required":["base_uri"],"properties":{"base_uri":{"type":"string","description":"The base URI for the Harmony Copilot service"}}},"ManageSiteTranslationsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageSiteTranslationsData","description":"Translation data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageSiteTranslationsLinks","description":"The API pagination links"}}},"ManageSiteTranslationsData":{"properties":{"category":{"$ref":"#/definitions/ManageSiteTranslationsCategory","description":"Translation category - will be the name of each category. a new object, containing the phrases from the custom translation will be shown for each category which has at least one such translation"},"footer":{"$ref":"#/definitions/ManageSiteTranslationsFooter","description":"Main elements of the footer"},"header":{"$ref":"#/definitions/ManageSiteTranslationsHeader","description":"Main elements of the header"}},"required":["footer","header"]},"ManageSiteTranslationsCategory":{"properties":{"phrase":{"type":"string","description":"Phrase translation - will be the name of each phrase. a new attribute, containing the translation of the phrase will be shown for each phrase that has custom translation in this category"}}},"ManageSiteTranslationsFooter":{"required":["footer_type","iframe_height","iframe_url","custom_html"],"properties":{"footer_type":{"type":"string","description":"Footer type, possible values - &#039;show_docebo&#039;, &#039;hide_docebo&#039;, &#039;iframe&#039;, &#039;custom_text&#039;"},"iframe_height":{"type":"integer","description":"Height in px&#039;s for iframe link in the footer /0 if none/"},"iframe_url":{"type":"string","description":"Iframe link"},"custom_html":{"type":"string","description":"Custom footer html message"}}},"ManageSiteTranslationsHeader":{"required":["iframe_active","iframe_url","iframe_height","header_message_active","header_message"],"properties":{"iframe_active":{"type":"boolean","description":"should iframe active for header"},"iframe_url":{"type":"string","description":"url for header iframe"},"iframe_height":{"type":"integer","description":"height for the iframe in the header"},"header_message_active":{"type":"boolean","description":"should custom header message active for header"},"header_message":{"type":"string","description":"the custom header message"}}},"ManageSiteTranslationsLinks":{"properties":{"self":{"$ref":"#/definitions/ManageSiteTranslationsSelf","description":"the object representing data from this endpoint"},"goto":{"$ref":"#/definitions/ManageSiteTranslationsGoto","description":"the object representing data for the goto page"},"first":{"$ref":"#/definitions/ManageSiteTranslationsFirst","description":"the object representing data for the first page endpoint in case of pagination"},"last":{"$ref":"#/definitions/ManageSiteTranslationsLast","description":"the object representing data for the last page endpoint in case of pagination"}}},"ManageSiteTranslationsSelf":{"properties":{"href":{"type":"string","description":"url of the endpoint"}}},"ManageSiteTranslationsGoto":{"properties":{"href":{"type":"string","description":"url of the endpoint"}}},"ManageSiteTranslationsFirst":{"properties":{"href":{"type":"string","description":"url of the endpoint"}}},"ManageSiteTranslationsLast":{"properties":{"href":{"type":"string","description":"url of the endpoint"}}},"ManageSiteTranslateSchema":{"type":"object","properties":{"lang_code":{"type":"string","description":"The language code (short version) of the language to translate to. If not provided, translates in all languages"},"phrases":{"type":"array","description":"Array of phrases to translate","items":{"$ref":"#/definitions/ManageSiteTranslatePhrases"}}},"required":["phrases"]},"ManageSiteTranslatePhrases":{"required":["phrase","category"],"properties":{"phrase":{"type":"string","description":"The language key to translate"},"category":{"type":"string","description":"The language category to use (e.g. &quot;standard&quot;)"}}},"ManageSiteTranslateResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"The array of translations (in all available languages) grouped by category and phrase","items":{"$ref":"#/definitions/ManageSiteTranslateData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageSiteTranslateData":{"required":["translations","category","phrase"],"properties":{"translations":{"type":"array","description":"Array of translations in all available languages","items":{"$ref":"#/definitions/ManageSiteTranslateTranslations"}},"category":{"type":"string","description":"Translation category"},"phrase":{"type":"string","description":"Language key"}}},"ManageSiteTranslateTranslations":{"required":["lang_code","translation"],"properties":{"lang_code":{"type":"string","description":"Short language code (e.g. en, it, fr...)"},"translation":{"type":"string","description":"Translated phrase"}}},"ManageSiteHelpDeskSchema":{"type":"object","required":["message","type"],"properties":{"message":{"type":"string","description":"Message to be send"},"type":{"type":"string","description":"ERP team type - sales/help desk"},"file":{"type":"string","description":"File to be attached to the message"},"files":{"type":"string","description":"Array of files to be attached to the message"},"subject":{"type":"string","description":"The subject of the helpdesk request"},"fields":{"type":"string","description":"Fields to be sent. For example: &quot;{&quot;&lt;field&gt;&quot;:&quot;&lt;option&gt;&quot;, ...}&quot;"}}},"ManageSiteHelpDeskResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"response","items":{"$ref":"#/definitions/ManageSiteHelpDeskData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageSiteHelpDeskData":{"required":["message","success"],"properties":{"message":{"type":"string","description":"Message of the finished job"},"success":{"type":"boolean","description":"Status of the finished job"},"zendesk_url":{"type":"string","description":"Zendesk url"}}},"ManageSiteMicroservicesResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"The array of available microservice records","items":{"$ref":"#/definitions/ManageSiteMicroservicesData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageSiteMicroservicesData":{"required":["translations","category","phrase"],"properties":{"translations":{"type":"array","description":"Array of translations in all available languages","items":{"$ref":"#/definitions/ManageSiteMicroservicesTranslations"}},"category":{"type":"string","description":"Translation category"},"phrase":{"type":"string","description":"Language key"}}},"ManageSiteMicroservicesTranslations":{"required":["lang_code","translation"],"properties":{"lang_code":{"type":"string","description":"Short language code (e.g. en, it, fr...)"},"translation":{"type":"string","description":"Translated phrase"}}},"ManageSiteGoogle-authSchema":{"type":"object","required":["id_token"],"properties":{"id_token":{"type":"string","description":"The session token issued by Google Auth APIs"},"issue_refresh_token":{"type":"boolean","description":"Whether the response should include a refresh token or not. Default = false."}}},"ManageSiteGoogle-authResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageSiteGoogle-authData","description":"Access token data"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageSiteGoogle-authData":{"required":["id_user","access_token","expires_in","token_type","scope"],"properties":{"id_user":{"type":"integer","description":"The ID of the user"},"access_token":{"type":"string","description":"Access token"},"expires_in":{"type":"integer","description":"Access token lifetime in seconds"},"token_type":{"type":"string","description":"Access token type"},"scope":{"type":"string","description":"Access token scope"},"refresh_token":{"type":"string","description":"Refresh token (if requested)"}}},"ManageSiteGetHelpdeskSettingsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageSiteGetHelpdeskSettingsData","description":"List of Help Desk settings"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageSiteGetHelpdeskSettingsData":{"required":["title","subtitle","fields","attachments_conditions"],"properties":{"title":{"type":"string","description":"Help Desk title"},"subtitle":{"type":"string","description":"Help Desk subtitle"},"fields":{"type":"array","description":"Help Desk fields","items":{"$ref":"#/definitions/ManageSiteGetHelpdeskSettingsFields"}},"attachments_conditions":{"$ref":"#/definitions/ManageSiteGetHelpdeskSettingsAttachmentsConditions","description":"Conditions for attaching files"}}},"ManageSiteGetHelpdeskSettingsFields":{"required":["key","title","type"],"properties":{"key":{"type":"string","description":"Field key"},"title":{"type":"string","description":"Field title"},"type":{"description":"Field type","enum":["dropdown","slider"],"type":"string"},"description_title":{"type":"string","description":"Field description title"},"description_text":{"type":"string","description":"Field description text"},"dependency":{"type":"string","description":"Field dependency"},"options":{"type":"array","description":"Lists all options. Mandatory if field &quot;type&quot; is &quot;dropdown&quot; or &quot;slider&quot;","items":{"$ref":"#/definitions/ManageSiteGetHelpdeskSettingsOptions"}}}},"ManageSiteGetHelpdeskSettingsOptions":{"required":["key","title"],"properties":{"key":{"type":"string","description":"Option key"},"title":{"type":"string","description":"Option title"},"description_title":{"type":"string","description":"Option description title"},"description_text":{"type":"string","description":"Option description text"},"dependency":{"type":"string","description":"Option dependency"},"articles":{"type":"array","description":"List of articles","items":{"$ref":"#/definitions/ManageSiteGetHelpdeskSettingsArticles"}}}},"ManageSiteGetHelpdeskSettingsArticles":{"required":["title","description","url"],"properties":{"title":{"type":"string","description":"Article title"},"description":{"type":"string","description":"Article title"},"url":{"type":"string","description":"Article url. Protocol at the beginning is required"}}},"ManageSiteGetHelpdeskSettingsAttachmentsConditions":{"required":["number","size","type","language"],"properties":{"number":{"type":"integer","description":"Max number of files that user can upload"},"size":{"type":"integer","description":"Max size in MB of all files that user can upload"},"type":{"type":"array","description":"List of types of files that user can upload","items":{"$ref":"#/definitions/ManageSiteGetHelpdeskSettingsType"}},"language":{"type":"string","description":"The language of the returned message (Eg. &quot;en&quot;, &quot;it&quot;, &quot;sp&quot;,...)"}}},"ManageSiteGetHelpdeskSettingsType":{},"ManageSiteEnvironmentStatusResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageSiteEnvironmentStatusData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageSiteEnvironmentStatusData":{"required":["status"],"properties":{"status":{"type":"string","description":"Environment status"},"status_code":{"type":"integer","description":"Status code"},"name":{"type":"string","description":"Server name"},"updated":{"type":"string","format":"date","description":"Last updated datetime in UTC"}}},"ManageTagsCreateSchema":{"type":"object","required":["tag"],"properties":{"tag":{"type":"string","description":"Tag name, max character length is 32"}}},"ManageTagsCreateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageTagsCreateData","description":"ID of new record"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTagsCreateData":{"required":["id","tag"],"properties":{"id":{"type":"integer","description":"Tag id created or founded in database"},"tag":{"type":"string","description":"Tag name created or founded in database"}}},"ManageTagsDeleteResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageTagsDeleteData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTagsDeleteData":{"required":["deleted_tag"],"properties":{"deleted_tag":{"type":"integer","description":"ID of the successfully deleted item"}}},"ManageTagsViewResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageTagsViewData","description":"List of all retrieved data"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTagsViewData":{"required":["items"],"properties":{"items":{"$ref":"#/definitions/ManageTagsViewItems","description":"Array of asset tags"}}},"ManageTagsViewItems":{"required":["id","tagText"],"properties":{"id":{"type":"integer","description":"ID of the tag"},"tagText":{"type":"string","description":"Tag title"}}},"ManageTagsListResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTagsListData","description":"List of all retrieved data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageTagsListLinks"}}}},"ManageTagsListData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"$ref":"#/definitions/ManageTagsListItems","description":"Array of asset tags"},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageTagsListSort"}}}},"ManageTagsListItems":{"required":["id","name"],"properties":{"id":{"type":"integer","description":"ID of the tag"},"name":{"type":"string","description":"Tag title"}}},"ManageTagsListSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageTagsListLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageTagsUpdateBlacklistSchema":{"type":"object","required":["tags"],"properties":{"tags":{"type":"array","description":"The new list of blacklisted text tags.","items":{"type":"string"}},"retroactive":{"type":"boolean","description":"If forbidden tags has to be removed from questions, LOs and assets. Default false."}}},"ManageTagsUpdateBlacklistResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTagsUpdateBlacklistData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/ManageTagsUpdateBlacklistLinks"}}}},"ManageTagsUpdateBlacklistData":{"required":["total_blacklisted_tags","total_removed_tags"],"properties":{"total_blacklisted_tags":{"type":"integer","description":"Total tags inserted in blacklist"},"total_removed_tags":{"type":"integer","description":"Total removed questions/LOs/assets tags"}}},"ManageTagsUpdateBlacklistLinks":{},"ManageTagsClearBlacklistResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTagsClearBlacklistData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/ManageTagsClearBlacklistLinks"}}}},"ManageTagsClearBlacklistData":{"required":["total_removed_tags"],"properties":{"total_removed_tags":{"type":"integer","description":"Total re-enabled tags"}}},"ManageTagsClearBlacklistLinks":{},"ManageTagsListBlacklistResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTagsListBlacklistData","description":"The updated blacklist"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/ManageTagsListBlacklistLinks"}}}},"ManageTagsListBlacklistData":{"required":["tags","has_more_data"],"properties":{"tags":{"type":"array","description":"The array that contains the list of blacklisted tags","items":{"type":"string"}},"has_more_data":{"type":"boolean","description":"true if more data are available in the next page, false otherwise"}}},"ManageTagsListBlacklistLinks":{},"ManageTermsandconditionsCreateSchema":{"type":"object","required":["tc"],"properties":{"tc":{"$ref":"#/definitions/ManageTermsandconditionsCreateTc","description":"The Terms &amp; Conditions data, e.g. &quot;tc&quot;: { &quot;tc_name&quot;: {&quot;en&quot;: &quot;Terms &amp; Conditions en name&quot;,&quot;bg&quot;: &quot;Terms &amp; Conditions bg name&quot;}, &quot;tc_acceptance_message&quot;: {&quot;en&quot;: &quot;en acceptance message&quot;},&quot;tc_body&quot;: {&quot;en&quot;: &quot;en body&quot;} }"}}},"ManageTermsandconditionsCreateTc":{"required":["tc_name","tc_acceptance_message","tc_body"],"properties":{"tc_name":{"$ref":"#/definitions/ManageTermsandconditionsCreateTcName","description":"Terms &amp; Conditions name"},"tc_acceptance_message":{"$ref":"#/definitions/ManageTermsandconditionsCreateTcAcceptanceMessage","description":"The key is language code, the value is translated Terms &amp; Conditions Acceptance Message. If provided key is &#039;all&#039; it will be considered as translation for all active languages"},"tc_body":{"$ref":"#/definitions/ManageTermsandconditionsCreateTcBody","description":"The key is language code, the value is translated Terms &amp; Conditions Body. If provided key is &#039;all&#039; it will be considered as translation for all active languages"}}},"ManageTermsandconditionsCreateTcName":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation e.g. - tc_name: {&quot;en&quot;: &quot;English Terms &amp; Conditions name&quot;}. Required only in the default language."}}},"ManageTermsandconditionsCreateTcAcceptanceMessage":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation e.g. - tc_acceptance_message: {&quot;en&quot;: &quot;English Terms &amp; Conditions acceptance message&quot;}. Required only in the default language."}}},"ManageTermsandconditionsCreateTcBody":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation e.g. - tc_body: {&quot;en&quot;: &quot;English Terms &amp; Conditions body&quot;}. Required only in the default language."}}},"ManageTermsandconditionsCreateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsCreateData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTermsandconditionsCreateData":{"required":["success","tc_id"],"properties":{"success":{"type":"boolean","description":"Is operation successful"},"tc_id":{"type":"integer","description":"Newly created Terms &amp; Conditions ID"}}},"ManageTermsandconditionsDeleteResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsDeleteData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTermsandconditionsDeleteData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Is operation successful"}}},"ManageTermsandconditionsIndexResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsIndexData","description":"Array of T&amp;C records"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageTermsandconditionsIndexLinks"}}}},"ManageTermsandconditionsIndexData":{"properties":{"items":{"type":"array","description":"A single T&amp;C record","items":{"$ref":"#/definitions/ManageTermsandconditionsIndexItems"}}}},"ManageTermsandconditionsIndexItems":{"required":["id","name","default","multidomains","last_updated","version","actions"],"properties":{"id":{"type":"integer","description":"The ID of the T&amp;C record"},"name":{"type":"string","description":"The name of the T&amp;C record"},"default":{"type":"boolean","description":"Is this T&amp;C record the default one"},"multidomains":{"type":"string","description":"Number of the domains the T&amp;C record is assigned to"},"last_updated":{"type":"string","format":"date","description":"The last updated date of the T&amp;C record"},"version":{"type":"integer","description":"The version of the T&amp;C record"},"actions":{"type":"array","description":"List of actions: edit|delete","items":{"$ref":"#/definitions/ManageTermsandconditionsIndexActions"}}}},"ManageTermsandconditionsIndexActions":{"required":["action"],"properties":{"action":{"type":"string","description":"Action name"}}},"ManageTermsandconditionsIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageTermsandconditionsUpdateSchema":{"type":"object","required":["tc"],"properties":{"tc":{"$ref":"#/definitions/ManageTermsandconditionsUpdateTc","description":"The Terms &amp; Conditions data, e.g. &quot;tc&quot;: { &quot;tc_name&quot;: {&quot;en&quot;: &quot;T&amp;C en name&quot;,&quot;bg&quot;: &quot;T&amp;C bg name&quot;}, &quot;tc_acceptance_message&quot;: {&quot;en&quot;: &quot;en acceptance message&quot;},&quot;tc_body&quot;: {&quot;en&quot;: &quot;en body&quot;} }"},"check_only_is_new_version":{"type":"boolean","description":"If this parameter is provided API just will check if it&#039;s new version or just update of the name BUT nothing will be changed"}}},"ManageTermsandconditionsUpdateTc":{"required":["tc_name","tc_acceptance_message","tc_body"],"properties":{"tc_name":{"$ref":"#/definitions/ManageTermsandconditionsUpdateTcName","description":"The key is language code, the value is translated T&amp;C Name. If provided key is &#039;all&#039; it will be considered as translation for all active languages"},"tc_acceptance_message":{"$ref":"#/definitions/ManageTermsandconditionsUpdateTcAcceptanceMessage","description":"The key is language code, the value is translated T&amp;C Acceptance Message. If provided key is &#039;all&#039; it will be considered as translation for all active languages"},"tc_body":{"$ref":"#/definitions/ManageTermsandconditionsUpdateTcBody","description":"The key is language code, the value is translated T&amp;C Body. If provided key is &#039;all&#039; it will be considered as translation for all active languages"}}},"ManageTermsandconditionsUpdateTcName":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation e.g. - tc_name: {&quot;en&quot;: &quot;English T&amp;C name&quot;}. Required only in the default language."}}},"ManageTermsandconditionsUpdateTcAcceptanceMessage":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation e.g. - tc_acceptance_message: {&quot;en&quot;: &quot;English T&amp;C acceptance message&quot;}. Required only in the default language."}}},"ManageTermsandconditionsUpdateTcBody":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation e.g. - tc_body: {&quot;en&quot;: &quot;English T&amp;C body&quot;}. Required only in the default language."}}},"ManageTermsandconditionsUpdateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsUpdateData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTermsandconditionsUpdateData":{"required":["success","tc_id","action"],"properties":{"success":{"type":"boolean","description":"Is operation successful"},"tc_id":{"type":"integer","description":"New created or updated Terms &amp; Conditions record ID"},"action":{"type":"string","description":"It shows if new version is created or updated existing one. Options: &#039;create_new_version&#039; and &#039;update&#039;"}}},"ManageTermsandconditionsAssignSchema":{"type":"object","required":["multidomain_ids"],"properties":{"multidomain_ids":{"type":"array","description":"Array of multi domains Ids","items":{"type":"integer"}}}},"ManageTermsandconditionsAssignResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsAssignData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTermsandconditionsAssignData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Is operation successful"}}},"ManageTermsandconditionsTrackSchema":{"type":"object","required":["tc"],"properties":{"tc":{"$ref":"#/definitions/ManageTermsandconditionsTrackTc","description":"The T&amp;C record data, e.g. &quot;tc&quot;: { &quot;tc&quot;: { &quot;id&quot;: 37,&quot;answer&quot;: 1} }"},"client_id":{"type":"integer","description":"The ID of the multidomain client."}}},"ManageTermsandconditionsTrackTc":{"required":["id","answer"],"properties":{"id":{"type":"integer","description":"T&amp;C record ID"},"answer":{"type":"integer","description":"Answer. Options 1 - accept, 0 - not accept"}}},"ManageTermsandconditionsTrackResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsTrackData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTermsandconditionsTrackData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Is operation successful"}}},"ManageTermsandconditionsLastVersionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsLastVersionData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTermsandconditionsLastVersionData":{"required":["tc"],"properties":{"tc":{"$ref":"#/definitions/ManageTermsandconditionsLastVersionTc","description":"T&amp;C record info"}}},"ManageTermsandconditionsLastVersionTc":{"required":["tc_id","default_tc","tc_name","tc_acceptance_message","tc_body","tc_created_timestamp","tc_version","creator_username","creator_name","creator_initials","creator_avatar"],"properties":{"tc_id":{"type":"integer","description":"The ID of the T&amp;C record"},"default_tc":{"type":"boolean","description":"Is it the default T&amp;C record"},"tc_name":{"$ref":"#/definitions/ManageTermsandconditionsLastVersionTcName","description":"The name of the terms and conditions record for all languages"},"tc_acceptance_message":{"$ref":"#/definitions/ManageTermsandconditionsLastVersionTcAcceptanceMessage","description":"The acceptance message of the terms and conditions record for all languages"},"tc_body":{"$ref":"#/definitions/ManageTermsandconditionsLastVersionTcBody","description":"The body of the terms and conditions record for all languages"},"tc_created_timestamp":{"type":"string","format":"date","description":"The created date of the terms and conditions record, formatted as &quot;yyyy-mm-dd hh:mm:ss&quot;, UTC timezone"},"tc_version":{"type":"integer","description":"The version of the terms and conditions record"},"creator_username":{"type":"string","description":"The username of creator of terms and conditions record"},"creator_name":{"type":"string","description":"The first and last name of creator, if they didn&#039;t exist set username."},"creator_initials":{"type":"string","description":"The first letters of first and last name of a creator."},"creator_avatar":{"type":"string","description":"The avatar of the creator of the terms and conditions record, image url."}}},"ManageTermsandconditionsLastVersionTcName":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManageTermsandconditionsLastVersionTcAcceptanceMessage":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManageTermsandconditionsLastVersionTcBody":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManageTermsandconditionsGetVersionsResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsGetVersionsData","description":"Array of a T&amp;C record and versions data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageTermsandconditionsGetVersionsLinks"}}}},"ManageTermsandconditionsGetVersionsData":{"required":["id","name","default","versions"],"properties":{"id":{"type":"integer","description":"The ID of the T&amp;C record"},"name":{"$ref":"#/definitions/ManageTermsandconditionsGetVersionsName","description":"The name of the T&amp;C record"},"default":{"type":"boolean","description":"Is the T&amp;C record the default one"},"versions":{"$ref":"#/definitions/ManageTermsandconditionsGetVersionsVersions","description":"Array of the version objects of the T&amp;C record"}}},"ManageTermsandconditionsGetVersionsName":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManageTermsandconditionsGetVersionsVersions":{"required":["id","acceptance_message","body","version","creator","creation_date","creator_username","creator_first_name","creator_last_name","creator_avatar"],"properties":{"id":{"type":"integer","description":"Version ID"},"acceptance_message":{"$ref":"#/definitions/ManageTermsandconditionsGetVersionsAcceptanceMessage","description":"The key is language code, the value is translated T&amp;C Acceptance Message."},"body":{"$ref":"#/definitions/ManageTermsandconditionsGetVersionsBody","description":"The key is language code, the value is translated T&amp;C Body."},"version":{"type":"string","description":"The T&amp;C version"},"creator":{"type":"string","description":"ID of the user that created this version"},"creation_date":{"type":"string","format":"date","description":"The created date of the T&amp;C record, formatted as &quot;yyyy-mm-dd hh:mm:ss&quot;, UTC timezone"},"creator_username":{"type":"string","description":"The username of the user that created this version"},"creator_first_name":{"type":"string","description":"The first name of the user that created this version"},"creator_last_name":{"type":"string","description":"The last name of the user that created this version"},"creator_avatar":{"type":"string","description":"The avatar of the user that created this version"}}},"ManageTermsandconditionsGetVersionsAcceptanceMessage":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManageTermsandconditionsGetVersionsBody":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManageTermsandconditionsGetVersionsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageTermsandconditionsUnassignSchema":{"type":"object","required":["multidomain_ids"],"properties":{"multidomain_ids":{"type":"array","description":"Array of multidomains IDs","items":{"type":"integer"}}}},"ManageTermsandconditionsUnassignResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsUnassignData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTermsandconditionsUnassignData":{"required":["success","updated_rows"],"properties":{"success":{"type":"boolean","description":"Is operation successful"},"updated_rows":{"type":"integer","description":"The number of successfully updated rows"},"warnings":{"$ref":"#/definitions/ManageTermsandconditionsUnassignWarnings","description":"The number of successfully updated rows"}}},"ManageTermsandconditionsUnassignWarnings":{"required":["invalid_miltidmains"],"properties":{"invalid_miltidmains":{"$ref":"#/definitions/ManageTermsandconditionsUnassignInvalidMiltidmains","description":"Invalid miltidmains"}}},"ManageTermsandconditionsUnassignInvalidMiltidmains":{"required":["ids","message"],"properties":{"ids":{"type":"array","description":"The IDs of invalid miltidmains","items":{"type":"integer"}},"message":{"type":"string","description":"A relevant message of error is returned"}}},"ManageTermsandconditionsAssignListResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsAssignListData","description":"Array of T&amp;C records"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageTermsandconditionsAssignListLinks"}}}},"ManageTermsandconditionsAssignListData":{"properties":{"items":{"type":"array","description":"A single T&amp;C record","items":{"$ref":"#/definitions/ManageTermsandconditionsAssignListItems"}}}},"ManageTermsandconditionsAssignListItems":{"required":["id","name","domain_name","tc_associated_date"],"properties":{"id":{"type":"string","description":"The ID of the T&amp;C record"},"name":{"type":"string","description":"The name of the domain"},"domain_name":{"type":"string","description":"Domain name"},"tc_associated_date":{"type":"string","description":"Date when the T&amp;C record was associated to a domain"}}},"ManageTermsandconditionsAssignListLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageTermsandconditionsClientsResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsClientsData","description":"Array of clients"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageTermsandconditionsClientsLinks"}}}},"ManageTermsandconditionsClientsData":{"properties":{"items":{"type":"array","description":"List of terms and conditions records","items":{"$ref":"#/definitions/ManageTermsandconditionsClientsItems"}}}},"ManageTermsandconditionsClientsItems":{"required":["id","name","domain","tc_id","tc_name","is_assigned","date_assign"],"properties":{"id":{"type":"integer","description":"The ID of the client"},"name":{"type":"string","description":"The name of the client"},"domain":{"type":"string","description":"The domain name of the client"},"tc_id":{"type":"string","description":"The id of the assigned terms and conditions"},"tc_name":{"type":"string","description":"The name of the assigned terms and conditions"},"is_assigned":{"type":"boolean","description":"Is the client already assigned to the requested terms and conditions record"},"date_assign":{"type":"string","description":"The date of assignment"}}},"ManageTermsandconditionsClientsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageTermsandconditionsViewTrackResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsViewTrackData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTermsandconditionsViewTrackData":{"required":["tc"],"properties":{"tc":{"$ref":"#/definitions/ManageTermsandconditionsViewTrackTc","description":"T&amp;C info"}}},"ManageTermsandconditionsViewTrackTc":{"required":["track_id","answer","tc_id","id_tc_version","default_tc","tc_name","tc_acceptance_message","tc_body","tc_created_timestamp","tc_version"],"properties":{"track_id":{"type":"integer","description":"The ID of tracking"},"answer":{"type":"boolean","description":"Are the T&amp;C accepted"},"tc_id":{"type":"integer","description":"The ID of the T&amp;C record"},"id_tc_version":{"type":"integer","description":"The ID of T&amp;C record version"},"default_tc":{"type":"boolean","description":"Is the T&amp;C record the default one"},"tc_name":{"$ref":"#/definitions/ManageTermsandconditionsViewTrackTcName","description":"The name of the T&amp;C record of all languages"},"tc_acceptance_message":{"$ref":"#/definitions/ManageTermsandconditionsViewTrackTcAcceptanceMessage","description":"The acceptance message of the T&amp;C of all languages"},"tc_body":{"$ref":"#/definitions/ManageTermsandconditionsViewTrackTcBody","description":"The body of the T&amp;C of all languages"},"tc_created_timestamp":{"type":"string","format":"date","description":"The created date of the T&amp;C"},"tc_version":{"type":"integer","description":"The version of the T&amp;C"}}},"ManageTermsandconditionsViewTrackTcName":{"properties":{"en":{"type":"string","description":"Language key and translation e.g. - tc_name: {&quot;en&quot;: &quot;English T&amp;C name&quot;}"}}},"ManageTermsandconditionsViewTrackTcAcceptanceMessage":{"properties":{"en":{"type":"string","description":"Language key and translation e.g. - tc_acceptance_message: {&quot;en&quot;: &quot;English T&amp;C acceptance message&quot;}"}}},"ManageTermsandconditionsViewTrackTcBody":{"properties":{"en":{"type":"string","description":"Language key and translation e.g. - tc_body: {&quot;en&quot;: &quot;English T&amp;C body&quot;}"}}},"ManageTermsandconditionsUpdateTrackSchema":{"type":"object","required":["id_tc_version","track_answer"],"properties":{"id_tc_version":{"type":"integer","description":"Id of last T&amp;C version"},"track_answer":{"type":"integer","description":"Answer for T&amp;C (0 - not agree, 1 - agree)"}}},"ManageTermsandconditionsUpdateTrackResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure to update tracking with error messages (optional)","items":{"$ref":"#/definitions/ManageTermsandconditionsUpdateTrackData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTermsandconditionsUpdateTrackData":{"required":["success","message"],"properties":{"success":{"type":"boolean","description":"Success or failure to update tracking"},"logout":{"type":"boolean","description":"Log out the user from the system or not"},"message":{"type":"string","description":"Error message"}}},"ManageTermsandconditionsGetLastTcByDomainResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsGetLastTcByDomainData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTermsandconditionsGetLastTcByDomainData":{"required":["tc_id"],"properties":{"tc_id":{"type":"integer","description":"The ID of the terms and conditions record"}}},"ManageTermsandconditionsCheckAcceptanceResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsCheckAcceptanceData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTermsandconditionsCheckAcceptanceData":{"required":["termsandconditions"],"properties":{"termsandconditions":{"$ref":"#/definitions/ManageTermsandconditionsCheckAcceptanceTermsandconditions","description":"False if no need to accept the terms and conditions, otherwise the terms and conditions object"}}},"ManageTermsandconditionsCheckAcceptanceTermsandconditions":{"required":["tc_id","default_tc","tc_name","tc_acceptance_message","tc_body","tc_version","tc_created_timestamp","creator_username","creator_name","creator_initials","creator_avatar"],"properties":{"tc_id":{"type":"integer","description":"The ID of the terms and conditions"},"default_tc":{"type":"integer","description":"Is default Terms &amp; Conditions. Options: 0, 1"},"tc_name":{"$ref":"#/definitions/ManageTermsandconditionsCheckAcceptanceTcName","description":"Terms &amp; Conditions name"},"tc_acceptance_message":{"$ref":"#/definitions/ManageTermsandconditionsCheckAcceptanceTcAcceptanceMessage","description":"The key is language code, the value is translated Terms &amp; Conditions Acceptance Message."},"tc_body":{"$ref":"#/definitions/ManageTermsandconditionsCheckAcceptanceTcBody","description":"The key is language code, the value is translated Terms &amp; Conditions Body."},"tc_version":{"type":"integer","description":"The Terms &amp; Conditions version"},"tc_created_timestamp":{"type":"string","format":"date","description":"The created date of the terms and conditions, formatted as &quot;yyyy-mm-dd hh:mm:ss&quot;, UTC timezone"},"creator_username":{"type":"string","description":"The username of creator of terms and conditions"},"creator_name":{"type":"string","description":"The first and last name of creator, if they didn&#039;t exist set username."},"creator_initials":{"type":"string","description":"The first letters of first and last name of a creator."},"creator_avatar":{"type":"string","description":"The avatar of the creator of the terms and conditions, image url."}}},"ManageTermsandconditionsCheckAcceptanceTcName":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManageTermsandconditionsCheckAcceptanceTcAcceptanceMessage":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManageTermsandconditionsCheckAcceptanceTcBody":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManageTermsandconditionsGetDefaultResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageTermsandconditionsGetDefaultData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageTermsandconditionsGetDefaultData":{"required":["tc"],"properties":{"tc":{"$ref":"#/definitions/ManageTermsandconditionsGetDefaultTc","description":"T&amp;C record info"}}},"ManageTermsandconditionsGetDefaultTc":{"required":["tc_id","tc_name","tc_acceptance_message","tc_body","tc_created_timestamp","tc_version","creator_username","creator_name","creator_initials","creator_avatar"],"properties":{"tc_id":{"type":"integer","description":"The ID of the T&amp;C record"},"tc_name":{"$ref":"#/definitions/ManageTermsandconditionsGetDefaultTcName","description":"The name of the terms and conditions record for all languages"},"tc_acceptance_message":{"$ref":"#/definitions/ManageTermsandconditionsGetDefaultTcAcceptanceMessage","description":"The acceptance message of the terms and conditions record for all languages"},"tc_body":{"$ref":"#/definitions/ManageTermsandconditionsGetDefaultTcBody","description":"The body of the terms and conditions record for all languages"},"tc_created_timestamp":{"type":"string","format":"date","description":"The created date of the terms and conditions record, formatted as &quot;yyyy-mm-dd hh:mm:ss&quot;, UTC timezone"},"tc_version":{"type":"integer","description":"The version of the terms and conditions record"},"creator_username":{"type":"string","description":"The username of creator of terms and conditions record"},"creator_name":{"type":"string","description":"The first and last name of creator, if they didn&#039;t exist set username."},"creator_initials":{"type":"string","description":"The first letters of first and last name of a creator."},"creator_avatar":{"type":"string","description":"The avatar of the creator of the terms and conditions record, image url."}}},"ManageTermsandconditionsGetDefaultTcName":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManageTermsandconditionsGetDefaultTcAcceptanceMessage":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManageTermsandconditionsGetDefaultTcBody":{"required":["xx"],"properties":{"xx":{"type":"string","description":"The key XX is the language code and the value is the translation."}}},"ManageThemeIndexResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"List of all retrieved data","items":{"$ref":"#/definitions/ManageThemeIndexData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageThemeIndexData":{"required":["theme"],"properties":{"theme":{"$ref":"#/definitions/ManageThemeIndexTheme","description":"Object containing the theme metadata"}}},"ManageThemeIndexTheme":{"required":["code","author_id","date_created","name","slug_name","image","description","builtin","status"],"properties":{"code":{"type":"string","description":"Text identifier of the theme"},"author_id":{"type":"integer","description":"Identifier of the user who created that theme. Zero if the theme is built-in"},"date_created":{"type":"string","format":"date","description":"Date of the theme creation"},"name":{"type":"string","description":"Display name of the theme"},"slug_name":{"type":"string","description":"Name of the theme without special characters"},"image":{"type":"string","description":"Url pointing to the theme thumbnail image"},"description":{"type":"string","description":"Text description of the theme"},"builtin":{"type":"boolean","description":"Indicates whether or not the theme is built-in"},"status":{"description":"Status of the theme for the current calling context","enum":["available","active"],"type":"string"}}},"ManageThemeUpdateSchema":{"type":"object","properties":{"name":{"type":"string","description":"name (string, required): Theme name (e.g. &quot;Docebo 6.9&quot;, &quot;Docebo 7.0&quot;)."},"image":{"type":"string","description":"S3 URL of the theme cover image."},"description":{"type":"string","description":"Extended description of the theme."},"settings":{"type":"string","description":"A JSON object containing one or more configuration sets indexed by set identifier (e.g. header, colors...). Example: {header: {logo: &lt;logo_url&gt;, title: &lt;title&gt;..}, styles: {..}}"}}},"ManageThemeUpdateResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Information about the theme variant that was updated","items":{"$ref":"#/definitions/ManageThemeUpdateData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageThemeUpdateData":{"required":["theme_variant"],"properties":{"theme_variant":{"$ref":"#/definitions/ManageThemeUpdateThemeVariant","description":"Object containing the theme metadata"}}},"ManageThemeUpdateThemeVariant":{"required":["id_multidomain","author_id","date_created","name","image","description","builtin","settings","code","slug_name","status"],"properties":{"id_multidomain":{"type":"integer","description":"Identifier of the multidomain for which this theme variant is used. Zero if this variant is used for the base domain"},"author_id":{"type":"integer","description":"Identifier of the user who created that theme. Zero if the theme is built-in"},"date_created":{"type":"string","format":"date","description":"Date of the theme creation"},"name":{"type":"string","description":"Display name of the theme"},"image":{"type":"string","description":"Filename of the theme thumbnail image"},"description":{"type":"string","description":"Text description of the theme"},"builtin":{"type":"boolean","description":"Indicates whether or not the theme is built-in"},"settings":{"type":"Object","description":"Object containing all configuration information for this variant. All attributes of the settings object represent values for a configuration set used in that theme"},"code":{"type":"string","description":"Text identifier of the theme"},"slug_name":{"type":"string","description":"Name of the theme without special characters"},"status":{"description":"Status of the theme for the current calling context","enum":["available","active"],"type":"string"}}},"ManageThemeViewResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Information about the theme","items":{"$ref":"#/definitions/ManageThemeViewData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageThemeViewData":{"required":["theme","variants"],"properties":{"theme":{"$ref":"#/definitions/ManageThemeViewTheme","description":"Object containing the theme metadata"},"variants":{"type":"array","description":"Varianrt of the theme for each multidomain. This arrays should contain at least one variant for the base domain","items":{"$ref":"#/definitions/ManageThemeViewVariants"}}}},"ManageThemeViewTheme":{"required":["code","author_id","date_created","name","slug_name","image","description","builtin","status","sets"],"properties":{"code":{"type":"string","description":"Text identifier of the theme"},"author_id":{"type":"integer","description":"Identifier of the user who created that theme. Zero if the theme is built-in"},"date_created":{"type":"string","format":"date","description":"Date of the theme creation"},"name":{"type":"string","description":"Display name of the theme"},"slug_name":{"type":"string","description":"Name of the theme without special characters"},"image":{"type":"string","description":"Filename of the theme thumbnail image"},"description":{"type":"string","description":"Text description of the theme"},"builtin":{"type":"boolean","description":"Indicates whether or not the theme is built-in"},"status":{"description":"Status of the theme for the current calling context","enum":["available","active"],"type":"string"},"sets":{"type":"array","description":"Configuration sets used in this theme","items":{"$ref":"#/definitions/ManageThemeViewSets"}}}},"ManageThemeViewSets":{"required":["theme_variant","id","name","description"],"properties":{"theme_variant":{"type":"Object","description":"Object representing data for a theme configuration set"},"id":{"type":"string","description":"Text identifier of the configuration set"},"name":{"type":"string","description":"Name of the configuration set"},"description":{"type":"string","description":"text description of the configuration set"}}},"ManageThemeViewVariants":{"required":["variant","id_multidomain","settings","used_for_current_multidomain"],"properties":{"variant":{"type":"Object","description":"An object representing a theme variant"},"id_multidomain":{"type":"integer","description":"Identifier of the multidomain for which this theme variant is used. Zero if this variant is used for the base domain"},"settings":{"type":"Object","description":"Object containing all configuration information for this variant. All attributes of the settings object represent values for a configuration set used in that theme"},"used_for_current_multidomain":{"type":"boolean","description":"Indicates whether or not this theme variant is applicable for the API caller&#039;s multidomain context. This does not mean that the variant is active for the caller&#039;s multidomain"}}},"ManageThemeUpdateVariantSchema":{"type":"object","properties":{"name":{"type":"string","description":"name (string, required): Theme name for the given multidomain (e.g. &quot;Docebo 6.9&quot;, &quot;Docebo 7.0&quot;)."},"image":{"type":"string","description":"S3 URL of the theme cover image for the given multidomain."},"description":{"type":"string","description":"Extended description of the theme."},"settings":{"type":"string","description":"A JSON object containing one or more configuration sets indexed by set identifier (e.g. header, colors...). Example: {header: {logo: &lt;logo_url&gt;, title: &lt;title&gt;..}, styles: {..}}"}}},"ManageThemeUpdateVariantResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Information about the theme variant that was updated or created","items":{"$ref":"#/definitions/ManageThemeUpdateVariantData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageThemeUpdateVariantData":{"required":["theme_variant"],"properties":{"theme_variant":{"$ref":"#/definitions/ManageThemeUpdateVariantThemeVariant","description":"Object containing the theme metadata"}}},"ManageThemeUpdateVariantThemeVariant":{"required":["id_multidomain","settings","builtin","author_id","date_created","name","image","description","code","slug_name","status"],"properties":{"id_multidomain":{"type":"integer","description":"Identifier of the multidomain for which this theme variant is used. Zero if this variant is used for the base domain"},"settings":{"type":"Object","description":"Object containing all configuration information for this variant. All attributes of the settings object represent values for a configuration set used in that theme"},"builtin":{"type":"boolean","description":"Indicates whether or not the theme is built-in"},"author_id":{"type":"integer","description":"Identifier of the user who created that theme. Zero if the theme is built-in"},"date_created":{"type":"string","format":"date","description":"Date of the theme creation"},"name":{"type":"string","description":"Display name of the theme"},"image":{"type":"string","description":"Filename of the theme thumbnail image"},"description":{"type":"string","description":"Text description of the theme"},"code":{"type":"string","description":"Text identifier of the theme"},"slug_name":{"type":"string","description":"Name of the theme without special characters"},"status":{"description":"Status of the theme for the current calling context","enum":["available","active"],"type":"string"}}},"ManageTrailsIndexResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTrailsIndexData","description":"List of all retrieved trail logs"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageTrailsIndexLinks"}}}},"ManageTrailsIndexData":{"required":["items"],"properties":{"items":{"$ref":"#/definitions/ManageTrailsIndexItems","description":"Array of trail log objects"}}},"ManageTrailsIndexItems":{"required":["trail_id","actor_id_user","actor_ip_address","event_name","timestamp","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"trail_id":{"type":"integer","description":"The internal unique ID of the audit trail record"},"actor_id_user":{"type":"integer","description":"The internal unique ID of the audit trail record"},"actor_ip_address":{"type":"string","description":"The Internet Protocol (IP) address of the user whose activity has been logged"},"event_name":{"type":"string","description":"The name of the event that has been logged"},"target_id_user":{"type":"integer","description":"The internal unique ID of the user that was subject of the event. Returned only if not null"},"target_id_course":{"type":"integer","description":"The internal unique ID of the course that was subject of the event. Returned only if not null"},"target_id_entity":{"type":"integer","description":"The internal unique ID of the entity (different from courses or users) that was subject of the event. Returned only if not null"},"timestamp":{"type":"string","format":"date","description":"The timestamp of the event in the format &quot;yyyy-MM-dd HH:mm:ss&quot;, UTC timezone."},"json_data":{"$ref":"#/definitions/ManageTrailsIndexJsonData","description":"The json object that contains the highest level of detail of data recorded in the audit trail for the event returned by the query"},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 1 (starting from Feb 20th 2018, the default will change to 0)"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items returned. Returned if get_total_count parameter is 1"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageTrailsIndexSort"}}}},"ManageTrailsIndexJsonData":{},"ManageTrailsIndexSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending, default is Desc"}}},"ManageTrailsIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageTwofactorauthGetSecretsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTwofactorauthGetSecretsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageTwofactorauthGetSecretsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageTwofactorauthGetSecretsData":{"required":["secret","qr_code_uri"],"properties":{"secret":{"type":"string","description":"The secret key"},"qr_code_uri":{"type":"string","description":"QR code uri"}}},"ManageTwofactorauthGetSecretsLinks":{},"ManageTwofactorauthPairingsSchema":{"type":"object","required":["otp"],"properties":{"otp":{"type":"string","description":"One-time password (both string and integer types are allowed)"}}},"ManageTwofactorauthPairingsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTwofactorauthPairingsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageTwofactorauthPairingsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageTwofactorauthPairingsData":{"required":["recovery_code"],"properties":{"recovery_code":{"type":"string","description":"Recovery code"}}},"ManageTwofactorauthPairingsLinks":{},"ManageTwofactorauthEmailsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTwofactorauthEmailsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageTwofactorauthEmailsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageTwofactorauthEmailsData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Operation status"}}},"ManageTwofactorauthEmailsLinks":{},"ManageTwofactorauthRegenerateRecoveryCodesSchema":{"type":"object","required":["otp"],"properties":{"otp":{"type":"string","description":"One-time password (both string and integer types are allowed)"}}},"ManageTwofactorauthRegenerateRecoveryCodesResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTwofactorauthRegenerateRecoveryCodesData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageTwofactorauthRegenerateRecoveryCodesLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageTwofactorauthRegenerateRecoveryCodesData":{"required":["recovery_code"],"properties":{"recovery_code":{"type":"string","description":"Recovery code"}}},"ManageTwofactorauthRegenerateRecoveryCodesLinks":{},"ManageTwofactorauthVerificationsSchema":{"type":"object","required":["identifier","otp"],"properties":{"identifier":{"description":"The identifier for the authentication process","enum":["email","authenticatorapp"],"type":"string"},"otp":{"type":"string","description":"One-time password (both string and integer types are allowed)"}}},"ManageTwofactorauthVerificationsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTwofactorauthVerificationsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageTwofactorauthVerificationsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageTwofactorauthVerificationsData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"}}},"ManageTwofactorauthVerificationsLinks":{},"ManageTwofactorauthDeletePairingSchema":{"type":"object","required":["identifier"],"properties":{"identifier":{"description":"E-Signature auth type","enum":["email","authenticatorapp"],"type":"string"}}},"ManageTwofactorauthVerifyRecoveryCodesSchema":{"type":"object","required":["recovery_code"],"properties":{"recovery_code":{"type":"string","description":"Recovery code"}}},"ManageTwofactorauthVerifyRecoveryCodesResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageTwofactorauthVerifyRecoveryCodesData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageTwofactorauthVerifyRecoveryCodesLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageTwofactorauthVerifyRecoveryCodesData":{"required":["recovery_code"],"properties":{"recovery_code":{"type":"string","description":"Recovery code"}}},"ManageTwofactorauthVerifyRecoveryCodesLinks":{},"ManageTwofactorauthDeleteUserPairingSchema":{"type":"object","required":["identifier"],"properties":{"identifier":{"description":"E-Signature auth type","enum":["email","authenticatorapp"],"type":"string"},"recovery_code":{"type":"string","description":"Recovery code with length of 16 symbols(digits/letters), required when identifier is authenticatorapp"}}},"ManageUnsplashIndexResponse":{"required":["data","version","extra_data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUnsplashIndexData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"$ref":"#/definitions/ManageUnsplashIndexExtraData","description":"API extra data"},"_links":{"$ref":"#/definitions/ManageUnsplashIndexLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageUnsplashIndexData":{"required":["data"],"properties":{"data":{"type":"array","description":"List of photos from Unsplash","items":{"$ref":"#/definitions/ManageUnsplashIndexDataL2"}}}},"ManageUnsplashIndexDataL2":{"required":["id","description","width","height","urls","photographer","photographer_profile_url"],"properties":{"id":{"type":"string","description":"Generated ID of the photo from Unsplash"},"description":{"type":"string","description":"Description of the photo"},"width":{"type":"integer","description":"Width of the photo (in pixels)"},"height":{"type":"integer","description":"Height of the photo (in pixels)"},"urls":{"$ref":"#/definitions/ManageUnsplashIndexUrls","description":"A collection of URLs, as returned by the Unsplash API"},"photographer":{"type":"string","description":"The name of the photographer"},"photographer_profile_url":{"type":"string","description":"The profile page of the photographer"}}},"ManageUnsplashIndexUrls":{"required":["embed_url","thumbnail_url","download_url"],"properties":{"embed_url":{"type":"string","description":"A link that allows the user to embed this URL in his application"},"thumbnail_url":{"type":"string","description":"A link to the thumbnail URL of the photo"},"download_url":{"type":"string","description":"A link that allows the user to download the image"}}},"ManageUnsplashIndexExtraData":{"required":["total_count","total_page_count"],"properties":{"total_count":{"type":"integer","description":"Total count of the found photos"},"total_page_count":{"type":"integer","description":"Total page count of the found photos"}}},"ManageUnsplashIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/ManageUnsplashIndexSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ManageUnsplashIndexGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ManageUnsplashIndexFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ManageUnsplashIndexLast","description":"Link to the last page"}}},"ManageUnsplashIndexSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"ManageUnsplashIndexGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"ManageUnsplashIndexFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"ManageUnsplashIndexLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"ManageUnsplashFetchSchema":{"type":"object","properties":{"collection":{"description":"The S3 folder where to store the copied file. Default is `assets`","enum":["assets"],"type":"string"},"asset_type":{"description":"Defined the context/repo under which the fetched image will be used. Default is `courselogo`","enum":["courselogo","playerbg","loginbg","badges","rewards","app7020","api_icon"],"type":"string"}}},"ManageUnsplashFetchResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUnsplashFetchData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageUnsplashFetchLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageUnsplashFetchData":{"required":["name","url","id"],"properties":{"name":{"type":"string","description":"A slugified version of the description from Unsplash, appended with &quot;.jpg"},"url":{"type":"string","description":"The full S3 URL to the copy of the file (fetched from Unsplash and uploaded to S3)"},"id":{"type":"integer","description":"The ID of the image, as identified by one core_asset DB table"}}},"ManageUnsplashFetchLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/ManageUnsplashFetchSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ManageUnsplashFetchGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ManageUnsplashFetchFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ManageUnsplashFetchLast","description":"Link to the last page"}}},"ManageUnsplashFetchSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"ManageUnsplashFetchGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"ManageUnsplashFetchFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"ManageUnsplashFetchLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"ManageUploadPresignedUrlResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUploadPresignedUrlData","description":"Result of the process"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUploadPresignedUrlData":{"required":["url","fileName"],"properties":{"url":{"type":"string","description":"The full S3 URL for uploading the file or reading the file (depending on the &quot;operation&quot; input parameter)"},"fileName":{"type":"string","description":"The name of the file"},"filename_hashed":{"type":"string","description":"This parameter has the same value of fileName (deprecated)"},"content_type":{"type":"string","description":"The content type of the file"}}},"ManageUploadPostobjectResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUploadPostobjectData","description":"Data for generating the Postobject form request in the FE."},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/ManageUploadPostobjectLinks"}}}},"ManageUploadPostobjectData":{"required":["form_inputs","form_attributes","filename"],"properties":{"form_inputs":{"$ref":"#/definitions/ManageUploadPostobjectFormInputs","description":"POST body fields to send to AWS. All must be sent. For more information see: https://docs.aws.amazon.com/AmazonS3/latest/userguide/HTTPPOSTForms.html#HTTPPOSTFormFields and https://docs.aws.amazon.com/directconnect/latest/APIReference/CommonParameters.html"},"form_attributes":{"$ref":"#/definitions/ManageUploadPostobjectFormAttributes","description":"Attributes to attach to the PostObject form request."},"filename":{"type":"string","description":"The (un)changed filename - depends on collection type and parameter &quot;keep_original_filename&quot;"}}},"ManageUploadPostobjectFormInputs":{"required":["key","Content-Type","success_action_status","X-Amz-Credential","X-Amz-Algorithm","X-Amz-Date","Policy","X-Amz-Signature"],"properties":{"key":{"type":"string","description":"Key of the file similar to e.g. &#039;/files/h/y/hydra_docebosaas.com/myfile.jpg&#039;"},"Content-Type":{"type":"string","description":"Mime type of the file e.g. &#039;image/jpg&#039;"},"success_action_status":{"type":"string","description":"The success status that AWS will return, e.g. &#039;201&#039;"},"X-Amz-Credential":{"type":"string","description":"Credential scope value"},"X-Amz-Algorithm":{"type":"string","description":"The hash algorithm that you used to create the request signature."},"X-Amz-Date":{"type":"string","description":"The date used to create the signature"},"Policy":{"type":"string","description":"Security policy describing what is permitted in the request."},"X-Amz-Signature":{"type":"string","description":"Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key."}}},"ManageUploadPostobjectFormAttributes":{"required":["action","method","enctype"],"properties":{"action":{"type":"string","description":"Form action target"},"method":{"type":"string","description":"Form method"},"enctype":{"type":"string","description":"Form encoding type"}}},"ManageUploadPostobjectLinks":{},"ManageUploadPostPolicyResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"The policy data","items":{"$ref":"#/definitions/ManageUploadPostPolicyData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUploadPostPolicyData":{"required":["uploadURL","bucket","region","keyStart","params"],"properties":{"uploadURL":{"type":"string","description":"The CDN Url that should be used to upload the image to"},"bucket":{"type":"string","description":"Specifies the acceptable bucket name"},"region":{"type":"string","description":"Specifies the S3 region name"},"keyStart":{"type":"string","description":"The folder where to upload the files"},"params":{"type":"array","description":"The policy parameters","items":{"$ref":"#/definitions/ManageUploadPostPolicyParams"}}}},"ManageUploadPostPolicyParams":{"required":["acl","policy","x-amz-algorithm","x-amz-credential","x-amz-date","x-amz-signature"],"properties":{"acl":{"type":"string","description":"Specifies the ACL value that must be used in the form submission"},"policy":{"type":"string","description":"The computed policy string"},"x-amz-algorithm":{"type":"string","description":"The signing algorithm that must be used during signature calculation. For AWS Signature Version 4, the value is AWS4-HMAC-SHA256."},"x-amz-credential":{"type":"string","description":"The credentials that you used to calculate the signature. It provides access key ID and scope information identifying region and service for which the signature is valid. This should be the same scope you used in calculating the signing key for signature calculation."},"x-amz-date":{"type":"string","description":"The date value specified in the ISO8601 formatted string. For example, 20130728T000000Z. The date must be same that you used in creating the signing key for signature calculation."},"x-amz-signature":{"type":"string","description":"The computed signature"}}},"ManageUploadDeleteSchema":{"type":"object","required":["filename"],"properties":{"filename":{"type":"string","description":"The name of the File"},"collection":{"type":"string","description":"The Amazon S3 collection where the file resides. If not provided, defaults to &quot;uploads&quot; collection."},"subfolder":{"type":"string","description":"The subfolder inside the collection where this file resides"}}},"ManageUploadDeleteResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure of creating the course","items":{"$ref":"#/definitions/ManageUploadDeleteData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUploadDeleteData":{},"ManageUserCreateSchema":{"type":"object","required":["userid","password","send_notification_email"],"properties":{"userid":{"type":"string","description":"the Username to register. Optional ONLY if checked &quot;Use Email as Username&quot; in &quot;Advanced Settings&quot;."},"email":{"type":"string","description":"User&#039;s email. Required ONLY if checked &quot;Use Email as Username&quot; in &quot;Advanced Settings&quot;."},"password":{"type":"string","description":""},"firstname":{"type":"string","description":"Required ONLY if checked &quot;First Name and Last Name are required in order to register&quot; in &quot;Advanced Settings&quot;"},"lastname":{"type":"string","description":"Required ONLY if checked &quot;First Name and Last Name are required in order to register&quot; in &quot;Advanced Settings&quot;"},"force_change":{"type":"integer","description":"Force change password (0 or 1)"},"level":{"type":"integer","description":"User level. Options: 3 - SuperAdmin, 4 - PowerUser, 6 - User"},"language":{"type":"string","description":"Selected language (browser code. e.g.: en, es, etc.), long name is also supported (e.g.: english, spanish, etc.)"},"expiration":{"type":"string","format":"date","description":"Expiration date (Format: YYYY-MM-DD)"},"email_validation_status":{"type":"integer","description":"Email validation status - 0-unverified, 1-verified"},"valid":{"type":"integer","description":"Is user active. Options: 0 - not active, 1 - active. Default: 1 (active)"},"date_format":{"type":"string","description":"Date format - en, it, bg ..."},"timezone":{"type":"string","description":"User Timezone (e.g: Europe/Rome, America/Caracas, Asia/Tokyo, etc.). Default: The Platform Timezone set in the &quot;Advanced Settings&quot;"},"role":{"type":"integer","description":"The company user role ID"},"manager":{"$ref":"#/definitions/ManageUserCreateManager","description":"The ID of the manager of the user"},"employees":{"$ref":"#/definitions/ManageUserCreateEmployees","description":"Each property of the object corresponds to a manager type ID and the property value is an array of employee IDs for that manager type"},"send_notification_email":{"type":"boolean","description":"Send email notification. Options: false - don&#039;t send notification, true - send notification."},"can_manage_subordinates":{"type":"boolean","description":"Can manage subordinates. Options: true, false Default: false. If the &quot;employees&quot; array is populated, then can_manage_subordinates is automatically set to true"},"group_membership":{"type":"array","description":"Array of group ids into which add the user after the creation","items":{"$ref":"#/definitions/ManageUserCreateGroupMembership"}},"select_orgchart":{"$ref":"#/definitions/ManageUserCreateSelectOrgchart","description":"The key is the branch id and the value is the selection status. It accepts also single branch id (without status). Examples: &quot;select_orgchart&quot;: {&quot;11&quot;:1, &quot;12&quot;:1, &quot;13&quot;:2, &quot;14&quot;:2} or &quot;select_orgchart&quot;: 11. For platforms created after 16/10/2019 this attribute would accept only 1 key at a time, and the user would be moved to the passed branch and removed from its previous branch, if any"},"additional_fields":{"$ref":"#/definitions/ManageUserCreateAdditionalFields","description":"Object composed with field_id and value pairs to populate additional fields defined for the user. An additional field could be visible only in a certain branch, so be sure that the additional field is available for branch selected in select_orgchart parameter. Key is the ID of the additional field. Value is the value selected by the user. May be an integer (e.g. for Dropdown additional fields) or string (Text additional field, Textarea additional field)"}}},"ManageUserCreateManager":{"required":["__manager_type_id__"],"properties":{"__manager_type_id__":{"type":"integer","description":"The key should be manager type ID, the value - user ID (user who will be the manager). Ex: {&quot;1&quot;: 13186}"}}},"ManageUserCreateEmployees":{"required":["__manager_type_id__"],"properties":{"__manager_type_id__":{"type":"array","description":"The key should be the manager type ID, the value should be an array of user IDs. Ex: [&quot;123&quot;, &quot;456&quot;]","items":{"type":"string"}}}},"ManageUserCreateGroupMembership":{},"ManageUserCreateSelectOrgchart":{"required":["__branch_id__"],"properties":{"__branch_id__":{"type":"integer","description":"The key should be the branch id, the value the selection status. Statuses can be (1 - Single branch selection, 2 - Branch with descendants &gt; selection)"}}},"ManageUserCreateAdditionalFields":{"properties":{"__first_additional_field_id__":{"type":"integer","description":"Example of integer additional field"},"__second_additional_field_id__":{"type":"string","description":"Example of string additional field"}}},"ManageUserCreateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserCreateData","description":"Success or failure to register user with error messages (optional)"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageUserCreateLinks"}}}},"ManageUserCreateData":{"properties":{"message":{"type":"array","description":"Array with errors","items":{"$ref":"#/definitions/ManageUserCreateMessage"}},"success":{"type":"boolean","description":"Success or failure to register user"},"user_id":{"type":"integer","description":"The newly created user id (in case of success)"}},"required":["success"]},"ManageUserCreateMessage":{"properties":{"id":{"type":"string","description":"ID or name of the field"},"message":{"type":"string","description":"Error message"}},"required":["message"]},"ManageUserCreateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageUserDeleteSchema":{"type":"object","properties":{"user_ids":{"type":"array","description":"User IDs","items":{"type":"integer"}},"user_names":{"type":"array","description":"Usernames","items":{"type":"string"}}}},"ManageUserDeleteResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/ManageUserDeleteData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserDeleteData":{"required":["success","deleted_user_ids"],"properties":{"success":{"type":"boolean","description":"Success or failure to delete user"},"deleted_user_ids":{"type":"Array(string)","description":"IDs of deleted users"}}},"ManageUserIndexResponse":{"required":["data","version","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserIndexData","description":"Response success or failure to find users"},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"$ref":"#/definitions/ManageUserIndexExtraData","description":"Object contains additional data to the users list"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageUserIndexLinks"}}}},"ManageUserIndexData":{"properties":{"items":{"type":"array","description":"List of Users","items":{"$ref":"#/definitions/ManageUserIndexItems"}},"is_manager":{"type":"boolean","description":"Whether this user is manager"},"active_subordinates_count":{"type":"integer","description":"The SUM of assigned subordinates that this user have (no matter the Manager type) in status of confirmed or imported only"},"send_notification":{"type":"string","description":"Check if is sent notification &quot;UserCreatedByAdmin&quot; to user. Options: 0 (false), 1 (true)"},"field_1111":{"type":"string","description":"Additional field value. In field_1111, &quot;1111&quot; is field ID. There are multiple additional fields created using this pattern"},"confirmed":{"type":"string","description":"Is user confirmed. It is available only for pending users"},"request_on":{"type":"string","format":"date","description":"Date of user request. It is available only for pending users"},"create_by_admin":{"type":"string","format":"date","description":"Created by admin. Options: 0 - false, 1 - true. It is available only for pending users"},"actions":{"type":"array","description":"List of actions: edit|delete","items":{"$ref":"#/definitions/ManageUserIndexActions"}},"multidomains":{"type":"array","description":"List of first level multidomain the user is associated to. For a user it returns the first multidomain found in the path to the associated branch (or branches).","items":{"$ref":"#/definitions/ManageUserIndexMultidomains"}},"expired":{"type":"boolean","description":"Whether or not the user has passed their expiration date. It is available only for NOT pending users"},"authenticatorapp_pair_date":{"type":"string","format":"date","description":"When the user paired the devices (datetime in format &quot;Y-m-d H:i:s&quot;). This parameter is return only if EsignatureApp is Enabled and Activated and AuthenticatorApp is checked from the EsignatureApp settings"},"last_update":{"type":"string","format":"date","description":"Date and time (in yyyy-MM-dd hh:mm:ss format) when this user has been modified"},"newsletter_optout":{"type":"string","description":"User opt out choice. Always False if TOGGLE_NEWSLETTER_OPT_OUT is not active or opt_out_mode setting is disabled"},"newsletter_optout_date":{"type":"string","description":"User opt out date. Always null if TOGGLE_NEWSLETTER_OPT_OUT is not active or opt_out_mode setting is disabled"}},"required":["is_manager","active_subordinates_count","send_notification","field_1111","multidomains","expired","last_update","newsletter_optout","newsletter_optout_date"]},"ManageUserIndexItems":{"required":["user_id","username","first_name","last_name","email","uuid","lang_code","avatar","date_format","language"],"properties":{"user_id":{"type":"string","description":"The ID of the user"},"username":{"type":"string","description":"Username of the user"},"encoded_username":{"type":"string","description":"Url encoded username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email of the user"},"uuid":{"type":"string","description":"UUID (universally unique identifier) of the user"},"lang_code":{"type":"string","description":"User UI language code"},"avatar":{"type":"string","description":"Avatar of the user"},"date_format":{"type":"string","description":"Data format (epl. &#039;en&#039;, &#039;bg&#039;, etc)"},"last_access_date":{"type":"string","format":"date","description":"Last access date of the user. It is available only for NOT pending users"},"creation_date":{"type":"string","format":"date","description":"Creation date of the user. It is available only for NOT pending users"},"status":{"type":"string","description":"User status. Options: 0 - suspended OR 1 - unsuspended. It is available only for NOT pending users"},"language":{"type":"string","description":"User UI language. This field is deprecated and it will be dropped on 2018-07-31"},"expiration_date":{"type":"string","format":"date","description":"Expiration date of an user. It is available only for NOT pending users"},"level":{"type":"string","description":"Level of an user. It is available only for NOT pending users. Options: user (User), admin (Power User), godadmin (Super Admin), erpadmin (Docebo Admin, if applicable)"},"email_validation_status":{"type":"string","description":"Email validation status of an user. It is available only for NOT pending users"},"manager_names":{"$ref":"#/definitions/ManageUserIndexManagerNames","description":"DEPRECATED. Please use managers property."},"managers":{"type":"array","description":"Manager details. It is available only for NOT pending users","items":{"$ref":"#/definitions/ManageUserIndexManagers"}}}},"ManageUserIndexManagerNames":{"required":["__manager_type_id__"],"properties":{"__manager_type_id__":{"$ref":"#/definitions/ManageUserIndexManagerTypeId","description":"Object containing manager title and manager name. The key is manager type ID"}}},"ManageUserIndexManagerTypeId":{"required":["manager_title","manager_name","manager_username"],"properties":{"manager_title":{"type":"string","description":"Manager&#039;s Title"},"manager_name":{"type":"string","description":"Manager&#039;s Name"},"manager_username":{"type":"string","description":"Manager&#039;s username"},"manager_id":{"type":"integer","description":"Manager&#039;s internal user ID"}}},"ManageUserIndexManagers":{"required":["manager_title","manager_name","manager_username"],"properties":{"manager_title":{"type":"string","description":"Manager&#039;s Title"},"manager_name":{"type":"string","description":"Manager&#039;s Name"},"manager_username":{"type":"string","description":"Manager&#039;s username"},"manager_id":{"type":"integer","description":"Manager&#039;s internal user ID"},"manager_type_id":{"type":"integer","description":"Manager&#039;s type ID"}}},"ManageUserIndexActions":{"required":["action"],"properties":{"action":{"type":"string","description":"Action name"}}},"ManageUserIndexMultidomains":{"properties":{"name":{"type":"string","description":"Multidomain name."}}},"ManageUserIndexExtraData":{"properties":{"currently_logged_users_count":{"type":"integer","description":"Number of currently logged users. Result if filtered in"}}},"ManageUserIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageUserUpdateSchema":{"type":"object","properties":{"userid":{"type":"string","description":"username for this user"},"email":{"type":"string","description":"User&#039;s email. If the user calling the API is a super admin, the email is optional. In all other cases it&#039;s required."},"password":{"type":"string","description":"user password"},"firstname":{"type":"string","description":"Required ONLY if checked &quot;First Name and Last Name are required in order to register&quot; in &quot;Advanced Settings&quot;"},"lastname":{"type":"string","description":"Required ONLY if checked &quot;First Name and Last Name are required in order to register&quot; in &quot;Advanced Settings&quot;"},"force_change":{"type":"integer","description":"Force change password (0 or 1)"},"level":{"type":"integer","description":"User level"},"language":{"type":"string","description":"Selected language"},"expiration":{"type":"string","format":"date","description":"Expiration date"},"email_validation_status":{"type":"integer","description":"Email status - 0-unverified, 1-verified"},"date_format":{"type":"string","description":"Date format - en, it, bg ..."},"timezone":{"type":"string","description":"Timezone"},"role":{"type":"integer","description":"The company user role ID, use 0 to remove the assigned role"},"manager":{"$ref":"#/definitions/ManageUserUpdateManager","description":"The ID of the manager of the user"},"can_manage_subordinates":{"type":"boolean","description":"Can manage subordinates. Options true, false"},"additional_fields":{"$ref":"#/definitions/ManageUserUpdateAdditionalFields","description":"Object composed with field_id and value pairs to populate additional fields defined for the user. An additional field could be visible only in a certain branch, so be sure that the additional field is available for branch selected in select_orgchart parameter. Key is the ID of the additional field. Value is the value selected by the user. May be an integer (e.g. for Dropdown additional fields) or string (Text additional field, Textarea additional field)"},"select_orgchart":{"$ref":"#/definitions/ManageUserUpdateSelectOrgchart","description":"The key is the branch id and the value is the selection status. It accepts also single branch id (without status). Examples: &quot;select_orgchart&quot;: {&quot;11&quot;:1, &quot;12&quot;:1, &quot;13&quot;:2, &quot;14&quot;:2} or &quot;select_orgchart&quot;: 11. For platforms created after 16/10/2019 this attribute would accept only 1 key at a time, and the user would be moved to the passed branch and removed from its previous branch, if any"},"context":{"type":"string","description":"The context page the request is coming from. When set to myProfile a custom function is used to update the user data, this function avoids forcing the username to be the same as the email when the use email as username option is set"},"newsletter_optout":{"type":"boolean","description":"The value of the newsletter_optout. Updated only if TOGGLE_NEWSLETTER_OPT_OUT is active and opt_out_mode setting is 1. The user can modify only its own value."},"is_sso_provisioning":{"type":"boolean","description":"True when the update is performed using SSO user provisioning"}}},"ManageUserUpdateManager":{"required":["__manager_type_id__"],"properties":{"__manager_type_id__":{"type":"integer","description":"The key should be manager type ID, the value - user ID (user who will be the manager). Ex: {&quot;1: &quot;13186&quot;}"}}},"ManageUserUpdateAdditionalFields":{},"ManageUserUpdateSelectOrgchart":{"required":["__branch_id__"],"properties":{"__branch_id__":{"type":"integer","description":"The key should be the branch id, the value the selection status. Statuses can be (1 - Single branch selection, 2 - Branch with descendants &gt; selection)"}}},"ManageUserUpdateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserUpdateData","description":"Success or failure to register user with error messages (optional)"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources.","items":{"$ref":"#/definitions/ManageUserUpdateLinks"}}}},"ManageUserUpdateData":{"properties":{"message":{"type":"array","description":"Array with errors","items":{"$ref":"#/definitions/ManageUserUpdateMessage"}},"success":{"type":"boolean","description":"Success or failure to register user"},"updated_id":{"type":"integer","description":"Just updated user ID"},"updated_uuid":{"type":"string","description":"The UUID (universally unique identifier) of the user"}},"required":["success"]},"ManageUserUpdateMessage":{"properties":{"id":{"type":"string","description":"ID or name of the field"},"message":{"type":"string","description":"Error message"}},"required":["message"]},"ManageUserUpdateLinks":{},"ManageUserViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserViewData","description":"Data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageUserViewLinks"}}}},"ManageUserViewData":{"required":["user_data","additional_fields","branches","saml_settings"],"properties":{"user_data":{"$ref":"#/definitions/ManageUserViewUserData","description":""},"additional_fields":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageUserViewAdditionalFields"}},"branches":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageUserViewBranches"}},"saml_settings":{"$ref":"#/definitions/ManageUserViewSamlSettings","description":""}}},"ManageUserViewUserData":{"required":["user_id","username","first_name","last_name","email","uuid","lang_code","lang_browsercode","force_change","expiration","email_validation_status","valid","avatar","can_manage_subordinates","is_saml_provision","language","level","date_format","timezone","manager_first_name","manager_last_name","manager_username","manager_id","cant_have_direct_manager","newsletter_optout","newsletter_optout_date"],"properties":{"user_id":{"type":"string","description":"User ID or Username of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email of the user"},"uuid":{"type":"string","description":"UUID (universally unique identifier) of the user"},"lang_code":{"type":"string","description":"User UI language code"},"lang_browsercode":{"type":"string","description":"User UI language browser code"},"force_change":{"type":"string","description":"Force user to change password"},"expiration":{"type":"string","format":"date","description":"Expiration date of an user. It is available only for NOT pending users"},"email_validation_status":{"type":"string","description":"Email validation status of an user. It is available only for NOT pending users"},"valid":{"type":"string","description":"Is user active. Options: 0 - not active, 1 - active"},"avatar":{"type":"string","description":"Avatar of the user"},"can_manage_subordinates":{"type":"boolean","description":"Can manage subordinates. It is available only for NOT pending users"},"is_saml_provision":{"type":"string","description":"Is SAML provision"},"language":{"type":"string","description":"User UI language. This field is deprecated and it will be dropped on 2018-07-31"},"level":{"type":"string","description":"Level of an user. It is available only for NOT pending users. Options: user (User), admin (Power User), godadmin (Super Admin), erpadmin (Docebo Admin, if applicable)"},"date_format":{"type":"string","description":"Date format (e.g. &#039;ar&#039;, &#039;ar_dz&#039;, &#039;bg&#039;, &#039;en&#039;, &#039;en-gb&#039;, &#039;it&#039;, &#039;es&#039;, etc)"},"timezone":{"type":"string","description":"Timezone (epl. &#039;Europe/Sofia&#039;)"},"manager_first_name":{"type":"string","description":"Manager first name. It is available only for NOT pending users"},"manager_last_name":{"type":"string","description":"Manager last name. It is available only for NOT pending users"},"manager_username":{"type":"string","description":"Manager username. It is available only for NOT pending users"},"manager_id":{"type":"string","description":"Manager id. It is available only for NOT pending users"},"employees":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageUserViewEmployees"}},"cant_have_direct_manager":{"type":"boolean","description":"The user can&#039;t have a direct manager"},"newsletter_optout":{"type":"string","description":"User opt out choice. Always False if TOGGLE_NEWSLETTER_OPT_OUT is not active or opt_out_mode setting is disabled"},"newsletter_optout_date":{"type":"string","description":"User opt out date. Always null if TOGGLE_NEWSLETTER_OPT_OUT is not active or opt_out_mode setting is disabled"},"spu_edit_mode":{"description":"Describes what can be edited if caller is a Super Power User","enum":["none","data","full"],"type":"string"},"last_update":{"type":"string","format":"date","description":"Returned date and time when this user has been modified using the yyyy-MM-dd hh:mm:ss format. This item is not returned if this user is a pending user."}}},"ManageUserViewEmployees":{"required":["user_id","username","name","surname","email"],"properties":{"user_id":{"type":"string","description":"Employee id"},"username":{"type":"string","description":"Employee username"},"name":{"type":"string","description":"Employee first name"},"surname":{"type":"string","description":"Employee last name"},"email":{"type":"string","description":"Employee email"}}},"ManageUserViewAdditionalFields":{"required":["id","title","type","mandatory","invisible_to_user","settings","sequence","value","enabled"],"properties":{"id":{"type":"string","description":"Field ID"},"title":{"type":"string","description":"Field title"},"type":{"type":"string","description":"Field type"},"mandatory":{"type":"boolean","description":"Is field mandatory"},"invisible_to_user":{"type":"boolean","description":"Is field invisible to an regular users"},"settings":{"type":"string","description":"The setting of the IFRAME type field"},"sequence":{"type":"integer","description":"the order of appearance of the additional field"},"options":{"$ref":"#/definitions/ManageUserViewOptions","description":"Dropdown options if filed type is &#039;dropdown&#039; or &#039;country&#039;"},"value":{"type":"string","description":"Chosen value by user"},"download_url":{"type":"string","description":"URL of the downloadable file; only available for UPLOAD fields"},"iframe_url":{"type":"string","description":"URL of the iframe; only available for IFRAME fields"},"enabled":{"type":"boolean","description":"additional field enabled"}}},"ManageUserViewOptions":{"required":["id","label"],"properties":{"id":{"type":"integer","description":"Option ID"},"label":{"type":"string","description":"Option title"}}},"ManageUserViewBranches":{"properties":{"id":{"type":"integer","description":"Branch ID"},"iLeft":{"type":"integer","description":"Branch iLeft"},"iRight":{"type":"integer","description":"Branch iRight"}}},"ManageUserViewSamlSettings":{"required":["unique_field","lock_provisioned_user_fields","provisioned_user_fields"],"properties":{"unique_field":{"type":"string","description":"Unique field"},"lock_provisioned_user_fields":{"type":"integer","description":"Lock provisioned user fields Options: 0 - false, 1 - true (provisioned field are read only)"},"provisioned_user_fields":{"type":"array","description":"Users provisioning fields from SAML Settings, the &#039;key&#039; in array is a Field name, the &#039;value&#039; is Attribute statement","items":{"$ref":"#/definitions/ManageUserViewProvisionedUserFields"}}}},"ManageUserViewProvisionedUserFields":{},"ManageUserViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageUserListResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserListData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageUserListLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageUserListData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"List of users (pre-filtered in case of Power User) with predefined `expand` parameter","items":{"$ref":"#/definitions/ManageUserListItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"ManageUserListItems":{},"ManageUserListLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/ManageUserListSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ManageUserListGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ManageUserListFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ManageUserListLast","description":"Link to the last page"}}},"ManageUserListSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"ManageUserListGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"ManageUserListFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"ManageUserListLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"ManageUserLoginSchema":{"type":"object","required":["username","password"],"properties":{"username":{"type":"string","description":"User username"},"password":{"type":"string","description":"User password"},"client_timezone_textual":{"type":"string","description":"Detected client timezone region name"},"client_timezone":{"type":"integer","description":"Detected client timezone offset in seconds"},"issue_refresh_token":{"type":"boolean","description":"Whether the response should include a refresh token or not. Default = false"}}},"ManageUserLoginResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserLoginData","description":"Access token data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageUserLoginLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageUserLoginData":{"required":["id_user","access_token","expires_in","token_type","scope","reenter_cc","has_unfilled_fields","trial_expired"],"properties":{"id_user":{"type":"integer","description":"The ID of the user"},"access_token":{"type":"string","description":"Access token"},"expires_in":{"type":"integer","description":"Access token lifetime in seconds"},"token_type":{"type":"string","description":"Access token type"},"scope":{"type":"string","description":"Access token scope"},"refresh_token":{"type":"string","description":"Refresh token (only if explicitly requested by the client)"},"reenter_cc":{"type":"boolean","description":"Flag that holds whether the user needs to reenter his credit card info"},"has_unfilled_fields":{"type":"boolean","description":"Flag that holds whether the user has mandatory additional fields unfilled"},"trial_expired":{"type":"boolean","description":"Flag that holds whether the platform is an expired trial"}}},"ManageUserLoginLinks":{"properties":{"self":{"$ref":"#/definitions/ManageUserLoginSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ManageUserLoginGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ManageUserLoginFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ManageUserLoginLast","description":"Link to the last page"}}},"ManageUserLoginSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"ManageUserLoginGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"ManageUserLoginFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"ManageUserLoginLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"ManageUserSessionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserSessionData","description":"User data"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserSessionData":{"required":["id","username","firstname","lastname","email","email_validation_status","user_level","language","dateformat_locale","timezone","avatar_url","has_unfilled_fields","multidomain_id","available_multidomains","home_route","force_change","is_non_whitelabeled_user","switched_to_new_pages","redirect_on_logout","is_erp_admin","need_policy_accept","cant_have_direct_manager","menu_items","built_in_page","menu_items_mobile","branding","currency_settings","active_languages"],"properties":{"id":{"type":"integer","description":"User&#039;s internal ID"},"username":{"type":"string","description":"Username"},"firstname":{"type":"string","description":"User`s first name"},"lastname":{"type":"string","description":"User`s last name"},"email":{"type":"string","description":"User`s email"},"email_validation_status":{"type":"boolean","description":"Whether the email of the user is verified or not"},"user_level":{"type":"string","description":"User&#039;s level (e.g &#039;user&#039;, &#039;admin&#039;, &#039;super_admin&#039;)"},"language":{"type":"string","description":"User`s preferred language"},"dateformat_locale":{"type":"string","description":"User`s date format (e.g. &#039;en_us&#039;)"},"timezone":{"type":"string","description":"User`s timezone"},"avatar_url":{"type":"string","description":"User`s avatarprofile image"},"has_unfilled_fields":{"type":"boolean","description":"Indicating if the user still has some unfilled mandatory additional fields to fill"},"multidomain_id":{"type":"integer","description":"Which multidomain environment is applicable to the authenticated user (or the current URL)"},"multidomain_node_data":{"$ref":"#/definitions/ManageUserSessionMultidomainNodeData","description":"If there is an assigned branch for the multidomain, this object contains some information about it"},"available_multidomains":{"type":"array","description":"A list of all the available multidomain clients IDs","items":{"type":"integer"}},"home_route":{"type":"string","description":"The home route to display as homepage (e.g. after login)"},"no_suggestion_modals":{"type":"boolean","description":"- optional parameter that is passed only when the first user enters the platform for the first time"},"force_change":{"type":"boolean","description":"If true, the user should be forced to change his password after login"},"is_non_whitelabeled_user":{"type":"boolean","description":"If some whitelabeled super admin enabled the &quot;BUY NOW, Course Marketplace, APPS buttons from the menu&quot;"},"switched_to_new_pages":{"type":"boolean","description":"Switched from old Main menu to new LMS Pages"},"lms_pages_enable_date":{"type":"string","description":"Switching automatically from old Main menu to new LMS Pages Date"},"lms_pages_switcher_show":{"description":"Show switcher to LMS Pages","enum":["root","multidomain","restore_multidomain","restore"],"type":"string"},"redirect_on_logout":{"type":"boolean","description":"Need redirect to external page on logout"},"is_erp_admin":{"type":"boolean","description":"Whether or not the currently logged in user is erp admin"},"need_policy_accept":{"type":"boolean","description":"Return if the logged user must accept the last version of the policy related to the domain"},"need_terms_and_conditions_accept":{"type":"boolean","description":"Return if the logged user must accept the last version of the terms and conditions related to the domain"},"is_instructor":{"type":"boolean","description":"Whether or not the user is instructor in at least one course"},"cant_have_direct_manager":{"type":"boolean","description":"The user can&#039;t have a direct manager"},"has_configured_xApi_url":{"type":"boolean","description":"Whether a valid xAPI URL is configured. Available only when the toggle RELEASE/WEEKLY/DLI-AS-TRAINING-MATERIAL is ON and toggle RELEASE/WEEKLY/DLI-IN-CLOR is ON"},"menu_items":{"type":"array","description":"User`s available menu items","items":{"$ref":"#/definitions/ManageUserSessionMenuItems"}},"built_in_page":{"type":"array","description":"Platform&#039;s active built-in pages","items":{"$ref":"#/definitions/ManageUserSessionBuiltInPage"}},"is_aoi_profiled":{"type":"boolean","description":"If the user (or admin) has configured his role and skills in My Area of Interest"},"skills":{"$ref":"#/definitions/ManageUserSessionSkills","description":"Settings for the New Skills feature"},"modals":{"$ref":"#/definitions/ManageUserSessionModals","description":"Show skill modals to the user"},"menu_items_mobile":{"type":"array","description":"User`s available mobile compatible menu items","items":{"$ref":"#/definitions/ManageUserSessionMenuItemsMobile"}},"admin_menu_items":{"$ref":"#/definitions/ManageUserSessionAdminMenuItems","description":"Admin&#039;s available admin menu items"},"branding":{"$ref":"#/definitions/ManageUserSessionBranding","description":"Branding"},"catalog_settings":{"$ref":"#/definitions/ManageUserSessionCatalogSettings","description":""},"currency_settings":{"$ref":"#/definitions/ManageUserSessionCurrencySettings","description":""},"active_languages":{"type":"array","description":"Array with active languages","items":{"$ref":"#/definitions/ManageUserSessionActiveLanguages"}}}},"ManageUserSessionMultidomainNodeData":{"required":["id","iLeft","iRight","can_manage"],"properties":{"id":{"type":"integer","description":"ID of the branch"},"iLeft":{"type":"integer","description":"Scope from the left border of the branch"},"iRight":{"type":"integer","description":"Scope to the right border of the branch"},"can_manage":{"type":"boolean","description":"Whether the user can manage the branch"}}},"ManageUserSessionMenuItems":{"required":["id","code","icon","label","description","type","route","url","target","is_new","count","is_custom"],"properties":{"id":{"type":"integer","description":"Id of the menu item"},"code":{"type":"string","description":"Code of the menu item. Can return null"},"icon":{"type":"string","description":"CSS class for the icon to be displayed"},"label":{"type":"string","description":"Localized menu title"},"description":{"type":"string","description":"Description of the menu item"},"type":{"type":"string","description":"Type of the menu item"},"route":{"type":"string","description":"Route (e.g. &quot;[&#039;/path&#039;, &#039;/subpath&#039;]&quot;) to navigate to"},"url":{"type":"string","description":"Absolute URL (e.g. &quot;http://www.google.com&quot;) to redirect to"},"target":{"type":"string","description":"&quot;same_window&quot;|&quot;new_window&quot;. Only applicable if url is set. Determines whether the link should be opened in the same page or in a new page. Default = &quot;same_window&quot;"},"is_new":{"type":"string","description":"If true, shows the &quot;New&quot; label for this item"},"count":{"type":"integer","description":"If greater than 0, returns a number to be displayed in the red bullet. Default = 0 -&gt; do not display the red bullet"},"is_custom":{"type":"boolean","description":"Whether the menu item is custom or not"}}},"ManageUserSessionBuiltInPage":{"required":["code","icon","route","subtitle","title"],"properties":{"code":{"type":"string","description":"Value that identifies the page"},"icon":{"type":"string","description":"CSS class for the icon to be displayed"},"route":{"type":"string","description":"Route (e.g. &quot;[&#039;/path&#039;, &#039;/subpath&#039;]&quot;) to navigate to"},"subtitle":{"type":"string","description":"Page&#039;s subtitle"},"title":{"type":"string","description":"Page&#039;s title"}}},"ManageUserSessionSkills":{"required":["default_channel_is_visible","non_default_channel_is_visible","skillgroup_publish_modal_dismissed","skillgroups_setup_completed","user_is_profiled","allowed_content_types","is_skills_active","third_party_enabled"],"properties":{"default_channel_is_visible":{"type":"boolean","description":"Whether the Default Skills Channel is active and visible by the user"},"non_default_channel_is_visible":{"type":"boolean","description":"Whether a Skills Channel is active and visible by the user, excluding the default one"},"skillgroup_publish_modal_dismissed":{"type":"boolean","description":"Whether the user has dismissed the first ai-based channel publish warning"},"skillgroups_setup_completed":{"type":"boolean","description":"Whether the user has completed the Skillgroup initial configuration"},"user_is_profiled":{"type":"boolean","description":"Whether the user is profiled with at least one skill"},"allowed_content_types":{"type":"array(enum \"formal\", \"informal\", \"external\")","description":"Supported content types based on C&amp;S plugin status"},"is_skills_active":{"type":"boolean","description":"Whether all required toggles and conditions are met in order to show/use Skills functionalities"},"third_party_enabled":{"type":"boolean","description":"Whether the third party setting is enabled for skills"}}},"ManageUserSessionModals":{"required":["profiler"],"properties":{"profiler":{"type":"boolean","description":"To show the new skills profiler modal"},"profiler_legacy":{"type":"boolean","description":"To show the skills profiler modal"},"skillgroups_setup":{"type":"boolean","description":"To show the skills admin setup modal"},"dashboard":{"type":"boolean","description":"To show the skills dashboard modal"}}},"ManageUserSessionMenuItemsMobile":{"required":["icon","label","route","url","target","is_new","count"],"properties":{"icon":{"type":"string","description":"CSS class for the icon to be displayed"},"label":{"type":"string","description":"Localized menu title"},"route":{"type":"string","description":"Route (e.g. &quot;[&#039;/path&#039;, &#039;/subpath&#039;]&quot;) to navigate to"},"url":{"type":"string","description":"Absolute URL (e.g. &quot;http://www.google.com&quot;) to redirect to"},"target":{"type":"string","description":"&quot;same_window&quot;|&quot;new_window&quot;. Only applicable if url is set. Determines whether the link should be opened in the same page or in a new page. Default = &quot;same_window&quot;"},"is_new":{"type":"string","description":"If true, shows the &quot;New&quot; label for this item"},"count":{"type":"integer","description":"If greater than 0, returns a number to be displayed in the red bullet. Default = 0 -&gt; do not display the red bullet"}}},"ManageUserSessionAdminMenuItems":{"required":["main_menu","plugin_menu"],"properties":{"main_menu":{"$ref":"#/definitions/ManageUserSessionMainMenu","description":"Menu items in the Main Admin Menu category"},"plugin_menu":{"$ref":"#/definitions/ManageUserSessionPluginMenu","description":"Menu items in the Plugin Admin Menu category"}}},"ManageUserSessionMainMenu":{"required":["items","label"],"properties":{"items":{"type":"array","description":"Sub menu items","items":{"$ref":"#/definitions/ManageUserSessionItems"}},"label":{"type":"string","description":"Menu item name"}}},"ManageUserSessionItems":{"required":["label","link"],"properties":{"label":{"type":"string","description":"Item name"},"link":{"type":"string","description":"Item link"},"is_new":{"type":"boolean","description":"Item is new"},"is_beta":{"type":"boolean","description":"If true, shows the &quot;Beta&quot; label for this item"},"notification_tooltip":{"type":"array","description":"Add notification message to menu item with icon and tooltip","items":{"$ref":"#/definitions/ManageUserSessionNotificationTooltip"}},"notification_balloon":{"type":"array","description":"Menu item have balloon message","items":{"$ref":"#/definitions/ManageUserSessionNotificationBalloon"}}}},"ManageUserSessionNotificationTooltip":{"required":["type","icon","message"],"properties":{"type":{"type":"string","description":"Notification type: worning | error"},"icon":{"type":"string","description":"Icon"},"message":{"type":"string","description":"Notification message for tooltip"}}},"ManageUserSessionNotificationBalloon":{"required":["title","content"],"properties":{"title":{"type":"string","description":"Balloon title"},"content":{"type":"string","description":"Balloon content"}}},"ManageUserSessionPluginMenu":{"required":["items","label"],"properties":{"items":{"type":"array","description":"Sub menu items","items":{"$ref":"#/definitions/ManageUserSessionItemsL2"}},"label":{"type":"string","description":"Menu item name"}}},"ManageUserSessionItemsL2":{"required":["label","link"],"properties":{"label":{"type":"string","description":"Menu item name"},"link":{"type":"string","description":"Item link"}}},"ManageUserSessionBranding":{"properties":{"footer":{"$ref":"#/definitions/ManageUserSessionFooter","description":"Main elements of the footer"},"header":{"$ref":"#/definitions/ManageUserSessionHeader","description":""}}},"ManageUserSessionFooter":{"properties":{"footer_type":{"type":"string","description":"Footer type, possible values - &#039;show_docebo&#039;, &#039;hide_docebo&#039;, &#039;iframe&#039;, &#039;custom_text&#039;"},"iframe_height":{"type":"integer","description":"Height in px&#039;s for iframe link in the footer /0 if none/"},"iframe_url":{"type":"boolean","description":"Iframe link"},"custom_html":{"type":"boolean","description":"Custom footer html message"}}},"ManageUserSessionHeader":{"properties":{"iframe_active":{"type":"boolean","description":"should iframe active for header"},"iframe_url":{"type":"string","description":"url for header iframe"},"iframe_height":{"type":"integer","description":"height for the iframe in the header"},"header_message_active":{"type":"boolean","description":"should custom header message active for header"},"header_message":{"type":"string","description":"the custom header message"}}},"ManageUserSessionCatalogSettings":{"properties":{"catalog_type":{"type":"string","description":""},"on_catalogue_empty":{"type":"boolean","description":""},"catalog_external":{"type":"boolean","description":"Show/hide catalogue for authenticated users"},"catalog_use_categories_tree":{"type":"boolean","description":""},"show_course_details_dedicated_page":{"type":"boolean","description":""},"catalog_external_selected_catalogs":{"type":"string","description":"List of catalogues for authenticated users"}},"required":["catalog_use_categories_tree"]},"ManageUserSessionCurrencySettings":{"required":["currency","currency_symbol"],"properties":{"currency":{"type":"string","description":""},"currency_symbol":{"type":"string","description":""},"currency_decimals":{"type":"integer","description":"Returned only when toggle release/weekly/multi-currency is ON"}}},"ManageUserSessionActiveLanguages":{"required":["code","description","browsercode","is_rtl","date_formats","show_create_user_button","oauth_clients","pu_impersonator_available_multidomains"],"properties":{"code":{"type":"string","description":"Language code"},"description":{"type":"string","description":"Language description"},"browsercode":{"type":"string","description":"Language Shortcode - bg, en"},"is_rtl":{"type":"boolean","description":"Is the language Right-To-Left(RTL)."},"date_formats":{"type":"array","description":"Language Shortcode - bg, en","items":{"$ref":"#/definitions/ManageUserSessionDateFormats"}},"show_create_user_button":{"type":"boolean","description":"Default value is true, but for PU who doesn&#039;t have permission for create user set &#039;false&#039;."},"pu_manage_user_permissions":{"type":"array","description":"Visible in session only for PU.","items":{"$ref":"#/definitions/ManageUserSessionPuManageUserPermissions"}},"pu_manage_notification_permission":{"type":"array","description":"Visible in session only for PU.","items":{"$ref":"#/definitions/ManageUserSessionPuManageNotificationPermission"}},"pu_manage_harmony_copilot_permission":{"type":"array","description":"Visible in session only for PU.","items":{"$ref":"#/definitions/ManageUserSessionPuManageHarmonyCopilotPermission"}},"authenticatorapp_pair_date":{"type":"string","format":"date","description":"2FA pair date in UTC (in format yyyy-mm-dd HH:mm:ss). Returned only when the EsignatureApp is on and Authenticator App is selected from its settings"},"has_esignature_courses_to_sign":{"type":"boolean","description":"If the user is enrolled in active E-Signature courses that he hadn&#039;t completed or signed yet"},"pu_manage_subscription_permission":{"type":"array","description":"Visible in session only for PU.","items":{"$ref":"#/definitions/ManageUserSessionPuManageSubscriptionPermission"}},"pre_populated_fields":{"type":"array","description":"An array of user additional fields that must be pre-populated when a PowerUser creates a new user","items":{"type":"string"}},"oauth_clients":{"type":"array","description":"List with oauth clients.","items":{"$ref":"#/definitions/ManageUserSessionOauthClients"}},"branding_elements":{"$ref":"#/definitions/ManageUserSessionBrandingElements","description":"Main branding elements of current LMS"},"is_impersonated":{"type":"boolean","description":"Whether the user is being impersonated"},"ecommerce_cart":{"$ref":"#/definitions/ManageUserSessionEcommerceCart","description":"Only show if an external cart is assigned to the current domain"},"is_impersonated_by_pu":{"type":"boolean","description":"Whether the user is being impersonated by a power user"},"pu_impersonator_available_multidomains":{"type":"array","description":"A list of all the available multidomain clients IDs of the power user impersonating","items":{"type":"integer"}},"follow_channel_notifications":{"type":"array","description":"Array of active follow channel notifications. Possible values: none, push, digest","items":{"type":"string"}},"pu_can_manage_community":{"type":"boolean","description":"Visible in session only for PU and when the CommunityApp is enabled."},"pu_can_purchase_tc_pack":{"type":"boolean","description":"Visible in session only for PU when toggle release/2026.02/shared-wallets-extension is ON and ECommercePackApp is active. True if the permission is assigned to at least one of the user&#039;s profiles."}}},"ManageUserSessionDateFormats":{},"ManageUserSessionPuManageUserPermissions":{"required":["can_create","can_view","can_update","can_delete","can_create_power_user","can_edit_power_user"],"properties":{"can_create":{"type":"boolean","description":""},"can_view":{"type":"boolean","description":""},"can_update":{"type":"boolean","description":""},"can_delete":{"type":"boolean","description":""},"can_create_power_user":{"type":"boolean","description":"If true and the user is a power user he can create new power users"},"can_edit_power_user":{"type":"boolean","description":"If true and the user is a power user he can edit existing power users"}}},"ManageUserSessionPuManageNotificationPermission":{"required":["can_create","can_view","can_update","can_delete"],"properties":{"can_create":{"type":"boolean","description":""},"can_view":{"type":"boolean","description":""},"can_update":{"type":"boolean","description":""},"can_delete":{"type":"boolean","description":""}}},"ManageUserSessionPuManageHarmonyCopilotPermission":{"required":["can_manage"],"properties":{"can_manage":{"type":"boolean","description":""}}},"ManageUserSessionPuManageSubscriptionPermission":{"required":["can_create_bundle"],"properties":{"can_create_bundle":{"type":"boolean","description":""}}},"ManageUserSessionOauthClients":{"properties":{"client_id":{"type":"string","description":""},"client_name":{"type":"string","description":""}}},"ManageUserSessionBrandingElements":{"required":["colors","header","signin","styles","home_page_texts","home_page_descriptions"],"properties":{"colors":{"$ref":"#/definitions/ManageUserSessionColors","description":"Object containing the set of colors for the current theme"},"header":{"$ref":"#/definitions/ManageUserSessionHeaderL2","description":"Object containing values for the theme &quot;header&quot; configuration set"},"signin":{"$ref":"#/definitions/ManageUserSessionSignin","description":"Object containing values for the theme &quot;signin&quot; configuration set"},"styles":{"$ref":"#/definitions/ManageUserSessionStyles","description":"Object containing values for the theme &quot;styles&quot; configuration set"},"white_label":{"$ref":"#/definitions/ManageUserSessionWhiteLabel","description":""},"home_page_texts":{"type":"array","description":"Custom texts for the login form indexed by the language code.","items":{"$ref":"#/definitions/ManageUserSessionHomePageTexts"}},"home_page_descriptions":{"type":"array","description":"Custom descriptions for the login form by the language code.","items":{"$ref":"#/definitions/ManageUserSessionHomePageDescriptions"}}}},"ManageUserSessionColors":{"required":["mainColor","actionColor","warningColor","errorColor","mainTextColor","secondaryColor","bordersColor","backgroundColor"],"properties":{"mainColor":{"type":"string","description":"Main color"},"actionColor":{"type":"string","description":"Confirmations color"},"warningColor":{"type":"string","description":"Warnings color"},"errorColor":{"type":"string","description":"Errors color"},"mainTextColor":{"type":"string","description":"Main text color"},"secondaryColor":{"type":"string","description":"Secondary color"},"bordersColor":{"type":"string","description":"Borders and lines color"},"backgroundColor":{"type":"string","description":"Background and hover items color"}}},"ManageUserSessionHeaderL2":{"required":["logo","favicon","title"],"properties":{"logo":{"type":"string","description":"Link for logo image"},"favicon":{"type":"string","description":"Link for favIcon image"},"title":{"type":"string","description":"Page title"}}},"ManageUserSessionSignin":{"required":["background_type","background_value"],"properties":{"background_type":{"description":"The type of background for the signin form. Possible values = &quot;color&quot;, &quot;image&quot;, &quot;video&quot;","enum":["color","image","video"],"type":"string"},"background_value":{"type":"string","description":"The value of the background setting (for &quot;color&quot; type it&#039;s the hex color, for &quot;image&quot; type it&#039;s the image URL, for &quot;video&quot; type it&#039;s the video URL"},"background_fallback_image":{"type":"string","description":"The URL of background image to use if video is broken"}}},"ManageUserSessionStyles":{"required":["custom_css"],"properties":{"custom_css":{"type":"string","description":"The custom css configured for this theme"}}},"ManageUserSessionWhiteLabel":{"properties":{"whitelabel_naming":{"type":"integer","description":"is option for replacing word &quot;Docebo&quot; active or not"},"whitelabel_disable_naming":{"type":"integer","description":"should we do not replace the word &quot;Docebo&quot; in hyperlinks"},"whitelabel_naming_text":{"type":"string","description":"text, which have to replace the word &quot;Docebo&quot;"},"whitelabel_naming_site_enable":{"type":"integer","description":"is option for replacing original site active or not"},"whitelabel_naming_site":{"type":"string","description":"website, which have to replace the www.docebo.com site link"},"whitelabel_menu_userid":{"type":"integer","description":"ID of the White Label App manager"}}},"ManageUserSessionHomePageTexts":{},"ManageUserSessionHomePageDescriptions":{},"ManageUserSessionEcommerceCart":{"properties":{"history_page":{"$ref":"#/definitions/ManageUserSessionHistoryPage","description":""},"subscription_page":{"$ref":"#/definitions/ManageUserSessionSubscriptionPage","description":""}}},"ManageUserSessionHistoryPage":{"properties":{"url":{"type":"string","description":"External url that shows the list of all the past purchases"}}},"ManageUserSessionSubscriptionPage":{"properties":{"url":{"type":"string","description":"External url that shows the active subscriptions"}}},"ManageUserPasswordSchema":{"type":"object","required":["userid","action"],"properties":{"userid":{"type":"string","description":"Query string param containing the username or email of the user"},"action":{"description":"Action to be taken against user&#039;s password","enum":["send_link","reset","set_new_password","validate_reset_token"],"type":"string"},"new_password":{"type":"string","description":"The new password to assign to the user. Only needed for &quot;reset&quot; and &quot;set_new_password&quot; actions."},"reset_token":{"type":"string","description":"Reset token used only for &quot;reset&quot; and &quot;validate_reset_token&quot; action."},"current_password":{"type":"string","description":"User current password"}}},"ManageUserPasswordResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/ManageUserPasswordData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserPasswordData":{"properties":{"message":{"type":"array","description":"Array with errors","items":{"$ref":"#/definitions/ManageUserPasswordMessage"}},"success":{"type":"boolean","description":"Success or failure to register user"}},"required":["success"]},"ManageUserPasswordMessage":{"properties":{"id":{"type":"string","description":"ID or name of the field"},"retryInMinutes":{"type":"integer","description":"Number of minutes this end-point will be blocked"},"message":{"type":"string","description":"Error message"}},"required":["message"]},"ManageUserRegisterSchema":{"type":"object","required":["userid","user_fields"],"properties":{"userid":{"type":"string","description":"the Username to register"},"email":{"type":"string","description":"User&#039;s email. If the user calling the API is a super admin, the email is optional. In all other cases it&#039;s required."},"firstname":{"type":"string","description":"Required ONLY if checked &quot;First Name and Last Name are required in order to register&quot; in &quot;Advanced Settings&quot;"},"lastname":{"type":"string","description":"Required ONLY if checked &quot;First Name and Last Name are required in order to register&quot; in &quot;Advanced Settings&quot;"},"password":{"type":"string","description":"If one is not provided, the platform will generate it"},"language":{"type":"string","description":"If one is not provided, use the platform default language"},"branch_code":{"type":"string","description":"Org chart branch code or &quot;branch-course&quot; code combination (depending on the setting in Advanced settings)"},"policy":{"$ref":"#/definitions/ManageUserRegisterPolicy","description":"Required ONLY if checked &quot;Privacy policy MUST be accepted&quot; in &quot;Advanced Settings&quot;"},"termsConditions":{"$ref":"#/definitions/ManageUserRegisterTermsConditions","description":"Required ONLY if checked &quot;Terms &amp; Conditions MUST be accepted&quot; in &quot;Advanced Settings&quot;"},"user_fields":{"type":"array","description":"Array of additional user fields created, leave an empty array if no fields are used","items":{"$ref":"#/definitions/ManageUserRegisterUserFields"}}}},"ManageUserRegisterPolicy":{"required":["id","answer"],"properties":{"id":{"type":"integer","description":"Id of policy"},"answer":{"type":"integer","description":"Answer 0 (disagree) or 1 (agree)"},"sub_policies":{"type":"array","description":"Required ONLY if some sub policies are mandatory","items":{"$ref":"#/definitions/ManageUserRegisterSubPolicies"}}}},"ManageUserRegisterSubPolicies":{"required":["id","answer"],"properties":{"id":{"type":"integer","description":"Id of sub policy"},"answer":{"type":"integer","description":"Answer 0 (disagree) or 1 (agree)"}}},"ManageUserRegisterTermsConditions":{"required":["id","answer"],"properties":{"id":{"type":"integer","description":"Id of terms"},"answer":{"type":"integer","description":"Answer 0 (disagree) or 1 (agree)"}}},"ManageUserRegisterUserFields":{"required":["id","value"],"properties":{"id":{"type":"integer","description":"The ID of the additional field"},"value":{"type":"string","description":"The value selected by the user. May be an integer (e.g. for Dropdown additional fields) or string (Text additional field, Textarea additional field)"}}},"ManageUserRegisterResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure to register user with error messages (optional)","items":{"$ref":"#/definitions/ManageUserRegisterData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserRegisterData":{"properties":{"message":{"type":"array","description":"Array with errors","items":{"$ref":"#/definitions/ManageUserRegisterMessage"}},"confirmation_needed":{"type":"boolean","description":"Needed to send confirmation email at self-registration"},"success":{"type":"boolean","description":"Success or failure to register user"},"token_data":{"type":"array","description":"Token data","items":{"$ref":"#/definitions/ManageUserRegisterTokenData"}}},"required":["confirmation_needed","success"]},"ManageUserRegisterMessage":{"properties":{"id":{"type":"string","description":"ID or name of the field"},"message":{"type":"string","description":"Error message"}},"required":["message"]},"ManageUserRegisterTokenData":{"required":["access_token","expires_in","token_type","scope","id_user","has_unfilled_fields"],"properties":{"access_token":{"type":"string","description":"Access token"},"expires_in":{"type":"string","description":"Expires in"},"token_type":{"type":"string","description":"Token type"},"scope":{"type":"string","description":"Scope"},"refresh_token":{"type":"string","description":"Refresh token (if explicitly requested by the client)"},"id_user":{"type":"string","description":"ID user"},"has_unfilled_fields":{"type":"string","description":"Has user unfilled fields"}}},"ManageUserKeepAliveResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserKeepAliveData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserKeepAliveData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"}}},"ManageUserGetUserSettingsResponse":{"required":["data","version","_links","version"],"properties":{"data":{"type":"array","description":"List of all user settings","items":{"$ref":"#/definitions/ManageUserGetUserSettingsData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageUserGetUserSettingsLinks"}}}},"ManageUserGetUserSettingsData":{"properties":{"items":{"type":"array","description":"Array of users info objects","items":{"$ref":"#/definitions/ManageUserGetUserSettingsItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageUserGetUserSettingsSort"}}},"required":["count","has_more_data","current_page","current_page_size"]},"ManageUserGetUserSettingsItems":{"required":["name","value"],"properties":{"name":{"type":"string","description":"Path name of the setting"},"value":{"type":"string","description":"Value of the setting"}}},"ManageUserGetUserSettingsSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageUserGetUserSettingsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageUserSetUserSettingsSchema":{"type":"object","required":["settings"],"properties":{"settings":{"type":"array","description":"Settings to be saved for the particular user, for example &quot;{name: ui.language, value: en}, {name:timezone, value:Europe/Rome}&quot;, etc","items":{"$ref":"#/definitions/ManageUserSetUserSettingsSettings"}}}},"ManageUserSetUserSettingsSettings":{},"ManageUserSetUserSettingsResponse":{"required":["data","version","version","_links","version"],"properties":{"data":{"type":"array","description":"List of all user settings","items":{"$ref":"#/definitions/ManageUserSetUserSettingsData"}},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"type":"array","description":"List of all error messages for failed settings","items":{"$ref":"#/definitions/ManageUserSetUserSettingsExtraData"}},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageUserSetUserSettingsLinks"}}}},"ManageUserSetUserSettingsData":{"properties":{"items":{"type":"array","description":"Array of users info objects","items":{"$ref":"#/definitions/ManageUserSetUserSettingsItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageUserSetUserSettingsSort"}}},"required":["count","has_more_data","current_page","current_page_size"]},"ManageUserSetUserSettingsItems":{"required":["name","value"],"properties":{"name":{"type":"string","description":"Path name of the setting"},"value":{"type":"string","description":"Value of the setting"}}},"ManageUserSetUserSettingsSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageUserSetUserSettingsExtraData":{"properties":{"date_format":{"type":"string","description":"User can&#039;t set custom date format"},"timezone":{"type":"string","description":"User can&#039;t set custom timezone"},"language":{"type":"string","description":"The selected language is not active for the current domain"}}},"ManageUserSetUserSettingsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageUserConfirmEmailSchema":{"type":"object","required":["token"],"properties":{"token":{"type":"string","description":"Token from confirmation email"}}},"ManageUserConfirmEmailResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/ManageUserConfirmEmailData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserConfirmEmailData":{"properties":{"success":{"type":"string","description":"Success or failure to confirm user email"},"message":{"type":"string","description":"Error message"}},"required":["message"]},"ManageUserTempDetailsResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"List of all user settings","items":{"$ref":"#/definitions/ManageUserTempDetailsData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserTempDetailsData":{"required":["user_details","additional_fields","user_settings"],"properties":{"user_details":{"type":"array","description":"Array of user info objects","items":{"$ref":"#/definitions/ManageUserTempDetailsUserDetails"}},"additional_fields":{"type":"array","description":"Array of user fields","items":{"$ref":"#/definitions/ManageUserTempDetailsAdditionalFields"}},"user_settings":{"type":"array","description":"Array of user settings","items":{"$ref":"#/definitions/ManageUserTempDetailsUserSettings"}}}},"ManageUserTempDetailsUserDetails":{"required":["id","user_name","email","firstname","lastname","language","registration_date","confirmed","uuid"],"properties":{"id":{"type":"integer","description":"The ID of user"},"user_name":{"type":"string","description":"The name of user"},"email":{"type":"string","description":"Email of user"},"firstname":{"type":"string","description":"First name of user"},"lastname":{"type":"string","description":"Last name of user"},"language":{"type":"string","description":"Language of user"},"registration_date":{"type":"string","description":"The date of user registration"},"confirmed":{"type":"boolean","description":"Is user confirmed. Options: true or false"},"uuid":{"type":"string","description":"The UUID(Universally unique identifier) of the user"}}},"ManageUserTempDetailsAdditionalFields":{},"ManageUserTempDetailsUserSettings":{},"ManageUserChangeStatusSchema":{"type":"object","required":["user_ids","status"],"properties":{"user_ids":{"type":"array","description":"User IDs","items":{"$ref":"#/definitions/ManageUserChangeStatusUserIds"}},"status":{"type":"string","description":"User status. Options: 1 - activate, 0 - deactivated"}}},"ManageUserChangeStatusUserIds":{},"ManageUserChangeStatusResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/ManageUserChangeStatusData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserChangeStatusData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure to register user"},"updated_ids":{"type":"array","description":"Just updated user IDs","items":{"type":"integer"}},"not_updated_ids":{"type":"array","description":"Not updated user IDs","items":{"type":"integer"}}}},"ManageUserMassEditSchema":{"type":"object","required":["user_ids","password"],"properties":{"user_ids":{"type":"array","description":"Array of user IDs","items":{"type":"integer"}},"password":{"type":"string","description":""},"language":{"type":"string","description":"If one is not provided, use the platform default language"},"expiration":{"type":"string","format":"date","description":"Expiration date"},"email_validation_status":{"type":"integer","description":"Email validation status (0 = unverified, 1 = verified)."},"date_format":{"type":"string","description":"Date format - en, it, bg ..."},"timezone":{"type":"string","description":"Timezone"},"manager":{"$ref":"#/definitions/ManageUserMassEditManager","description":"The ID of the manager of the user"},"additional_fields":{"$ref":"#/definitions/ManageUserMassEditAdditionalFields","description":"Object composed with field_id and value pairs to populate additional fields defined for the users"},"all":{"type":"boolean","description":"If set to true, the update will apply to all users matching the implicit filters."},"userid":{"type":"string","description":"The username of the user (Warning: unique field, risky in mass edit)"},"email":{"type":"string","description":"The email of the user (Warning: unique field, risky in mass edit)"},"cant_have_direct_manager":{"type":"boolean","description":"Permission flag regarding direct manager assignment."},"newsletter_optout":{"type":"integer","description":"Newsletter opt-out setting (1 = opt-out, 0 = opt-in). Only works if feature is enabled."},"date_format_locale":{"type":"string","description":"Locale for the date format."},"avatar":{"type":"string","description":"Path or string for user avatar."},"is_sso_provisioning":{"type":"boolean","description":"Indicates that the update comes from SSO provisioning; affects how additional fields are processed."},"employees":{"type":"array","description":"Array of user IDs that will be assigned as subordinates to this user.","items":{"type":"integer"}},"firstname":{"type":"string","description":"First name of the user (Warning: applies same value to all selected users)"},"lastname":{"type":"string","description":"Last name of the user (Warning: applies same value to all selected users)"},"force_change":{"type":"integer","description":"Force password change on next login (1 = yes, 0 = no). Note: setting this resets &#039;password_changed&#039; flag."},"level":{"type":"integer","description":"User level ID (e.g. User, Power User, Super Admin). Triggers RBAC role updates."},"can_manage_subordinates":{"type":"integer","description":"1 if the user can manage subordinates (Power User manager role), 0 otherwise."},"select_orgchart":{"$ref":"#/definitions/ManageUserMassEditSelectOrgchart","description":"Assign users to branches (nodes). Key is branch ID."}}},"ManageUserMassEditManager":{"required":["__manager_type_id__"],"properties":{"__manager_type_id__":{"type":"integer","description":"The key should be manager type ID, the value - user ID (user who will be the manager). Ex: {&quot;1: &quot;13186&quot;}"}}},"ManageUserMassEditAdditionalFields":{"properties":{"__field_id__":{"type":"string","description":"The key should be the additional field ID, the value may be an integer (e.g. for Dropdown additional fields) or string (Text additional field, Textarea additional field). Ex: {&quot;1&quot;: &quot;new value&quot;}"}}},"ManageUserMassEditSelectOrgchart":{"properties":{"__branch_id__":{"type":"string","description":"The key is the branch ID. The value is ignored but required by the JSON structure (usually 1). Ex: {&quot;28&quot;: 1}"}}},"ManageUserMassEditResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserMassEditData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"type":"array","description":"Information regarding what error was encountered during update (if any)","items":{"type":"object"}}}},"ManageUserMassEditData":{"properties":{"updated":{"type":"array","description":"Array containing ids of updated users (it will not be present if none were updated accordingly)","items":{"type":"integer"}},"not_updated":{"type":"array","description":"Array containing ids of not updated users (it will not be present if all were updated accordingly)","items":{"type":"integer"}}}},"ManageUserAddToBranchSchema":{"type":"object","required":["user_ids","version","branch_ids"],"properties":{"user_ids":{"type":"array","description":"User IDs","items":{"$ref":"#/definitions/ManageUserAddToBranchUserIds"}},"version":{"type":"string","required":"required","description":"Current API version"},"branch_ids":{"type":"array","description":"Branch IDs","items":{"$ref":"#/definitions/ManageUserAddToBranchBranchIds"}}}},"ManageUserAddToBranchUserIds":{},"ManageUserAddToBranchBranchIds":{},"ManageUserAddToBranchResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/ManageUserAddToBranchData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserAddToBranchData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure to register the user"},"valid_user_ids":{"type":"array","description":"Users that exist in DB","items":{"$ref":"#/definitions/ManageUserAddToBranchValidUserIds"}}}},"ManageUserAddToBranchValidUserIds":{"properties":{"invalid_user_ids":{"type":"array","description":"Users that NOT exist in DB","items":{"$ref":"#/definitions/ManageUserAddToBranchInvalidUserIds"}}}},"ManageUserAddToBranchInvalidUserIds":{"properties":{"valid_branch_ids":{"type":"array","description":"Branches that exist in DB","items":{"$ref":"#/definitions/ManageUserAddToBranchValidBranchIds"}}}},"ManageUserAddToBranchValidBranchIds":{"properties":{"invalid_branch_ids":{"type":"array","description":"Branches that NOT exist in DB","items":{"$ref":"#/definitions/ManageUserAddToBranchInvalidBranchIds"}}}},"ManageUserAddToBranchInvalidBranchIds":{"properties":{"already_added_to_branch":{"$ref":"#/definitions/ManageUserAddToBranchAlreadyAddedToBranch","description":"Users that already added to branch"}}},"ManageUserAddToBranchAlreadyAddedToBranch":{"properties":{"successfully_added_to_branch":{"$ref":"#/definitions/ManageUserAddToBranchSuccessfullyAddedToBranch","description":"Users that successfully added to branch"}}},"ManageUserAddToBranchSuccessfullyAddedToBranch":{},"ManageUserRemoveFromBranchSchema":{"type":"object","required":["user_ids","branch_ids"],"properties":{"user_ids":{"type":"array","description":"User IDs","items":{"type":"integer"}},"branch_ids":{"type":"array","description":"Branch IDs","items":{"type":"integer"}}}},"ManageUserRemoveFromBranchResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/ManageUserRemoveFromBranchData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserRemoveFromBranchData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure to register the user"},"valid_user_ids":{"type":"array","description":"Users that exist in DB","items":{"$ref":"#/definitions/ManageUserRemoveFromBranchValidUserIds"}}}},"ManageUserRemoveFromBranchValidUserIds":{"properties":{"invalid_user_ids":{"type":"array","description":"Users that NOT exist in DB","items":{"$ref":"#/definitions/ManageUserRemoveFromBranchInvalidUserIds"}}}},"ManageUserRemoveFromBranchInvalidUserIds":{"properties":{"valid_branch_ids":{"type":"array","description":"Branches that exist in DB","items":{"$ref":"#/definitions/ManageUserRemoveFromBranchValidBranchIds"}}}},"ManageUserRemoveFromBranchValidBranchIds":{"properties":{"invalid_branch_ids":{"type":"array","description":"Branches that NOT exist in DB","items":{"$ref":"#/definitions/ManageUserRemoveFromBranchInvalidBranchIds"}}}},"ManageUserRemoveFromBranchInvalidBranchIds":{"properties":{"successfully_removed_from_branch":{"type":"array","description":"summary about which users have been removed from which branches","items":{"$ref":"#/definitions/ManageUserRemoveFromBranchSuccessfullyRemovedFromBranch"}}}},"ManageUserRemoveFromBranchSuccessfullyRemovedFromBranch":{},"ManageUserMoveToBranchSchema":{"type":"object","required":["user_ids","branch_ids"],"properties":{"user_ids":{"type":"array","description":"User IDs","items":{"type":"integer"}},"branch_ids":{"type":"array","description":"Branch IDs The branch_ids attribute would accept only 1 branch at a time for platforms created after 16/10/2019.","items":{"type":"integer"}}}},"ManageUserMoveToBranchResponse":{"required":["success","version"],"properties":{"success":{"$ref":"#/definitions/ManageUserMoveToBranchSuccess","description":"Success or failure"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserMoveToBranchSuccess":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure to register the user"}}},"ManageUserApproveUserSchema":{"type":"object","required":["user_ids"],"properties":{"user_ids":{"type":"array","description":"ID or array of IDs of the user/s","items":{"type":"integer"}},"all_selected":{"type":"boolean","description":"Indicate whether or not all users should be selected for given filter params(&quot;search_text&quot; and &quot;filters&quot;)"},"search_text":{"type":"string","description":"Search by username (used in pair with the all_selected flag)."},"filters":{"type":"string","description":"URL encoded filter (used in pair with the all_selected flag)."}}},"ManageUserApproveUserResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserApproveUserData","description":"Results of the approve process"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserApproveUserData":{"required":["id_user"],"properties":{"id_user":{"type":"integer","description":"ID of the approved user"}}},"ManageUserRejectUserSchema":{"type":"object","required":["user_ids"],"properties":{"user_ids":{"type":"array","description":"numeric ID or array of numeric user IDs","items":{"type":"integer"}},"all_selected":{"type":"boolean","description":"Indicate whether or not all users should be selected for given filter params(&quot;search_text&quot; and &quot;filters&quot;)"},"search_text":{"type":"string","description":"Search by username (used in pair with the all_selected flag)."},"filters":{"type":"string","description":"URL encoded filter (used in pair with the all_selected flag)."}}},"ManageUserRejectUserResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserRejectUserData","description":"Results of the reject process"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserRejectUserData":{"required":["rejected"],"properties":{"rejected":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageUserRejectUserRejected"}}}},"ManageUserRejectUserRejected":{"required":["id_user"],"properties":{"id_user":{"type":"integer","description":"ID of the rejected user"}}},"ManageUserCheckUsernameResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserCheckUsernameData","description":"Success or failure"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageUserCheckUsernameLinks"}}}},"ManageUserCheckUsernameData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Is username free or not"}}},"ManageUserCheckUsernameLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageUserCheckValidityResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserCheckValidityData","description":"Success or failure"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageUserCheckValidityLinks"}}}},"ManageUserCheckValidityData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Is username free or not"}}},"ManageUserCheckValidityLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageUserResendResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure to register user with error messages (optional)","items":{"$ref":"#/definitions/ManageUserResendData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserResendData":{"properties":{"message":{"type":"string","description":"Error message"},"success":{"type":"boolean","description":"Success or failure"}},"required":["success"]},"ManageUserImporterFieldsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserImporterFieldsData","description":"Response success or failure to find users"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserImporterFieldsData":{"properties":{"fields":{"type":"array","description":"Associative array containing column names and translations","items":{"$ref":"#/definitions/ManageUserImporterFieldsFields"}}}},"ManageUserImporterFieldsFields":{},"ManageUserBatchImportUserSchema":{"type":"object","required":["items","options"],"properties":{"items":{"type":"array","description":"Array of objects, each containing details of a user to import. Maximum size: 100.","items":{"$ref":"#/definitions/ManageUserBatchImportUserItems"}},"options":{"$ref":"#/definitions/ManageUserBatchImportUserOptions","description":"Object containing additional options."}}},"ManageUserBatchImportUserItems":{"properties":{"username":{"type":"string","description":"The unique username for a user. Required if no user_id is specified for the item. Do not fill if the &quot;user_id&quot; field has been specified. Will be ignored if checked &quot;Use Email as Username&quot; in &quot;Advanced Settings&quot;."},"user_id":{"type":"integer","description":"The numeric id for a user. Required if no username is specified for the item. Do not fill if the &quot;username&quot; field has been specified."},"new_username":{"type":"string","description":"If specified, updates the current username with this new one. The update_user_info option must be set as true."},"firstname":{"type":"string","description":"User&#039;s first name"},"lastname":{"type":"string","description":"User&#039;s last name"},"password":{"type":"string","description":"Set a user&#039;s password"},"password_hash":{"type":"string","description":"Pre-encrypted user password (alternative to &quot;password&quot; field). Clients must encrypt using the &quot;bcrypt algorithm&quot; with a cost of 13."},"email":{"type":"string","description":"Set a user&#039;s e-mail address. Required ONLY if no user_id is specified for the item and if checked &quot;Use Email as Username&quot; in &quot;Advanced Settings&quot; ."},"timezone":{"type":"string","description":"Set a user&#039;s timezone, eg: Europe/Rome"},"date_format":{"type":"string","description":"Date format (e.g. &#039;ar&#039;, &#039;ar_dz&#039;, &#039;bg&#039;, &#039;en&#039;, &#039;en-gb&#039;, &#039;en_gb&#039;, &#039;it&#039;, &#039;es&#039;, etc)"},"active":{"type":"boolean","description":"Is a user active (true) or suspended (false)"},"expiration_date":{"type":"string","description":"End the validity of a user account to a certain date. The value can be empty. If not empty, it must bin YYYY-MM-DD format (Eg: 2018-12-31"},"manager_xxx":{"type":"string","description":"Multiple manager types may be added. Simply replace &quot;xxx&quot; with the right manager type ID. Ex: &quot;manager_1&quot;:&quot;username&quot;. Use null to remove the manager association"},"level":{"type":"string","description":"The user&#039;s permissions. This will be either &quot;user&quot;, &quot;poweruser&quot; or &quot;superadmin&quot;. If omitted, defaults to &quot;user&quot;"},"profile":{"type":"string","description":"Will be the profile name for the Power User. Will be ignored if the user level is &quot;user&quot;. If new power user management is active, more profiles can be passed as array ( [&quot;profile1&quot;,&quot;profile2&quot;] ) or as string with | delimitator ( &quot;profile1|profile2&quot; )"},"language":{"type":"string","description":"Set the platform language for the user"},"is_manager":{"type":"boolean","description":"Flag determining if the user is a manager or not"},"branch_name_path":{"type":"string","description":"Points to a full branch path, separated by slashes. If any part of the branch does not exist yet, it will be automatically created if the &quot;force_create_branches&quot; is TRUE (eg: branch 1/branch 2/branch 3). If no one are found, the &quot;destination_branch&quot; options field will be used as fallback"},"branch_code_path":{"type":"string","description":"Points to the codes of a full branch path, separated by slashes. If a part of the branch does not exist yet, it will be automatically created if the &quot;force_create_branches&quot; is TRUE (eg: b01/b02/b03). In order to create a new branch, both name and code are required. They must be composed of the same structure. If something fails, an error will be shown. If no one are found, the &quot;destination_branch&quot; options field will be used as fallback."},"branch_name":{"type":"string","description":"Identify a branch by name. It is used if &quot;branch_name_path&quot; or &quot;branch_code_path&quot; fields are not provided. If the branch is not found, the &quot;destination_branch&quot; options field will be used as fallback. If multiple branches with the same name are found, an error will be shown."},"branch_code":{"type":"string","description":"Identify a branch by its code. It is used if &quot;branch_name&quot; field is not provided. If not found, the &quot;destination_branch&quot; options field will be used as fallback. If multiple branches with the same code are found, an error will be shown."},"field_xxx":{"type":"string","description":"Multiple additional fields may be added. Simply replace &quot;xxx&quot; with the right field ID (do not use the &quot;human&quot; additional field name"}}},"ManageUserBatchImportUserOptions":{"required":["change_user_password","update_user_info","ignore_password_change_for_existing_users","powerUser_option","branch_option"],"properties":{"change_user_password":{"type":"boolean","description":"If set to true, all newly created users will need to update their password when first logging in"},"update_user_info":{"type":"boolean","description":"If set to true, if a listed user already exists, his details will be updated, if set to false, an error will be logged for each existing user"},"ignore_password_change_for_existing_users":{"type":"boolean","description":"If set to false, all updated users will need to updates their password when logging in next time (only has any effect when update_existing_users is true as well"},"powerUser_option":{"type":"string","description":"Can be &quot;no_association&quot;, &quot;assigned_branch&quot; or &quot;assigned_branch_descendants&quot;. When &quot;no_association&quot; is selected he will not get associated. When &quot;assigned_branch&quot; or &quot;assigned_branch_descendants&quot; is selected he will be automatically assigned to the branch or to the branch and the descendants he is added to (reflects branch_name, branch_code, branch_name_path and branch_code_path settings)."},"destination_branch":{"type":"string","description":"Refers to the internal ID for a branch used as a fallback when no one of &quot;branch_name_path&quot;, &quot;branch_code_path&quot;, &quot;branch_name&quot; or &quot;branch_code&quot; settings have been set or found. This parameter is mandatory only when &quot;branch_option&quot; is &quot;existing&quot;!"},"branch_option":{"type":"string","description":"Can be &quot;existing&quot; or &quot;do_nothing&quot;. When &quot;existing&quot; is selected, an error will be thrown when not a unique branch can be identified. When &quot;do_nothing&quot; is selected, &quot;update_user_info&quot; is set to TRUE and there is no branch mapped for the current user then user&#039;s branches will not be changed."},"force_create_branches":{"type":"boolean","description":"When &quot;force_create_branches&quot; is selected, &quot;branch_name_path&quot; and &quot;branch_code_path&quot; are used and both columns have proper value, a new branch will be created."},"user_destination_branch_action":{"description":"This parameter would not be working for platforms created after 16/10/2019. If it&#039;s not provided the users would be added to new branches. If it&#039;s set to &quot;add&quot; the users would be added to new branches. If it&#039;s value is &quot;move&quot;, the users would be added to new branches and removed from all the previous ones.","enum":["add","move"],"type":"string"},"send_notification_email":{"type":"boolean","description":"Indicates whether to send the notification to the created users"},"multi_profiles_mode":{"description":"Add_profile will add the new profile to power user without modify the already assigned profile. Overwrite_profiles remove the already assigned profile to assign only the new ones. Default overwrite_profiles. This parameter would work only if the new power user management is active.","enum":["add_profiles","overwrite_profiles"],"type":"string"},"provisioned_by":{"type":"string","description":"External provisioning source"}}},"ManageUserBatchImportUserResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/ManageUserBatchImportUserData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources.","items":{"$ref":"#/definitions/ManageUserBatchImportUserLinks"}}}},"ManageUserBatchImportUserData":{"required":["row_index","success","message","output"],"properties":{"row_index":{"type":"integer","description":"Import ID for the current record"},"success":{"type":"boolean","description":"Could the record be properly imported?"},"message":{"type":"string","description":"Optional error message"},"output":{"$ref":"#/definitions/ManageUserBatchImportUserOutput","description":"An output object, empty in case of errors, populated in case of success"}}},"ManageUserBatchImportUserOutput":{"properties":{"user_id":{"type":"integer","description":"The ID of the user created/updated"},"username":{"type":"string","description":"The username of the user created/updated"},"error":{"type":"string","description":"The optional error message"},"uuid":{"type":"string","description":"The UUID (universally unique identifier) of the user"}}},"ManageUserBatchImportUserLinks":{},"ManageUserQuickRegistrationSchema":{"type":"object","properties":{"email":{"type":"string","description":"User&#039;s email"},"privacy_policy":{"type":"string","description":"Has user accepted Privacy Policy. Options: &#039;on&#039;"},"policy":{"type":"array","description":"Required ONLY if checked &quot;Privacy policy MUST be accepted&quot; in &quot;Advanced Settings&quot;","items":{"$ref":"#/definitions/ManageUserQuickRegistrationPolicy"}},"issue_refresh_token":{"type":"boolean","description":"Whether the response should include a refresh token or not. Default = false"}},"required":["policy"]},"ManageUserQuickRegistrationPolicy":{"required":["id","answer"],"properties":{"id":{"type":"integer","description":"Id of policy"},"answer":{"type":"integer","description":"Answer 0 (disagree) or 1 (agree)"},"sub_policies":{"$ref":"#/definitions/ManageUserQuickRegistrationSubPolicies","description":""}}},"ManageUserQuickRegistrationSubPolicies":{"required":["id","answer"],"properties":{"id":{"type":"integer","description":"Id of sub policy"},"answer":{"type":"integer","description":"Answer 0 (disagree) or 1 (agree)"}}},"ManageUserQuickRegistrationResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure to register user with error messages (optional)","items":{"$ref":"#/definitions/ManageUserQuickRegistrationData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserQuickRegistrationData":{"properties":{"message":{"type":"array","description":"Array with errors","items":{"$ref":"#/definitions/ManageUserQuickRegistrationMessage"}},"confirmation_needed":{"type":"boolean","description":"Needed to send confirmation email at self-registration"},"success":{"type":"boolean","description":"Success or failure to register user"},"token_data":{"type":"array","description":"Token data","items":{"$ref":"#/definitions/ManageUserQuickRegistrationTokenData"}}},"required":["confirmation_needed","success"]},"ManageUserQuickRegistrationMessage":{"properties":{"id":{"type":"string","description":"ID or name of the field"},"message":{"type":"string","description":"Error message"}},"required":["message"]},"ManageUserQuickRegistrationTokenData":{"required":["access_token","expires_in","token_type","scope","id_user","has_unfilled_fields"],"properties":{"access_token":{"type":"string","description":"Access token"},"expires_in":{"type":"string","description":"Expires in"},"token_type":{"type":"string","description":"Token type"},"scope":{"type":"string","description":"Scope"},"refresh_token":{"type":"string","description":"Refresh token (if explicitly requested by the client)"},"id_user":{"type":"string","description":"ID user"},"has_unfilled_fields":{"type":"string","description":"Has user unfilled fields"}}},"ManageUserSendNotificationSchema":{"type":"object","required":["user_ids"],"properties":{"user_ids":{"type":"array","description":"User IDs","items":{"$ref":"#/definitions/ManageUserSendNotificationUserIds"}},"skip_check":{"type":"boolean","description":"By providing &quot;true&quot; you can skip check if someone of users has already recieved this notification. Default: false"}}},"ManageUserSendNotificationUserIds":{},"ManageUserSendNotificationResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserSendNotificationData","description":"Data"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserSendNotificationData":{"required":["user_ids"],"properties":{"user_ids":{"type":"array","description":"- Users that will recieve notification","items":{"type":"integer"}}}},"ManageUserGetUserDomainsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserGetUserDomainsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageUserGetUserDomainsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageUserGetUserDomainsData":{"required":["items"],"properties":{"items":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageUserGetUserDomainsItems"}},"logos":{"$ref":"#/definitions/ManageUserGetUserDomainsLogos","description":"Logo from the active platform theme, present only when a theme logo is configured"}}},"ManageUserGetUserDomainsItems":{"required":["id","name","url","domain_url","branch_path"],"properties":{"id":{"type":"integer","description":"The domain id"},"name":{"type":"string","description":"The domain name"},"url":{"type":"string","description":"The domain url"},"domain_url":{"type":"string","description":"The domain url without the &#039;http&#039; or &#039;https&#039; part"},"branch_path":{"type":"array","description":"The path to the assigned chart node from the root node","items":{"type":"string"}}}},"ManageUserGetUserDomainsLogos":{"required":["companyLogo","logo_url"],"properties":{"companyLogo":{"type":"string","description":"Raw logo path as stored in theme settings"},"logo_url":{"type":"string","description":"Resolved public URL of the company logo"}}},"ManageUserGetUserDomainsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/ManageUserGetUserDomainsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ManageUserGetUserDomainsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ManageUserGetUserDomainsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ManageUserGetUserDomainsLast","description":"Link to the last page"}}},"ManageUserGetUserDomainsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"ManageUserGetUserDomainsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"ManageUserGetUserDomainsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"ManageUserGetUserDomainsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"ManageUserDetailsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserDetailsData","description":"List of all retrieved course enrollments"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserDetailsData":{"required":["user_data","enrollments","subscriptions","badges","transactions"],"properties":{"user_data":{"$ref":"#/definitions/ManageUserDetailsUserData","description":""},"enrollments":{"type":"boolean","description":"True if have data, otherwise false"},"subscriptions":{"type":"boolean","description":"True if have data, otherwise false"},"badges":{"type":"boolean","description":"True if have data, otherwise false"},"transactions":{"type":"boolean","description":"True if have data, otherwise false"}}},"ManageUserDetailsUserData":{"required":["source","destination"],"properties":{"source":{"$ref":"#/definitions/ManageUserDetailsSource","description":"Source user object"},"destination":{"$ref":"#/definitions/ManageUserDetailsDestination","description":"Destination user object"}}},"ManageUserDetailsSource":{"required":["user_id","username","first_name","last_name","email","avatar","force_change","expiration","level","date_format","timezone","email_validation_status","valid","manager_first_name","manager_last_name"],"properties":{"user_id":{"type":"integer","description":"User ID"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email of the user"},"avatar":{"type":"string","description":"Avatar of the user"},"force_change":{"type":"string","description":"Force user to change password"},"expiration":{"type":"string","format":"date","description":"Expiration date of an user. It is available only for NOT pending users"},"level":{"type":"integer","description":"Level of an user. It is available only for NOT pending users"},"date_format":{"type":"string","description":"Date format (e.g. &#039;ar&#039;, &#039;ar_dz&#039;, &#039;bg&#039;, &#039;en&#039;, &#039;en-gb&#039;, &#039;it&#039;, &#039;es&#039;, etc)"},"timezone":{"type":"string","description":"Timezone (epl. &#039;Europe/Sofia&#039;)"},"email_validation_status":{"type":"integer","description":"Email validation status of an user. It is available only for NOT pending users"},"valid":{"type":"integer","description":"Is user active. Options: 0 - not active, 1 - active"},"manager_first_name":{"type":"string","description":"Manager first name. It is available only for NOT pending users"},"manager_last_name":{"type":"string","description":"Manager last name. It is available only for NOT pending users"}}},"ManageUserDetailsDestination":{"required":["user_id","username","first_name","last_name","email","avatar","force_change","expiration","level","date_format","timezone","email_validation_status","valid","manager_first_name","manager_last_name"],"properties":{"user_id":{"type":"integer","description":"User ID"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email of the user"},"avatar":{"type":"string","description":"Avatar of the user"},"force_change":{"type":"string","description":"Force user to change password"},"expiration":{"type":"string","format":"date","description":"Expiration date of an user. It is available only for NOT pending users"},"level":{"type":"integer","description":"Level of an user. It is available only for NOT pending users"},"date_format":{"type":"string","description":"Date format (e.g. &#039;ar&#039;, &#039;ar_dz&#039;, &#039;bg&#039;, &#039;en&#039;, &#039;en-gb&#039;, &#039;it&#039;, &#039;es&#039;, etc)"},"timezone":{"type":"string","description":"Timezone (epl. &#039;Europe/Sofia&#039;)"},"email_validation_status":{"type":"integer","description":"Email validation status of an user. It is available only for NOT pending users"},"valid":{"type":"integer","description":"Is user active. Options: 0 - not active, 1 - active"},"manager_first_name":{"type":"string","description":"Manager first name. It is available only for NOT pending users"},"manager_last_name":{"type":"string","description":"Manager last name. It is available only for NOT pending users"}}},"ManageUserMergeUsersSchema":{"type":"object","properties":{"change_data":{"$ref":"#/definitions/ManageUserMergeUsersChangeData","description":"All the data for change"}}},"ManageUserMergeUsersChangeData":{"properties":{"user_data":{"$ref":"#/definitions/ManageUserMergeUsersUserData","description":"Changed user data"},"enrollments":{"type":"array","description":"Changed user enrollments","items":{"$ref":"#/definitions/ManageUserMergeUsersEnrollments"}},"merge_user_information":{"type":"boolean","description":"Merge user information. If false the information for the destination user will take priority"}}},"ManageUserMergeUsersUserData":{"properties":{"first_name":{"type":"string","description":"Destination user first name"},"last_name":{"type":"string","description":"Destination user last name"},"language":{"type":"string","description":"Destination user language"},"timezone":{"type":"string","description":"Destination user timezone"},"role_id":{"type":"integer","description":"Destination user role ID"},"expiration":{"type":"string","description":"Destination user expiration date"}}},"ManageUserMergeUsersEnrollments":{"properties":{"old_user_id":{"type":"integer","description":"Original user for enrollment"},"course_id":{"type":"integer","description":"Destination user course ID"}}},"ManageUserMergeUsersResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserMergeUsersData","description":"Results of the merge process"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserMergeUsersData":{"required":["id"],"properties":{"id":{"type":"integer","description":"ID of the successfully merged destination user"}}},"ManageUserListEnrollmentsResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserListEnrollmentsData","description":"List of all retrieved course enrollments"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageUserListEnrollmentsLinks"}}}},"ManageUserListEnrollmentsData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"$ref":"#/definitions/ManageUserListEnrollmentsItems","description":"Return enrollments objects"},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageUserListEnrollmentsSort"}}}},"ManageUserListEnrollmentsItems":{"required":["course_id","course_name","type","lang_code","code","users"],"properties":{"course_id":{"type":"integer","description":"ID of the course"},"course_name":{"type":"string","description":"Course name"},"type":{"type":"string","description":"Course type"},"lang_code":{"type":"string","description":"Course language code"},"code":{"type":"string","description":"Course code"},"users":{"$ref":"#/definitions/ManageUserListEnrollmentsUsers","description":""}}},"ManageUserListEnrollmentsUsers":{"required":["source","destination"],"properties":{"source":{"$ref":"#/definitions/ManageUserListEnrollmentsSource","description":"Return source user object"},"destination":{"$ref":"#/definitions/ManageUserListEnrollmentsDestination","description":"Return destination user object"}}},"ManageUserListEnrollmentsSource":{"required":["id","status","status_label","score","date_complete","selected"],"properties":{"id":{"type":"integer","description":"ID of the source user"},"status":{"type":"integer","description":"Enrollment status"},"status_label":{"type":"string","description":"Enrollment status label"},"score":{"type":"number","format":"float","description":"Enrollment score"},"date_complete":{"type":"string","description":"Course complete date"},"selected":{"type":"boolean","description":"Flag for default state"}}},"ManageUserListEnrollmentsDestination":{"required":["id","status","status_label","score","date_complete","selected"],"properties":{"id":{"type":"integer","description":"ID of the destination user"},"status":{"type":"integer","description":"Enrollment status"},"status_label":{"type":"string","description":"Enrollment status label"},"score":{"type":"number","format":"float","description":"Enrollment score"},"date_complete":{"type":"string","description":"Course complete date"},"selected":{"type":"boolean","description":"Flag for default state"}}},"ManageUserListEnrollmentsSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageUserListEnrollmentsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageUserListBadgesResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserListBadgesData","description":"List of all retrieved badges"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageUserListBadgesLinks"}}}},"ManageUserListBadgesData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"$ref":"#/definitions/ManageUserListBadgesItems","description":"Return badges objects"},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageUserListBadgesSort"}}}},"ManageUserListBadgesItems":{"required":["id","badge_name","icon","points"],"properties":{"id":{"type":"integer","description":"ID of the badge"},"badge_name":{"type":"string","description":"Badge name"},"icon":{"type":"string","description":"Badge icon"},"points":{"type":"integer","description":"Badge points"}}},"ManageUserListBadgesSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageUserListBadgesLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageUserListTransactionsResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserListTransactionsData","description":"List of all retrieved transactions"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageUserListTransactionsLinks"}}}},"ManageUserListTransactionsData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"$ref":"#/definitions/ManageUserListTransactionsItems","description":"Return transaction objects"},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageUserListTransactionsSort"}}}},"ManageUserListTransactionsItems":{"required":["id_trans","date_creation","date_activated","discount","payment_currency","subtotal","id_user","total_paid"],"properties":{"id_trans":{"type":"integer","description":"ID of the transaction"},"date_creation":{"type":"string","description":"Date of creation of the transaction"},"date_activated":{"type":"string","description":"Date of activation of the transaction"},"discount":{"type":"integer","description":"Transaction discount"},"payment_currency":{"type":"string","description":"Transaction payment currency"},"subtotal":{"type":"integer","description":"Transaction subtotal"},"id_user":{"type":"integer","description":"ID of the user for this transaction"},"total_paid":{"type":"integer","description":"Transaction total paid value"}}},"ManageUserListTransactionsSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageUserListTransactionsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageUserListSubscriptionsResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserListSubscriptionsData","description":"List of all retrieved subscription seat associations"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageUserListSubscriptionsLinks"}}}},"ManageUserListSubscriptionsData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"$ref":"#/definitions/ManageUserListSubscriptionsItems","description":"Return subscription seat association objects"},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageUserListSubscriptionsSort"}}}},"ManageUserListSubscriptionsItems":{"required":["id","user_id","expiration_date","bundle_id","bundle_name","plan_id","plan_name","record_id","record_code"],"properties":{"id":{"type":"integer","description":"Subscription seat association ID"},"user_id":{"type":"integer","description":"Subscription seat association user ID"},"expiration_date":{"type":"string","format":"date","description":"Subscription seat association seat end date"},"bundle_id":{"type":"integer","description":"Subscription seat association bundle ID"},"bundle_name":{"type":"string","description":"Subscription seat association bundle name"},"plan_id":{"type":"integer","description":"Subscription seat association plan ID"},"plan_name":{"type":"string","description":"Subscription seat association record name"},"record_id":{"type":"integer","description":"Subscription seat association record ID"},"record_code":{"type":"string","description":"Subscription seat association record code"}}},"ManageUserListSubscriptionsSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageUserListSubscriptionsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageUserGetSubordinatesResponse":{"required":["data","version","_links","version"],"properties":{"data":{"type":"array","description":"List of all retrieved users","items":{"$ref":"#/definitions/ManageUserGetSubordinatesData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageUserGetSubordinatesLinks"}}}},"ManageUserGetSubordinatesData":{"properties":{"items":{"type":"array","description":"Array of users info objects","items":{"$ref":"#/definitions/ManageUserGetSubordinatesItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageUserGetSubordinatesSort"}}},"required":["count","has_more_data","cursor","current_page","current_page_size"]},"ManageUserGetSubordinatesItems":{"required":["user_id","username","name","surname","email"],"properties":{"user_id":{"type":"integer","description":"Numeric ID of an user"},"username":{"type":"string","description":"Username"},"name":{"type":"string","description":"First name of user"},"surname":{"type":"string","description":"Surname of user"},"email":{"type":"string","description":"Email of user"}}},"ManageUserGetSubordinatesSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageUserGetSubordinatesLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageUserMyManagersResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserMyManagersData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserMyManagersData":{"required":["items"],"properties":{"items":{"type":"array","description":"List of managers","items":{"$ref":"#/definitions/ManageUserMyManagersItems"}}}},"ManageUserMyManagersItems":{"required":["manager_id","manager_avatar","manager_username","manager_fullname","manager_firstname","manager_lastname","manager_email","manager_types"],"properties":{"manager_id":{"type":"integer","description":"Manager id"},"manager_avatar":{"type":"string","description":"Manager avatar url"},"manager_username":{"type":"string","description":"Manager username"},"manager_fullname":{"type":"string","description":"Manager fullname"},"manager_firstname":{"type":"string","description":"Manager firstname"},"manager_lastname":{"type":"string","description":"Manager lastname"},"manager_email":{"type":"string","description":"Manager email"},"manager_types":{"type":"array","description":"Manager types","items":{"$ref":"#/definitions/ManageUserMyManagersManagerTypes"}}}},"ManageUserMyManagersManagerTypes":{"required":["relation_id","id","name","status","last_update"],"properties":{"relation_id":{"type":"integer","description":"Id of the manager subordinate relation record"},"id":{"type":"integer","description":"Manager type id"},"name":{"type":"string","description":"Manager type name"},"status":{"type":"string","description":"Approval status Possible values (&#039;confirmed&#039;, &#039;not_confirmed&#039;, &#039;pending&#039;, &#039;imported&#039;)"},"last_update":{"type":"string","description":"Datetime of the last subordinate status change"}}},"ManageUserNewsletterSchema":{"type":"object","required":["token"],"properties":{"token":{"type":"opt","description":"Encrypted string"}}},"ManageUserNewsletterResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/ManageUserNewsletterData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserNewsletterData":{"properties":{"success":{"type":"string","description":"Success or failure to opt-out newsletter"},"message":{"type":"string","description":"Error message"}},"required":["message"]},"ManageUserDownloadEventsResponse":{"properties":{"version":{"type":"string","required":"required","description":"Current API version"}},"required":["version"]},"ManageUserBatchDeleteSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"An array of user IDs to be deleted","items":{"type":"integer"}}}},"ManageUserBatchDeleteResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Response array of deleted users IDs","items":{"$ref":"#/definitions/ManageUserBatchDeleteData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserBatchDeleteData":{"required":["user_id","success"],"properties":{"user_id":{"type":"string","description":"The ID of the user"},"success":{"type":"integer","description":"Whether the operation was successful"}}},"ManageUserActivitiesResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserActivitiesData","description":"User activities statistics"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserActivitiesData":{"properties":{"sessions":{"$ref":"#/definitions/ManageUserActivitiesSessions","description":"User&#039;s LMS activity based on the time frame"},"enrollments":{"$ref":"#/definitions/ManageUserActivitiesEnrollments","description":"User&#039;s enrollments ion courses based on the time frame"},"best_score_in_classroom":{"$ref":"#/definitions/ManageUserActivitiesBestScoreInClassroom","description":"Users scores in classroom courses, ordered by best evaluation score based on percentage of evaluation (score / base_score) * 100"}}},"ManageUserActivitiesSessions":{"properties":{"month":{"type":"string","description":"Number of the month"},"day":{"type":"string","description":"Number of the day"},"count":{"type":"string","description":"Total number of session for the current month/day"}},"required":["count"]},"ManageUserActivitiesEnrollments":{"properties":{"month":{"type":"string","description":"Number of the month"},"day":{"type":"string","description":"Number of the day"},"count":{"type":"string","description":"Total number of enrollments for the current month/day"}},"required":["count"]},"ManageUserActivitiesBestScoreInClassroom":{"required":["score","course_title","url"],"properties":{"score":{"$ref":"#/definitions/ManageUserActivitiesScore","description":"User score information"},"course_title":{"type":"string","description":"The name of the classroom course"},"url":{"type":"string","description":"The route of the classroom course"}}},"ManageUserActivitiesScore":{"required":["evaluation_score","base_score"],"properties":{"evaluation_score":{"type":"integer","description":"User&#039;s evaluation score"},"base_score":{"type":"integer","description":"Score base of the classroom session"}}},"ManageUserLevelsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserLevelsData","description":"Access token data"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserLevelsData":{"required":["levels"],"properties":{"levels":{"$ref":"#/definitions/ManageUserLevelsLevels","description":"The array of levels, available on this platform."},"power_user_profiles":{"$ref":"#/definitions/ManageUserLevelsPowerUserProfiles","description":"The array of power user profiles, only available if the Power user app is enabled"}}},"ManageUserLevelsLevels":{"required":["id","codename","name"],"properties":{"id":{"type":"integer","description":"The internal ID of this level. Represents a PK in the core_group table"},"codename":{"type":"string","description":"The codename of this level. For example &quot;/framework/level/godadmin&quot;"},"name":{"type":"string","description":"A localized friendly name of this level. For example &quot;Super admin&quot;"}}},"ManageUserLevelsPowerUserProfiles":{"required":["id","codename","name"],"properties":{"id":{"type":"integer","description":"The internal ID of this power user profile. Represents a PK in the core_group table"},"codename":{"type":"string","description":"The codename of this power user profile. For example &quot;/framework/adminrules/Country manager&quot;"},"name":{"type":"string","description":"A friendly name of this power user profile"}}},"ManageUserSendMailSchema":{"type":"object","required":["id_user","subject","message"],"properties":{"id_user":{"type":"integer","description":"ID of LMS user"},"subject":{"type":"string","description":"Subject of the email"},"message":{"type":"string","description":"Message body of the email"}}},"ManageUserSendMailResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserSendMailData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/ManageUserSendMailLinks"}}}},"ManageUserSendMailData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of operation"}}},"ManageUserSendMailLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageUserGetGroupsResponse":{"required":["results","version"],"properties":{"results":{"$ref":"#/definitions/ManageUserGetGroupsResults","description":"Result object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserGetGroupsResults":{"required":["groups","folders","groups_ids"],"properties":{"groups":{"type":"array","description":"Array of group names the user is member of","items":{"type":"string"}},"folders":{"type":"array","description":"Array of org chart folders the user is assigned to","items":{"type":"string"}},"groups_ids":{"type":"array","description":"Array of group ids the user is member of","items":{"type":"string"}}}},"ManageUserMenuResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserMenuData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"","items":{"$ref":"#/definitions/ManageUserMenuLinks"}}}},"ManageUserMenuData":{"required":["menu"],"properties":{"menu":{"type":"array","description":"Array of menu items","items":{"$ref":"#/definitions/ManageUserMenuMenu"}}}},"ManageUserMenuMenu":{"required":["id","label"],"properties":{"id":{"type":"string","description":"The unique identifier of the menu item"},"label":{"type":"string","description":"The display label of the menu item"},"url":{"type":"string","description":"The URL of the menu item (excluded if null or empty)"},"open_in_new_tab":{"type":"boolean","description":"Whether the menu item should open in a new tab (excluded if false)"},"is_new":{"type":"boolean","description":"Whether the menu item is marked as new (excluded if false)"},"is_highlighted":{"type":"boolean","description":"Whether the menu item is highlighted (excluded if false)"},"icon_name":{"type":"string","description":"The name of the icon to display (excluded if empty)"},"favorite":{"type":"boolean","description":"Whether the menu item is marked as favorite (excluded if false)"},"children":{"type":"array","description":"Nested array of child menu items with the same structure (excluded if empty, recursive structure)","items":{"type":"object"}}}},"ManageUserMenuLinks":{},"ManageUserExportCertificatesDataSchema":{"type":"object","required":["user_ids","export_learning_data","share_download_link"],"properties":{"user_ids":{"type":"array","description":"Array of ids of all users for which data is being exported","items":{"$ref":"#/definitions/ManageUserExportCertificatesDataUserIds"}},"export_learning_data":{"type":"boolean","description":"Boolean to decide whether to export learning data"},"share_download_link":{"type":"boolean","description":"Boolean to decide whether to make the link available to all PUs and SAs"},"learning_data":{"$ref":"#/definitions/ManageUserExportCertificatesDataLearningData","description":"Object containing a set of objects with information about the courses and learning plan data to be exported. Required if export_learning_data is true"}}},"ManageUserExportCertificatesDataUserIds":{},"ManageUserExportCertificatesDataLearningData":{"required":["file_format","separator","include_headers","learner_data","courses_data","learning_plans_data"],"properties":{"file_format":{"description":"Format of the files generated by the export process","enum":["csv","xlsx"],"type":"string"},"separator":{"type":"string","description":"Separator chosen by the user to separate the exported data in every file rows"},"include_headers":{"type":"boolean","description":"Boolean to decide if include the headers in the first row of generated files"},"learner_data":{"$ref":"#/definitions/ManageUserExportCertificatesDataLearnerData","description":"Object of booleans to export the details of a course"},"courses_data":{"$ref":"#/definitions/ManageUserExportCertificatesDataCoursesData","description":"Object of booleans to export the details of a course"},"learning_plans_data":{"$ref":"#/definitions/ManageUserExportCertificatesDataLearningPlansData","description":"Object of booleans to export the details of a learning plan"}}},"ManageUserExportCertificatesDataLearnerData":{"properties":{"user_id":{"type":"boolean","description":"Boolean to decide whether to export a user&#039;s id"},"user_firstname":{"type":"boolean","description":"Boolean to decide whether to export a user&#039;s firstname"},"user_lastname":{"type":"boolean","description":"Boolean to decide whether to export a user&#039;s lastname"},"user_email":{"type":"boolean","description":"Boolean to decide whether to export a user&#039;s email"}}},"ManageUserExportCertificatesDataCoursesData":{"properties":{"course_code":{"type":"boolean","description":"Boolean to decide whether to export a course&#039;s code"},"course_title":{"type":"boolean","description":"Boolean to decide whether to export a course&#039;s title"},"course_type":{"type":"boolean","description":"Boolean to decide whether to export a course&#039;s type"},"course_enrolment_date":{"type":"boolean","description":"Boolean to decide whether to export a user&#039;s enrolment date for a course"},"course_enrolment_type":{"type":"boolean","description":"Boolean to decide whether to export a user&#039;s enrolment type for a course"},"course_enrolment_status":{"type":"boolean","description":"Boolean to decide whether to export a user&#039;s enrolment status for a course"},"course_completion_date":{"type":"boolean","description":"Boolean to decide whether to export a user&#039;s completion date for a course"},"certificate_filename":{"type":"boolean","description":"Boolean to decide whether to export a course&#039;s certificate filename"}}},"ManageUserExportCertificatesDataLearningPlansData":{"properties":{"learning_plan_code":{"type":"boolean","description":"Boolean to decide whether to export the code of a learning plan"},"learning_plan_title":{"type":"boolean","description":"Boolean to decide whether to export the title of a learning plan"},"learning_plan_type":{"type":"boolean","description":"Boolean to decide whether to export the type of learning plan"},"learning_plan_enrolment_date":{"type":"boolean","description":"Boolean to decide whether to export a user&#039;s enrolment date for a learning plan"},"learning_plan_enrolment_status":{"type":"boolean","description":"Boolean to decide whether to export a user&#039;s enrolment status for a learning plan"},"learning_plan_completion_date":{"type":"boolean","description":"Boolean to decide whether to export a user&#039;s completion date for a learning plan"},"certificate_filename":{"type":"boolean","description":"Boolean to decide whether to export a certificate filename of a learning plan"}}},"ManageUserExportCertificatesDataResponse":{"required":["version","version","_links","version","data","version"],"properties":{"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageUserExportCertificatesDataLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"},"data":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/ManageUserExportCertificatesDataData"}}}},"ManageUserExportCertificatesDataLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/ManageUserExportCertificatesDataSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/ManageUserExportCertificatesDataGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/ManageUserExportCertificatesDataFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/ManageUserExportCertificatesDataLast","description":"Link to the last page"}}},"ManageUserExportCertificatesDataSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"ManageUserExportCertificatesDataGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"ManageUserExportCertificatesDataFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"ManageUserExportCertificatesDataLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"ManageUserExportCertificatesDataData":{"required":["job_id","success"],"properties":{"job_id":{"type":"integer","description":"ID of the background job created"},"success":{"type":"boolean","description":"Whether the operation was successful"}}},"ManageUserAddMenuFavoriteResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserAddMenuFavoriteData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserAddMenuFavoriteData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure"}}},"ManageUserRemoveMenuFavoriteResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserRemoveMenuFavoriteData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserRemoveMenuFavoriteData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure"}}},"ManageUserfieldCreateSchema":{"type":"object","required":["type","translations"],"properties":{"type":{"type":"string","description":"User field type. Options: date, dropdown, textfield, textarea, etc"},"translations":{"$ref":"#/definitions/ManageUserfieldCreateTranslations","description":"Array of translations, the system default language translation is mandatory"},"mandatory":{"type":"integer","description":"Mandatory - 1 or Not mandatory - 0. Default - 0"},"invisible_to_user":{"type":"integer","description":"User field is visible for users - 0 or not visible - 1. Default - 0"},"settings":{"$ref":"#/definitions/ManageUserfieldCreateSettings","description":"Settings - it&#039;s reqired if field type is &#039;iframe&#039;"},"dropdown_options":{"type":"array","description":"Array of dropdown options. If type of user field is dropdown, this parameter becomes required","items":{"$ref":"#/definitions/ManageUserfieldCreateDropdownOptions"}}}},"ManageUserfieldCreateTranslations":{"required":["__language_code__"],"properties":{"__language_code__":{"type":"string","description":"The key is code of the language or all - the value is title. For example en, all"}}},"ManageUserfieldCreateSettings":{"properties":{"url":{"type":"string","description":"Url - it&#039;s reqired if field type is &#039;iframe&#039;"},"field_name":{"type":"string","description":"Field name - it&#039;s reqired if field type is &#039;iframe&#039;"},"iframe_height":{"type":"string","description":"Iframe height - it&#039;s reqired if field type is &#039;iframe&#039;"}}},"ManageUserfieldCreateDropdownOptions":{"required":["translations"],"properties":{"translations":{"$ref":"#/definitions/ManageUserfieldCreateTranslationsL2","description":"Array of translations, the system default language translation is mandatory"}}},"ManageUserfieldCreateTranslationsL2":{"required":["language_code"],"properties":{"language_code":{"type":"string","description":"The key is the language or all - the value is title. For example english, all"}}},"ManageUserfieldCreateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserfieldCreateData","description":"ID of the created record"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserfieldCreateData":{"required":["user_field_id"],"properties":{"user_field_id":{"type":"integer","description":"The internal ID for the newly created user field"}}},"ManageUserfieldDeleteResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserfieldDeleteData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageUserfieldDeleteLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"ManageUserfieldDeleteData":{"required":["errors","deleted"],"properties":{"errors":{"$ref":"#/definitions/ManageUserfieldDeleteErrors","description":"Errors during process"},"deleted":{"type":"string","description":"ID of the successfully deleted item"}}},"ManageUserfieldDeleteErrors":{"required":["message"],"properties":{"message":{"type":"string","description":"Process that generated an error"}}},"ManageUserfieldDeleteLinks":{},"ManageUserfieldIndexResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserfieldIndexData","description":"List of all retrieved user fields"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/ManageUserfieldIndexLinks","description":"Links to pages"}}},"ManageUserfieldIndexData":{"required":["items"],"properties":{"items":{"type":"array","description":"Array of user fields info objects","items":{"$ref":"#/definitions/ManageUserfieldIndexItems"}}}},"ManageUserfieldIndexItems":{"required":["id_field","type","mandatory","invisible_to_user","system_field","enabled","title","settings","count","has_more_data","current_page","current_page_size"],"properties":{"id_field":{"type":"integer","description":"ID of the user field"},"type":{"type":"string","description":"Type of the user field"},"mandatory":{"type":"string","description":"User field mandatory"},"invisible_to_user":{"type":"string","description":"Visible to user field"},"system_field":{"type":"integer","description":"True if the field is a system field and cannot be edited or deleted"},"enabled":{"type":"boolean","description":"True if the field can be edited by users"},"title":{"type":"string","description":"User field title in the selected language"},"inherited":{"type":"boolean","description":"If this field is inherited from parent branch or branches"},"settings":{"type":"array","description":"List of settings","items":{"$ref":"#/definitions/ManageUserfieldIndexSettings"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/ManageUserfieldIndexSort"}}}},"ManageUserfieldIndexSettings":{"required":["sequence"],"properties":{"sequence":{"type":"integer","description":"User field order"},"visible_for_pu":{"type":"integer","description":"Visible for power users; true if the user additional field is assigned to the given branch(-es)"}}},"ManageUserfieldIndexSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"ManageUserfieldIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"ManageUserfieldUpdateSchema":{"type":"object","properties":{"mandatory":{"type":"integer","description":"1 or 0."},"invisible_to_user":{"type":"integer","description":"1 or 0."},"sequence":{"type":"integer","description":"if not provided set as last"},"settings":{"$ref":"#/definitions/ManageUserfieldUpdateSettings","description":"Settings"},"translations":{"$ref":"#/definitions/ManageUserfieldUpdateTranslations","description":"Array of translations, the system default language translation is mandatory"},"dropdown_options":{"$ref":"#/definitions/ManageUserfieldUpdateDropdownOptions","description":"Array of objects containing dropdown options. If type is dropdown this parameter becomes required"}}},"ManageUserfieldUpdateSettings":{"properties":{"url":{"type":"string","description":"Url"},"field_name":{"type":"string","description":"Field name"},"iframe_height":{"type":"string","description":"Iframe height - it&#039;s required if field type is &#039;iframe&#039;"}}},"ManageUserfieldUpdateTranslations":{"required":["language_code"],"properties":{"language_code":{"type":"string","description":"The key is code of the language or all - the value is title. For example en, all"}}},"ManageUserfieldUpdateDropdownOptions":{"properties":{"updated":{"type":"array","description":"Updated options","items":{"$ref":"#/definitions/ManageUserfieldUpdateUpdated"}},"deleted":{"type":"array","description":"Deleted options","items":{"$ref":"#/definitions/ManageUserfieldUpdateDeleted"}},"new":{"type":"array","description":"New options","items":{"$ref":"#/definitions/ManageUserfieldUpdateNew"}}}},"ManageUserfieldUpdateUpdated":{"properties":{"id_option":{"type":"integer","description":"Id of selected dropdown option."},"sequence":{"type":"integer","description":"if not provided set as last"},"translations":{"$ref":"#/definitions/ManageUserfieldUpdateTranslationsL2","description":"Array of translations, the system default language translation is mandatory"}},"required":["translations"]},"ManageUserfieldUpdateTranslationsL2":{"required":["language_code"],"properties":{"language_code":{"type":"string","description":"The key is code of the language or all - the value is title. For example en, all"}}},"ManageUserfieldUpdateDeleted":{"properties":{"id_option":{"type":"integer","description":"Id of selected dropdown option."}}},"ManageUserfieldUpdateNew":{"required":["translations"],"properties":{"translations":{"$ref":"#/definitions/ManageUserfieldUpdateTranslationsL3","description":"Array of translations, the system default language translation is mandatory"}}},"ManageUserfieldUpdateTranslationsL3":{"required":["language_code"],"properties":{"language_code":{"type":"string","description":"The key is code of the language or all - the value is title. For example en, all"}}},"ManageUserfieldUpdateResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserfieldUpdateData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserfieldUpdateData":{"required":["field_id"],"properties":{"field_id":{"type":"integer","description":"Id of user field."},"error_messages":{"type":"array","description":"List of errors.","items":{"$ref":"#/definitions/ManageUserfieldUpdateErrorMessages"}}}},"ManageUserfieldUpdateErrorMessages":{"properties":{"updated_option_ids":{"type":"array","description":"List of updated ids.","items":{"$ref":"#/definitions/ManageUserfieldUpdateUpdatedOptionIds"}}}},"ManageUserfieldUpdateUpdatedOptionIds":{},"ManageUserfieldViewResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageUserfieldViewData","description":"List of all user fields properties"},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageUserfieldViewData":{"required":["type","mandatory","invisible_to_user","settings"],"properties":{"type":{"type":"string","description":"Type of the user field"},"mandatory":{"type":"integer","description":"Is field mandatory"},"invisible_to_user":{"type":"integer","description":"Is field invisible to user"},"settings":{"type":"array","description":"List of settings","items":{"$ref":"#/definitions/ManageUserfieldViewSettings"}}}},"ManageUserfieldViewSettings":{"required":["sequence","translations"],"properties":{"sequence":{"type":"integer","description":"User field order"},"translations":{"$ref":"#/definitions/ManageUserfieldViewTranslations","description":"Translation of the user field"},"dropdown_options":{"$ref":"#/definitions/ManageUserfieldViewDropdownOptions","description":"Translation of dropdown option"}}},"ManageUserfieldViewTranslations":{"required":["__translation__"],"properties":{"__translation__":{"type":"string","description":"The key is language code the value is translation"}}},"ManageUserfieldViewDropdownOptions":{"required":["option_id","__translations__"],"properties":{"option_id":{"type":"string","description":"Option ID"},"__translations__":{"type":"string","description":"The key is language code the value is translation"}}},"ManageWorkforceSearchSkillResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/ManageWorkforceSearchSkillData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"ManageWorkforceSearchSkillData":{"required":["items"],"properties":{"items":{"type":"array","description":"The list of object found","items":{"$ref":"#/definitions/ManageWorkforceSearchSkillItems"}}}},"ManageWorkforceSearchSkillItems":{"required":["code","name"],"properties":{"code":{"type":"string","description":"The code of the found skill"},"name":{"type":"string","description":"The name of the found skill"}}}}}