/

/Kindoo.Tech

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

v1

latestOpenAPI 3.0.02026-08-0615578353.3 KB

Authentication and Session Management

Authenticate user

post/ApiLogin

Response

OK

All 155 operations

post Authenticate user
post Get a list of all your api sessions
post Kill all active sessions
post Kill a selected session
post Get a list of EU objects or a single EU object
post Get a list of light user objects based on specified parameters
post Get list of entry points for a specific site.
post Retrieve the site logs for an entry point or user or all logs
post Retrieve a list of access rules for a given site ID
post Retrieve a specific environment access rule
post Search for an agent to get the agent ID for site creation
post Creating a new site in Kindoo
post Edit the name of the site, property number, contact first name, contact last name, contact email, contact phone number and description
post Delete the site invitation email sent to an existing Kindoo user and use the Kindoo default email instead
post Delete the site invitation email sent to a user that does not have a verified account in Kindoo and use the Kindoo default email instead
post Delete the site invitation email sent to an existing Kindoo user flagged as temporary and use the Kindoo default email instead
post Delete the site invitation email sent to a user that does not have a verified account in Kindoo and is flagged as temporary, and use the Kindoo default email instead
post Get the available languges used in the site custom emails in Kindoo
post Get by language the custom site invitation email sent to an existing Kindoo user. You can call KindooGetAvailableLanguages function to get all the available languages in Kindoo
post Get by language the custom site invitation email sent to a user that does not have a verified account in Kindoo. call KindooGetAvailableLanguages function to get all the available languages in Kindoo
post Get by language the custom site invitation email sent to an existing Kindoo user flagged as temporary. You can call KindooGetAvailableLanguages function to get all the available languages in Kindoo
post Get by language the custom site invitation email sent to a user that does not have a verified account in Kindoo and is flagged as temporary. Call KindooGetAvailableLanguages function to get all the available languages in Kindoo
post Get a list of keywords that can be used in the Invitation emails in KindooSaveSiteInvitationNewUserEmail and KindooSaveSiteInvitationKindooUserEmail functions
post Get an site user object by their Kindoo UID
post Get a site eu light object by their Kindoo UID
post Check user type and invite according to type
post Revokes a user's access from an environment in Kindoo
post Retrieve user sites by user email for Kindoo
post Retrieve user sites by SSO ID for Kindoo. An SSO ID can be linked to multiple Kindoo account. This function might return the list of sites for multiple Kindoo accounts linked to the SSO ID
post Get the list of countries that has holidays in Kindoo system to import a holiday calendar
post Get a country holiday's to set the holidays in access rules
post Delete an access rule from site by rule id
post Clears all the existing access rights under this rule (whatever type they are) then sets back the access rights according to the Schedule(array of weekly object) and EntryPointsSelected parameters
post Clears all the existing access rights under this rule (whatever type they are) then sets back the access rights according to the Schedule(array of from-to object) and EntryPointsSelected parameters
post Clears all the existing access rights under this rule (whatever type they are) then sets back an always access right on the EntryPointsSelected parameter
post Adds an access right of type ALWAYS to the existing access rights of the requested user.
post Revokes the previous access rights of type Weekly for the requested user on the requested entry points, and sets a new access right of type Weekly for the user on the requested entry points according to the schedule sent by the Schedule parameter. NOTE that, if the user had weekly access rights on entry points not included in the list of requested entry points, these weekly access rights remain
post Adds an access right of type FROM-TO to the existing access rights of the requested user.
post Retrieves the list of all access permissions(access rules and access rights) of a Kindoo user
post Revoke always access rights by EUID and entry point IDs for Kindoo
post Revoke User From Access rule
post Revokes an environment user access rights by ids
post Revokes an environment user all access rights, with a choice of removing the user from the access rules as well
post Revokes an always access right by ID in Kindoo
post Revokes a FROM-TO access right by ID in Kindoo
post Revokes a weekly access right by ID in Kindoo
post Cloning access permissions(access rules and access rights) from one user to another.
post Cloning access permissions(access rules and access rights) from one entry point to another.
post Add a user to a list of access rules
post Retrieves a list of access rules for a Kindoo entry point
post Retrieves a Kindoo entry point object
post add an entry point object to a site
post Edit the entry point name, property number, description, success response and denied response
post deleted an entry point object from a site
post Switch kin contractor access
post Add PIN to an entry point
post Edit PIN on an entry point
post Remove PIN from an entry point
post Saving the kin notification settings
post Get the list of available time zones in Kindoo
post Launches a process that generates a file with a 24 hour lifetime that contains all the sites that belong to a given organization. The content of the generated file follows the EUArray schema structure as described in the schemas section below.
post Launches a process that generates a file with a 24 hour lifetime that contains all users for all sites that belong to a given organization. The content of the generated file follows the LightUserObjectArray schema structure as described in the schemas section below.
post Launches a process that generates a file with a 24 hour lifetime that contains all access logs for all sites that belong to a given organization. The content of the generated file follows the LogsArray schema structure as described in the schemas section below.
post Launches a process that generates a file with a 24 hour lifetime that contains all entry points for all sites that belong to a given organization. The content of the generated file follows the entryPointObjectArray schema structure as described in the schemas section below.
post Launches a process that generates a file with a 24 hour lifetime that contains all users' access permissions(access rules and access rights) for all sites that belong to a given organization. The content of the generated file follows the ruleArray schema structure as described in the schemas section below.
post Launches a process that generates a file with a 24 hour lifetime that contains all access rules for all sites that belong to a given organization. The content of the generated file follows the AccessRuleLightArray schema structure as described in the schemas section below.
post Launches a process that generates a file with a 24 hour lifetime that contains all invoices for all sites that belong to a given organization. The content of the generated file follows the invoiceArray schema structure as described in the schemas section below.
post Get the file url [valid for 10 minutes] for a given request ID
post Sets the KINDOO invitation email for a given language that is sent to a user that does not yet have the KINDOO application. If email subject and body are set to empty for a given language, the English saved version will be used. If the English saved version is empty, the default KINDOO email will be used.
post Sets the KINDOO invitation email for a given language that is sent to a user that does have the KINDOO application. If email subject and body are set to empty for a given language, the English saved version will be used. If the English saved version is empty, the default KINDOO email will be used.
post Sets the KINDOO invitation email for a given language that is sent to a user that does not yet have the KINDOO application and is flagged as temporary. If email subject and body are set to empty for a given language, the English saved version will be used. If the English saved version is empty, the email saved by KindooSaveSiteInvitationNewUserEmailByLanguage endpoint will be used. If that is also empty, the default KINDOO email will be used.
post Sets the KINDOO invitation email for a given language that is sent to a user that does have the KINDOO application and is flagged as temporary. If email subject and body are set to empty for a given language, the English saved version will be used. If the English saved version is empty, the email saved by KindooSaveSiteInvitationVerifiedKindooUserEmailByLanguage endpoint will be used. If that is also empty, the default KINDOO email will be used.
post Transfer a number of permanent user seats from the bank to a given site
post Get the total number of permanent user seats transferred from the bank to the site and the maximum number allowed to transfer from the site back to the bank
post Transfer back a number of permanent user seats from a site to the bank
post Transfer a number of PIN licenses from the bank to a given site
post Get the total number of PIN licenses transferred from the bank to the site and the maximum number allowed to transfer from the site back to the bank
post Transfer back a number of PIN licenses from the site to the bank
post Get the number of available permanent user seats in the bank.
post Get the number of available PIN licenses in the bank
post Get the full list of bank transfer by site id.
post Get the full list of bank transactions.
post Retrieves a list of access rules for a Kindoo KIN. Use KindooGetKinDAccessRulesLightFromEntryPoints instead
post Retrieves a Kindoo KIN object
post Add PIN for KINC. Use KindooAddPINToEntryPoint instead
post Edit PIN for KINC. Use KindooEditPINOnEntryPoint instead
post Remove PIN for KINC. Use KindooRemovePINFromEntryPoint instead
post Switch kin contractor access. Use SwitchEntryPointContractorAccess instead
post Saving the kin notification settings. Use SaveEntryPointNotificationSettings instead
post Delete a site by ID (only allowed by super api user)
post Allow/Disallow managers to edit guests that are invited by admins. If AllowManagersToEditGuestInvitedByAdmin parameter is sent, its value will be set. Otherwise the current value will be switched (true will become false, and vice versa).
post Limit managers to only grant access rules to guests, or allow managers to set any type of access rights. If ManagersAllowedToOnlyLinkGuestsToAccessRules parameter is sent, its value will be set. Otherwise the current value will be switched (true will become false, and vice versa).
post Allow/Disallow managers to manage suspicious users. If AllowManagersToManageSuspiciousUsers parameter is sent, its value will be set. Otherwise the current value will be switched (true will become false, and vice versa).
post Get the site user management logs activity. Start-End date range must not exceed 90 days
post Get the site access logs. Start-End date range must not exceed 365 days
post Get the custom site invitation email sent to a user that does not have a verified account in Kindoo
post Get the custom site invitation email sent to an existing Kindoo user
post Get list of KINs for a specific environment. Use KindooGetEnvironmentEntryPoints instead
post Retrieve a specific environment rule. Use KindooGetEnvRuleWithEntryPoints instead
post Retrieve logs for a KIN or user. Use KindooGetSiteUserEntryPointLogs instead
post Set a custom site invitation email sent to a verified Kindoo user. English language is mandatory. Other languages are optional. Languages that are kept void will take the value of the corresponding English text.
post Set a custom site invitation email sent to a user that does not have a verified account in Kindoo. English language is mandatory. Other languages are optional. Languages that are kept void will take the value of the corresponding English text.
post SET WEEKLY ACCESS SCHEDULE. Use KindooSaveAccessSetRuleWeeklyWithEntryPoints instead
post Save or edit a between access set rule. Use KindooSaveAccessSetRuleFromToWithEntryPoints instead
post Save or edit an always access set rule. Use KindooSaveAccessSetRuleAlwaysWithEntryPoints instead
post Retrieves a list of access rules for a Kindoo user. Use KindooGetUserAccessRulesLightWithEntryPoints instead
post Saves an access rule to a user in Kindoo. Use KindooSaveAccessRuleAlwaysToEntryPoints instead
post Set access rule weekly. Use KindooSaveAccessRuleWeeklyToEntryPoints instead
post Save Access Rule FROM TO. Use KindooSaveAccessRuleFromToToEntryPoints instead
post Add a user to a access rule. Use KindooSaveAccessRuleFromListOfAccessSchedules instead
post Add bulk PIN codes to an entry point
post Set user parameters
post Set user description
post Set user third party ref field by environment user id
post Set user third party ref field by user id and environment id
post Revoke User From Access rule. Use KindooRevokeUserFromAccessRule instead
post Retrieves the list of all access permissions (access rules and access rights) of a Kindoo user.Use KindooGetUserAccessPermissions
post Revokes an always/FROM-TO access rule by ID in Kindoo.Use KindooRevokeAlwaysAccessRightByID or KindooRevokeFromToAccessRightByID instead
post Revokes an weekly access rule by ID in Kindoo.Use KindooRevokeWeeklyAccessRightByID instead
post Saves an always access rule to a user in Kindoo.Use KindooSaveAlwaysAccessRight instead
post Saves a weekly access rule to a user in Kindoo.Use KindooSaveWeeklyAccessRight instead
post Saves a FROM-TO access rule to a user in Kindoo.Use KindooSaveFromToAccessRight instead
post Cloning access rules from one user to another.Use KindooCloneUserAccessPermissions instead
post Cloning access rules from one entry point to another.Use KindooEntryPointCloneAccessPermissions instead
post Launches a process that generates a file with a 24 hour lifetime that contains all users' access rights for all sites that belong to a given organization. The content of the generated file follows the ruleArray schema structure as described in the schemas section below.Use OrganizationKindooGetUserAccessPermissions instead
post Launches a process that generates a file with a 24 hour lifetime that contains all access schedules for all sites that belong to a given organization. The content of the generated file follows the accessScheduleObjectArray schema structure as described in the schemas section below.Use OrganizationKindooGetEnvironmentsAccessRules instead
post Add a user to a list of access rules. Use KindooAddAUserToAListOfAccessRules
post Get a list of keywords that can be used in the Invitation emails in KindooSaveVerifiedKindooUserMasterLicenseInvitationEmailByLanguage and KindooSaveNewUserMasterLicenseInvitationEmailByLanguage functions
post Get by language the custom master license invitation email sent to an existing Kindoo user. You can call KindooGetAvailableLanguages function to get all the available languages in Kindoo
post Get by language the custom master license invitation email sent to a user that does not have a verified account in Kindoo. call KindooGetAvailableLanguages function to get all the available languages in Kindoo
post Sets the Kindoo master license invitation email for a given language that is sent to a user that does have the KINDOO application.. If email subject and body are set to empty for a given language, the English saved version will be used. If the English saved version is empty, the default KINDOO email will be used.
post Sets the Kindoo master license invitation email for a given language that is sent to a user that does not yet have the KINDOO application. If email subject and body are set to empty for a given language, the English saved version will be used. If the English saved version is empty, the default KINDOO email will be used.
post Delete the master license invitation email sent to an existing Kindoo user and use the Kindoo default email instead
post Delete the master license invitation email sent to a user that does not have a verified account in Kindoo and use the Kindoo default email instead
post Get the number of available master licenses in the bank
post Get all the pending master license invitations
post Get all the accepted master license invitations
post Get all the not accepted master license invitations
post Get all the revoked master license invitations
post Check the type of users in Kindoo and their master license status and whether they will consume a license or not and send invitations accordingly
post Revokes user master licenses by their IDs
post As a guest coordinator get the list of light user objects invited by you
post As a guest coordinator, you can invite a guest to the site and choose whether to grant all of your access rights or only selected access rights to specific entry points.
post Removes a guest from the guest coordinator invited list and revokes all access rights granted by the guest coordinator. If the guest has no access rights left, he will be removed from the site
post Set the guest coordinator invited user parameters
post Retrieves the list of all access permissions(access rules and access rights) of a Kindoo user granted by the guest coordinator
post As a guest coordinator, choose whether to grant all of your access rights or only selected access rights to specific entry points.
post Revokes an environment user access rights granted by the guest coordinator.
post Revokes an environment user all access rights granted by the guest coordinator, with a choice of removing the user from the access rules added by the guest coordinator as well
post Revoke User From Access rules added to them by the guest coordinator.
post Get the number of available multi site licenses in the bank
post Get all the third party multi site licenses allocated to users
post Get all the revoked third party multi site licenses
post Check the user types in Kindoo, along with their multi site license status, to determine whether they will consume a license, and allocate licenses accordingly. Important note: This API does not send invitation emails to users. It only allocates licenses. Invitation emails will be sent later when a user is invited to a site, based on their profile status. Users with incomplete profiles will be treated as new Kindoo users, while users with complete profiles will be treated as existing Kindoo users.
post Revokes user multi site licenses by their IDs. Important note: Before revoking a multi site license, the system identifies the user associated with the license and checks the available user seats across all sites (belonging to your third party) where the user is invited. If there are not enough available site user seats, the license will not be revoked. The response data will indicate which licenses were successfully revoked, which were not with the site(s) data that is preventing the revocation.