{"items":[{"type":"link","label":"Bulk import","link":"/openapi/user/bulk-user-migration.openapi","routeSlug":"/openapi/user/bulk-user-migration.openapi","content":{"contentType":"overview","meta":{"name":"Bulk import"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"bulk-user-migration.openapi.json","url":"/_bundle/openapi/user/bulk-user-migration.openapi.json?download"},{"kind":"download","label":"bulk-user-migration.openapi.yaml","url":"/_bundle/openapi/user/bulk-user-migration.openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"java","title":"Java","lang":"Java"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Bulk import","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Import users into Mosaic in bulk. Upload JSON files with the users, start an import run, track its progress and cancel it if necessary."}],"sectionId":"/openapi/user/bulk-user-migration.openapi"}],"sectionId":"/openapi/user/bulk-user-migration.openapi"}]}]}},{"label":"Create user migration upload urls","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/bulk-user-migration.openapi/other/createusermigrationuploadurls","routeSlug":"/openapi/user/bulk-user-migration.openapi/other/createusermigrationuploadurls","metadata":{"seo":{"title":"Create user migration upload urls","description":"Mints one presigned POST payload per file so the client can upload straight to object storage. The signed policy pins the tenant key prefix and a maximum file size."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUserMigrationUploadUrls","name":"Create user migration upload urls","isWebhook":false,"pointer":"/paths/~1v1~1migration~1users~1files~1upload-urls/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create user migration upload urls","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Mints one presigned POST payload per file so the client can upload straight to object storage. The signed policy pins the tenant key prefix and a maximum file size."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AdminAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by a management application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to all resources for the tenant and its apps"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserMigrationUploadUrlsInput"}},"schemaId":"components/schemas/CreateUserMigrationUploadUrlsInput","pointer":"/paths/~1v1~1migration~1users~1files~1upload-urls/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/migration/users/files/upload-urls","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateUserMigrationUploadUrlsInput"}},"responseCodes":["200","400","409"],"pointer":"/v1/migration/users/files/upload-urls","href":"other/createusermigrationuploadurls","openApiOperationId":"createUserMigrationUploadUrls","summary":"Create user migration upload urls"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"components/schemas/CreateUserMigrationUploadUrlsInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserMigrationUploadUrlsInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0"}},"schemaId":"schema_0"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}},"schemaId":"components/schemas/BadRequestHttpError"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictHttpError"}},"schemaId":"components/schemas/ConflictHttpError"}],"pointer":"/paths/~1v1~1migration~1users~1files~1upload-urls/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_0","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0"}}},{"code":"400","schemaId":"components/schemas/BadRequestHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}}},{"code":"409","schemaId":"components/schemas/ConflictHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/migration/users/files/upload-urls"},{"label":"Get user migration files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/bulk-user-migration.openapi/other/getusermigrationfiles","routeSlug":"/openapi/user/bulk-user-migration.openapi/other/getusermigrationfiles","metadata":{"seo":{"title":"Get user migration files","description":"Lists the tenant's currently uploaded migration files and how many of its file slots are held."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserMigrationFiles","name":"Get user migration files","isWebhook":false,"pointer":"/paths/~1v1~1migration~1users~1files/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user migration files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the tenant's currently uploaded migration files and how many of its file slots are held."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AdminAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by a management application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to all resources for the tenant and its apps"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/migration/users/files","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/migration/users/files","href":"other/getusermigrationfiles","openApiOperationId":"getUserMigrationFiles","summary":"Get user migration files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1"}},"schemaId":"schema_1"}],"pointer":"/paths/~1v1~1migration~1users~1files/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1"}}}],"examples":[]}]}]}]},"httpPath":"/v1/migration/users/files"},{"label":"Delete user migration files","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/bulk-user-migration.openapi/other/deleteusermigrationfiles","routeSlug":"/openapi/user/bulk-user-migration.openapi/other/deleteusermigrationfiles","metadata":{"seo":{"title":"Delete user migration files","description":"Deletes every migration file the tenant has uploaded."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUserMigrationFiles","name":"Delete user migration files","isWebhook":false,"pointer":"/paths/~1v1~1migration~1users~1files/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete user migration files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes every migration file the tenant has uploaded."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AdminAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by a management application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to all resources for the tenant and its apps"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/migration/users/files","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","409"],"pointer":"/v1/migration/users/files","href":"other/deleteusermigrationfiles","openApiOperationId":"deleteUserMigrationFiles","summary":"Delete user migration files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictHttpError"}},"schemaId":"components/schemas/ConflictHttpError"}],"pointer":"/paths/~1v1~1migration~1users~1files/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"409","schemaId":"components/schemas/ConflictHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/migration/users/files"},{"label":"Delete user migration file","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/bulk-user-migration.openapi/other/deleteusermigrationfile","routeSlug":"/openapi/user/bulk-user-migration.openapi/other/deleteusermigrationfile","metadata":{"seo":{"title":"Delete user migration file","description":"Deletes one uploaded migration file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUserMigrationFile","name":"Delete user migration file","isWebhook":false,"pointer":"/paths/~1v1~1migration~1users~1files~1{file_name}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete user migration file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes one uploaded migration file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AdminAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by a management application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to all resources for the tenant and its apps"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"file_name","in":"path","schemaId":"schema_3","description":"Name of the uploaded file","required":true}],"pointer":"/paths/~1v1~1migration~1users~1files~1{file_name}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/migration/users/files/{file_name}","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"file_name","in":"path","required":true,"schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404","409"],"pointer":"/v1/migration/users/files/{file_name}","href":"other/deleteusermigrationfile","openApiOperationId":"deleteUserMigrationFile","summary":"Delete user migration file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}},"schemaId":"schema_4"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictHttpError"}},"schemaId":"components/schemas/ConflictHttpError"}],"pointer":"/paths/~1v1~1migration~1users~1files~1{file_name}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_4","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}},{"code":"409","schemaId":"components/schemas/ConflictHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/migration/users/files/{file_name}"},{"label":"Create a user migration run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/bulk-user-migration.openapi/other/createusermigrationrun","routeSlug":"/openapi/user/bulk-user-migration.openapi/other/createusermigrationrun","metadata":{"seo":{"title":"Create a user migration run","description":"Starts a migration run for the requested uploaded files."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUserMigrationRun","name":"Create a user migration run","isWebhook":false,"pointer":"/paths/~1v1~1migration~1users~1runs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a user migration run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Starts a migration run for the requested uploaded files."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AdminAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by a management application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to all resources for the tenant and its apps"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCreateUserMigrationRunInput"}},"schemaId":"components/schemas/ApiCreateUserMigrationRunInput","pointer":"/paths/~1v1~1migration~1users~1runs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/migration/users/runs","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiCreateUserMigrationRunInput"}},"responseCodes":["201","400","404","409"],"pointer":"/v1/migration/users/runs","href":"other/createusermigrationrun","openApiOperationId":"createUserMigrationRun","summary":"Create a user migration run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"components/schemas/ApiCreateUserMigrationRunInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCreateUserMigrationRunInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}},"schemaId":"components/schemas/BadRequestHttpError"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictHttpError"}},"schemaId":"components/schemas/ConflictHttpError"}],"pointer":"/paths/~1v1~1migration~1users~1runs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"400","schemaId":"components/schemas/BadRequestHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}},{"code":"409","schemaId":"components/schemas/ConflictHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/migration/users/runs"},{"label":"Get a user migration run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/bulk-user-migration.openapi/other/getusermigrationrun","routeSlug":"/openapi/user/bulk-user-migration.openapi/other/getusermigrationrun","metadata":{"seo":{"title":"Get a user migration run","description":"Returns the progress of a migration run and a report link for each completed file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserMigrationRun","name":"Get a user migration run","isWebhook":false,"pointer":"/paths/~1v1~1migration~1users~1runs~1{run_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a user migration run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the progress of a migration run and a report link for each completed file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AdminAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by a management application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to all resources for the tenant and its apps"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"run_id","in":"path","schemaId":"schema_6","description":"Identifier of the migration run","required":true}],"pointer":"/paths/~1v1~1migration~1users~1runs~1{run_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/migration/users/runs/{run_id}","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"run_id","in":"path","required":true,"schemaId":"schema_6"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/migration/users/runs/{run_id}","href":"other/getusermigrationrun","openApiOperationId":"getUserMigrationRun","summary":"Get a user migration run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"}],"pointer":"/paths/~1v1~1migration~1users~1runs~1{run_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/migration/users/runs/{run_id}"},{"label":"Cancel a user migration run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/bulk-user-migration.openapi/other/cancelusermigrationrun","routeSlug":"/openapi/user/bulk-user-migration.openapi/other/cancelusermigrationrun","metadata":{"seo":{"title":"Cancel a user migration run","description":"Stops a running migration run. Work already in progress finishes, and every file still gets a report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelUserMigrationRun","name":"Cancel a user migration run","isWebhook":false,"pointer":"/paths/~1v1~1migration~1users~1runs~1{run_id}~1cancel/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a user migration run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Stops a running migration run. Work already in progress finishes, and every file still gets a report."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AdminAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by a management application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to all resources for the tenant and its apps"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"run_id","in":"path","schemaId":"schema_6","description":"Identifier of the migration run","required":true}],"pointer":"/paths/~1v1~1migration~1users~1runs~1{run_id}~1cancel/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/migration/users/runs/{run_id}/cancel","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"run_id","in":"path","required":true,"schemaId":"schema_6"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404","409"],"pointer":"/v1/migration/users/runs/{run_id}/cancel","href":"other/cancelusermigrationrun","openApiOperationId":"cancelUserMigrationRun","summary":"Cancel a user migration run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8"}},"schemaId":"schema_8"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictHttpError"}},"schemaId":"components/schemas/ConflictHttpError"}],"pointer":"/paths/~1v1~1migration~1users~1runs~1{run_id}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_8","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}},{"code":"409","schemaId":"components/schemas/ConflictHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/migration/users/runs/{run_id}/cancel"}],"store":{"schemaStore":{"components/schemas/CreateUserMigrationUploadUrlsInput":{"id":"components/schemas/CreateUserMigrationUploadUrlsInput","kind":"json-schema","title":"CreateUserMigrationUploadUrlsInput","data":{"type":"object","properties":{"files":{"title":"Files","description":"Names of the files to upload.","type":"array","items":{"type":"string"}}},"required":["files"]}},"components/schemas/BadRequestHttpError":{"id":"components/schemas/BadRequestHttpError","kind":"json-schema","title":"BadRequestHttpError","data":{"type":"object","properties":{"message":{"example":"Bad request","type":"array","items":{"type":"string"}},"error_code":{"type":"number","example":400}},"required":["message","error_code"]}},"components/schemas/ConflictHttpError":{"id":"components/schemas/ConflictHttpError","kind":"json-schema","title":"ConflictHttpError","data":{"type":"object","properties":{"message":{"type":"string"},"error_code":{"type":"number"}},"required":["message","error_code"]}},"components/schemas/ApiUserMigrationUploadUrls":{"id":"components/schemas/ApiUserMigrationUploadUrls","kind":"json-schema","title":"ApiUserMigrationUploadUrls","data":{"type":"object","properties":{"files":{"description":"The generated upload endpoints and policies for each requested file","type":"array","items":{"$ref":"#/components/schemas/ApiUserMigrationUploadUrl"}}},"required":["files"]}},"components/schemas/ApiUserMigrationFiles":{"id":"components/schemas/ApiUserMigrationFiles","kind":"json-schema","title":"ApiUserMigrationFiles","data":{"type":"object","properties":{"files":{"description":"Files currently stored for the tenant","type":"array","items":{"$ref":"#/components/schemas/ApiUserMigrationFile"}},"slots_used":{"type":"number","description":"Total file slots currently consumed. This includes both stored files and pending, unused upload URLs."},"slots_capacity":{"type":"number","description":"Maximum number of concurrent file slots the tenant is permitted to hold"}},"required":["files","slots_used","slots_capacity"]}},"components/schemas/ApiUserMigrationDeletedFiles":{"id":"components/schemas/ApiUserMigrationDeletedFiles","kind":"json-schema","title":"ApiUserMigrationDeletedFiles","data":{"type":"object","properties":{"deleted":{"type":"number","description":"Total number of files successfully deleted"}},"required":["deleted"]}},"components/schemas/NotFoundHttpError":{"id":"components/schemas/NotFoundHttpError","kind":"json-schema","title":"NotFoundHttpError","data":{"type":"object","properties":{"message":{"type":"string"},"error_code":{"type":"number","example":404}},"required":["message","error_code"]}},"components/schemas/ApiCreateUserMigrationRunInput":{"id":"components/schemas/ApiCreateUserMigrationRunInput","kind":"json-schema","title":"ApiCreateUserMigrationRunInput","data":{"type":"object","properties":{"mode":{"type":"string","enum":["live","dry_run"],"title":"Mode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls the execution type. \"live\" provisions users, \"dry_run\" only parses and validates the files"},"children":[]}]}]}]},"app_id":{"type":"string","title":"App ID","description":"The target application the migrated users will be provisioned in"},"files":{"title":"Files","description":"Names of previously uploaded files to process. Defaults to all uploaded files if omitted.","type":"array","items":{"type":"string"}}},"required":["mode","app_id"]}},"components/schemas/ApiCreatedUserMigrationRun":{"id":"components/schemas/ApiCreatedUserMigrationRun","kind":"json-schema","title":"ApiCreatedUserMigrationRun","data":{"type":"object","properties":{"run_id":{"type":"string","description":"Identifier of the created run"},"status":{"type":"string","description":"Status the run starts in","enum":["running","completed","failed","cancelled"]},"total_files":{"type":"number","description":"Number of files the run will process"}},"required":["run_id","status","total_files"]}},"components/schemas/ApiUserMigrationRun":{"id":"components/schemas/ApiUserMigrationRun","kind":"json-schema","title":"ApiUserMigrationRun","data":{"type":"object","properties":{"run_id":{"type":"string","description":"Identifier of the run"},"status":{"type":"string","description":"Current status of the run","enum":["running","completed","failed","cancelled"]},"mode":{"type":"string","description":"Mode the run was started in","enum":["live","dry_run"]},"total_files":{"type":"number","description":"Number of files the run processes"},"processed":{"type":"number","description":"Records read across every file so far"},"created":{"type":"number","description":"Users created across every file"},"failed":{"type":"number","description":"Records that failed validation or creation across every file"},"started_at":{"format":"date-time","type":"string","description":"When the run was created"},"completed_at":{"format":"date-time","type":"string","description":"When the run ended. Absent while the run is still working."},"files":{"description":"Progress of each file of the run","type":"array","items":{"$ref":"#/components/schemas/ApiUserMigrationRunFile"}}},"required":["run_id","status","mode","total_files","processed","created","failed","started_at","files"]}},"components/schemas/ApiCancelledUserMigrationRun":{"id":"components/schemas/ApiCancelledUserMigrationRun","kind":"json-schema","title":"ApiCancelledUserMigrationRun","data":{"type":"object","properties":{"run_id":{"type":"string","description":"Identifier of the cancelled run"},"status":{"type":"string","description":"Status of the run after the cancel","enum":["running","completed","failed","cancelled"]}},"required":["run_id","status"]}},"components/schemas/ApiUserMigrationUploadUrl":{"id":"components/schemas/ApiUserMigrationUploadUrl","kind":"json-schema","title":"ApiUserMigrationUploadUrl","data":{"type":"object","properties":{"name":{"type":"string","description":"The file name this presigned upload URL was generated for"},"url":{"type":"string","description":"The storage endpoint where the multipart/form-data POST request must be sent"},"fields":{"type":"object","description":"Required form fields to include in the upload payload"},"expires_at":{"type":"string","description":"Timestamp when the upload URL expires and the storage provider will reject it"}},"required":["name","url","fields","expires_at"]}},"components/schemas/ApiUserMigrationFile":{"id":"components/schemas/ApiUserMigrationFile","kind":"json-schema","title":"ApiUserMigrationFile","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the uploaded file"},"size":{"type":"number","description":"Size of the file in bytes"}},"required":["name","size"]}},"components/schemas/ApiUserMigrationRunFile":{"id":"components/schemas/ApiUserMigrationRunFile","kind":"json-schema","title":"ApiUserMigrationRunFile","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the uploaded file"},"status":{"type":"string","description":"Current status of this file","enum":["pending","running","completed","failed"]},"processed":{"type":"number","description":"Records read from this file so far"},"created":{"type":"number","description":"Users created from this file"},"failed":{"type":"number","description":"Records of this file that failed validation or creation"},"outcome_url":{"type":"string","description":"Time limited link to download the report of this file. Present once the file has completed."}},"required":["name","status","processed","created","failed"]}},"schema_0":{"kind":"json-schema","data":{"title":"ApiOkResponse-createUserMigrationUploadUrls","type":"object","required":["result"],"description":"Upload urls minted","properties":{"result":{"$ref":"#/components/schemas/ApiUserMigrationUploadUrls"}}},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"title":"ApiOkResponse-getUserMigrationFiles","type":"object","required":["result"],"description":"Files fetched","properties":{"result":{"$ref":"#/components/schemas/ApiUserMigrationFiles"}}},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"title":"ApiOkResponse-deleteUserMigrationFiles","type":"object","required":["result"],"description":"Files deleted","properties":{"result":{"$ref":"#/components/schemas/ApiUserMigrationDeletedFiles"}}},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"title":"File name","type":"string"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"title":"ApiOkResponse-deleteUserMigrationFile","type":"object","required":["result"],"description":"File deleted","properties":{"result":{"$ref":"#/components/schemas/ApiUserMigrationDeletedFiles"}}},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"title":"ApiCreatedResponse-createUserMigrationRun","type":"object","required":["result"],"description":"Run created","properties":{"result":{"$ref":"#/components/schemas/ApiCreatedUserMigrationRun"}}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"title":"Run id","type":"string"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"title":"ApiOkResponse-getUserMigrationRun","type":"object","required":["result"],"description":"Run fetched","properties":{"result":{"$ref":"#/components/schemas/ApiUserMigrationRun"}}},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"title":"ApiOkResponse-cancelUserMigrationRun","type":"object","required":["result"],"description":"Run cancelled","properties":{"result":{"$ref":"#/components/schemas/ApiCancelledUserMigrationRun"}}},"id":"schema_8"}},"exampleStore":{},"securitySchemeStore":{"bearer":{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},"UserAccessToken":{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated"},"AdminAccessToken":{"id":"AdminAccessToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by a management application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to all resources for the tenant and its apps"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}},"ClientAccessToken":{"id":"ClientAccessToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}},"OrgAdminAccessToken":{"id":"OrgAdminAccessToken","type":"oauth2","description":"A token returned upon B2B authentication for a user that has the organizationAdmin or organizationCreator role.","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}},"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"specType":"openapi"},"options":{"corsProxyUrl":"https://cors.redoc.ly","hideSchemaTitles":true,"onlyRequiredInSamples":false,"maxDisplayedEnumValues":10,"hideDownloadButtons":false,"codeSamples":{"skipOptionalParameters":false,"languages":[{"lang":"curl","label":"cURL"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"}]},"feedback":{"hide":true,"settings":{"label":""}},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/user/bulk-user-migration.openapi.json?download"},{"url":"/_bundle/openapi/user/bulk-user-migration.openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Bulk import","description":"Import users into Mosaic in bulk. Upload JSON files with the users, start an import run, track its progress and cancel it if necessary."}},"baseSlug":"/openapi/user/bulk-user-migration.openapi","routesMapping":{}}