{ "opencollection": "1.0.0", "info": { "name": "Identity Service Ably Public API", "version": "1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Public", "type": "folder" }, "items": [ { "info": { "name": "returns all users for a customer, filtered by optional search parameter", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/customers/:customerId/users", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer's id" }, { "name": "search", "value": "", "type": "query", "description": "searches first & last names, nickname, & email using a query" }, { "name": "integration", "value": "", "type": "query" } ] }, "docs": "returns all users for a customer, filtered by optional search parameter" }, { "info": { "name": "CustomerUserController_lookupUser_v1", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/customers/:customerId/users/lookup", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer's id" } ] } }, { "info": { "name": "Look up multiple users by identities", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/users/batch/lookup", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer's id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Batch equivalent of GET users/lookup. Returns every distinct user under the customer who matches at least one of the given identities." }, { "info": { "name": "returns a user by its id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/customers/:customerId/users/:userId", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer's id" }, { "name": "userId", "value": "", "type": "path", "description": "user's id" } ] }, "docs": "returns a user by its id" }, { "info": { "name": "CustomerUserController_updateV2_v2", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/customers/:customerId/users/:userId", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer's id" }, { "name": "userId", "value": "", "type": "path", "description": "user's id" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "OauthController_createServiceToken_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/oauth/token", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "ClientsController_importClientV1_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/clients/import", "params": [ { "name": "customerId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "ClientsController_importClientBatchV1_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/clients/batch", "params": [ { "name": "customerId", "value": "", "type": "path" }, { "name": "isInitial", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "CodesController_importCodeV1_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/codes/import", "params": [ { "name": "customerId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "CodesController_importCodeBatchV1_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/codes/batch", "params": [ { "name": "customerId", "value": "", "type": "path" }, { "name": "isInitial", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "InitiativesController_importInitiativesConsolidatedBatchV2_v2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/customers/:customerId/initiatives/consolidated-batch", "params": [ { "name": "customerId", "value": "", "type": "path" }, { "name": "isInitial", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "InitiativesController_setInitiativeAccessV1_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/initiatives/:initiativeExternalId/access", "params": [ { "name": "customerId", "value": "", "type": "path" }, { "name": "initiativeExternalId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "InitiativesController_setInitiativeCodesV1_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/initiatives/:initiativeExternalId/codes", "params": [ { "name": "customerId", "value": "", "type": "path" }, { "name": "initiativeExternalId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "InitiativesController_deleteInitiativeCodesV1_v1", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/customers/:customerId/initiatives/:initiativeExternalId/codes", "params": [ { "name": "customerId", "value": "", "type": "path" }, { "name": "initiativeExternalId", "value": "", "type": "path" } ] } }, { "info": { "name": "EntryValidationRulesController_setOneForInitiative_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/validations/customers/:customerId/initiatives/:initiativeExternalId/rules", "params": [ { "name": "customerId", "value": "", "type": "path" }, { "name": "initiativeExternalId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "UsersController_updateUserDelegates_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/users/delegates", "params": [ { "name": "customerId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an async job that will update user delegates" }, { "info": { "name": "UsersController_updateUserDelegatesBatch_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/users/delegates/batch", "params": [ { "name": "customerId", "value": "", "type": "path" }, { "name": "isInitial", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an async job that will update delegates for a batch of users." }, { "info": { "name": "CustomerCodeTypeController_import_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/code-types/import", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer id" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "CustomerInitiativeController_import_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/initiatives/import", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer id" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "InitiativeCodesController_addInitiativeCodesV2_v2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/customers/:customerId/initiatives/:initiativeExternalId/codes", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer id" }, { "name": "initiativeExternalId", "value": "", "type": "path", "description": "initiative's external id" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "InitiativeCodesController_addInitiativeCodesByCodeType_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/initiatives/:initiativeExternalId/code-types/:codeTypeExternalId/codes", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer id" }, { "name": "initiativeExternalId", "value": "", "type": "path" }, { "name": "codeTypeExternalId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "InitiativeCodesController_removeInitiativeCodesByCodeType_v1", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/customers/:customerId/initiatives/:initiativeExternalId/code-types/:codeTypeExternalId/codes", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer id" }, { "name": "initiativeExternalId", "value": "", "type": "path" }, { "name": "codeTypeExternalId", "value": "", "type": "path" } ] } }, { "info": { "name": "CustomerDefaultCodeController_findManyByCodeTypeIdForUser_v1", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/customers/:customerId/users/:userId/code-types/:codeTypeId/default-code", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer id" }, { "name": "userId", "value": "", "type": "path", "description": "user's id" }, { "name": "codeTypeId", "value": "", "type": "path", "description": "code type's id" } ] } }, { "info": { "name": "CustomerDefaultCodeController_createOneForUser_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/users/:userId/code-types/:codeTypeId/default-code", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer id" }, { "name": "userId", "value": "", "type": "path", "description": "user's id" }, { "name": "codeTypeId", "value": "", "type": "path", "description": "code type's id" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "CustomerEntryPublicController_bulkRelease_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/public/customers/:customerId/entries/bulk-release", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer id" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "CustomerEntryPublicController_unrelease_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/public/customers/:customerId/users/:userId/entries/:entryId/unrelease", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer's id" }, { "name": "userId", "value": "", "type": "path", "description": "user's id" }, { "name": "entryId", "value": "", "type": "path" } ] } }, { "info": { "name": "CustomerEntryPublicController_overrideOneEntry_v1", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/public/customers/:customerId/users/:userId/entries/:entryId/override", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer's id" }, { "name": "userId", "value": "", "type": "path", "description": "user's id" }, { "name": "entryId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "CustomerEntryPublicController_deleteOneEntry_v1", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/public/customers/:customerId/users/:userId/entries/:entryId", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer's id" }, { "name": "userId", "value": "", "type": "path", "description": "user's id" }, { "name": "entryId", "value": "", "type": "path" } ] } }, { "info": { "name": "CustomerEntryController_findManyWithUpdatedAt_v1", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/customers/:customerId/entries", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer id" }, { "name": "updatedAfter", "value": "", "type": "query", "description": "the date after which the Entry was updated" }, { "name": "updatedOnOrBefore", "value": "", "type": "query", "description": "the date on or before which the Entry was updated" } ] } }, { "info": { "name": "CustomerEntryController_findManyWithPagination_v2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/customers/:customerId/entries", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer id" }, { "name": "updatedAfter", "value": "", "type": "query", "description": "the date after which the Entry was updated" }, { "name": "updatedOnOrBefore", "value": "", "type": "query", "description": "the date on or before which the Entry was updated" }, { "name": "pageSize", "value": "", "type": "query", "description": "max number of item in each page" }, { "name": "cursor", "value": "", "type": "query", "description": "cursor to start from" } ] } }, { "info": { "name": "CustomerEntryController_export_v1", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/customers/:customerId/entries/export", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer id" }, { "name": "releasedAfter", "value": "", "type": "query", "description": "the date after which the Entry was released" }, { "name": "releasedOnOrBefore", "value": "", "type": "query", "description": "the date on or before which the Entry was released" } ] } }, { "info": { "name": "CustomerEntryController_exportV2_v2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/customers/:customerId/entries/export", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer id" }, { "name": "releasedAfter", "value": "", "type": "query", "description": "the date after which the Entry was released" }, { "name": "releasedOnOrBefore", "value": "", "type": "query", "description": "the date on or before which the Entry was released" } ] } }, { "info": { "name": "CustomerEntryController_batchReleaseSuccess_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/entries/release-succeeded/batch", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer id" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "CustomerEntryController_releaseSuccess_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/users/:userId/entries/:entryId/release-succeeded", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer's id" }, { "name": "userId", "value": "", "type": "path", "description": "user's id" }, { "name": "entryId", "value": "", "type": "path", "description": "individual entry id" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "CustomerEntryController_releaseFailed_v1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/customers/:customerId/users/:userId/entries/:entryId/release-failed", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "customer's id" }, { "name": "userId", "value": "", "type": "path", "description": "user's id" }, { "name": "entryId", "value": "", "type": "path", "description": "individual entry id" } ], "body": { "type": "json", "data": "{}" } } } ] } ], "bundled": true }