{ "opencollection": "1.0.0", "info": { "name": "IO.Common Accounts API", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Accounts", "type": "folder" }, "items": [ { "info": { "name": "Returns the detailed info of an account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Accounts/me", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the detailed info of an account" }, { "info": { "name": "Accounts list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Accounts", "params": [ { "name": "Filter", "value": "", "type": "query" }, { "name": "Page", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "SortColumn", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "Creates a new account. Profiles and users must be created separately\r\nusing POST /api/profiles and POST /api/users, then linked via\r\nPOST /api/accounts/{accountId}/profiles.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Accounts", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new account. Profiles and users must be created separately\r\nusing POST /api/profiles and POST /api/users, then linked via\r\nPOST /api/accounts/{accountId}/profiles." }, { "info": { "name": "Returns the detailed info of an account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Accounts/:accountId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Account Id" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the detailed info of an account" }, { "info": { "name": "Update account", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Accounts/:accountId", "params": [ { "name": "accountId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "Deletes an account. NB! Will disable all the related Groups, Users, Locations, Operations, Dimensions!", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/Accounts/:accountId", "params": [ { "name": "accountId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an account. NB! Will disable all the related Groups, Users, Locations, Operations, Dimensions!" }, { "info": { "name": "Create account from invitation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Accounts/fromInvitation", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "Create account linked settings from invitation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Accounts/:accountId/fromInvitation", "params": [ { "name": "accountId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "Update linked account locations mapping", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Accounts/:accountId/linkedLocations", "params": [ { "name": "accountId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "Update linked account operations mapping", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Accounts/:accountId/linkedOperations", "params": [ { "name": "accountId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } } }, { "info": { "name": "Add group to account. Enables group to access account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Accounts/:accountId/profiles", "params": [ { "name": "accountId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Add group to account. Enables group to access account" }, { "info": { "name": "Remove related profile from the account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/Accounts/:accountId/profiles/:userProfileId", "params": [ { "name": "accountId", "value": "", "type": "path" }, { "name": "userProfileId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove related profile from the account" }, { "info": { "name": "Returns the list of vendors of an account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Accounts/vendors", "params": [ { "name": "Filter", "value": "", "type": "query" }, { "name": "Page", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "SortColumn", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" }, { "name": "locationId", "value": "", "type": "query" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the list of vendors of an account" }, { "info": { "name": "Get data from the inviter's tenant regarding account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Accounts/invitation", "params": [ { "name": "tenantId", "value": "", "type": "query", "description": "Inviter's tenant id" }, { "name": "recordId", "value": "", "type": "query", "description": "Id of the record" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get data from the inviter's tenant regarding account" }, { "info": { "name": "Inviter creates an invitation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Accounts/invitation", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Inviter creates an invitation" }, { "info": { "name": "Get all tenants linked to account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Accounts/linkedClientsTenants", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all tenants linked to account" }, { "info": { "name": "Validate that a linked (vendor) account is fully configured for cross-tenant session\r\nreplication, and report exactly which pieces are missing.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Accounts/:accountId/linkedSettings/validation", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Linked account id" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Validate that a linked (vendor) account is fully configured for cross-tenant session\r\nreplication, and report exactly which pieces are missing." }, { "info": { "name": "Delete account invitation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/Accounts/integration", "params": [ { "name": "recordId", "value": "", "type": "query" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete account invitation" }, { "info": { "name": "Validates whether a single account code exists", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Accounts/validate", "params": [ { "name": "accountCode", "value": "", "type": "query" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Validates whether a single account code exists" }, { "info": { "name": "Validates multiple account codes. Returns only invalid codes.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Accounts/validate", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Validates multiple account codes. Returns only invalid codes." } ] } ], "bundled": true }