{"items":[{"type":"link","label":"Users-SCIM","link":"/openapi/user/user-scim.openapi","routeSlug":"/openapi/user/user-scim.openapi","content":{"contentType":"overview","meta":{"name":"Users-SCIM"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"user-scim.openapi.json","url":"/_bundle/openapi/user/user-scim.openapi.json?download"},{"kind":"download","label":"user-scim.openapi.yaml","url":"/_bundle/openapi/user/user-scim.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":"Users-SCIM","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Manage user profiles using SCIM protocol"}],"sectionId":"/openapi/user/user-scim.openapi"}],"sectionId":"/openapi/user/user-scim.openapi"}]}]}},{"label":"Create user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/user-scim.openapi/other/scimcreateuser","routeSlug":"/openapi/user/user-scim.openapi/other/scimcreateuser","metadata":{"seo":{"title":"Create user","description":"Add a user to Transmit using SCIM protocol. Required permissions: apps:create, [appId]:create, users:create."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scimCreateUser","name":"Create user","isWebhook":false,"pointer":"/paths/~1scim~1Users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a user to Transmit using SCIM protocol. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","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 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":{}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_490","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/scim+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_490","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/scim+json"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1scim~1Users/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCreateScimUserInputDto"}},"schemaId":"components/schemas/ApiCreateScimUserInputDto","pointer":"/paths/~1scim~1Users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scim/Users","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":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_490"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_490"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiCreateScimUserInputDto"}},"responseCodes":["201","409"],"pointer":"/scim/Users","href":"other/scimcreateuser","openApiOperationId":"scimCreateUser","summary":"Create user"},"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/ApiCreateScimUserInputDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCreateScimUserInputDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The user has been successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiScimUser"}},"schemaId":"components/schemas/ApiScimUser"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScimHttpError"}},"schemaId":"components/schemas/ScimHttpError"}],"pointer":"/paths/~1scim~1Users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ApiScimUser","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiScimUser"}}},{"code":"409","schemaId":"components/schemas/ScimHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScimHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/scim/Users"},{"label":"Get scim users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/user-scim.openapi/other/scimgetusersgetrequest","routeSlug":"/openapi/user/user-scim.openapi/other/scimgetusersgetrequest","metadata":{"seo":{"title":"Get scim users","description":"Search across your application’s users at Transmit. This endpoint also allows you to return all of your application’s users by sending no filters at all. Required permissions: apps:read, [appId]:read, users:read, apps:list, [appId]:list, users:list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scimGetUsersGetRequest","name":"Get scim users","isWebhook":false,"pointer":"/paths/~1scim~1Users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get scim users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search across your application’s users at Transmit. This endpoint also allows you to return all of your application’s users by sending no filters at all. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users:list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","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 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":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startIndex","in":"query","schemaId":"schema_491","description":"The 1-based index of the first query result"},{"name":"count","in":"query","schemaId":"schema_492","description":"Number of users to return in page"},{"name":"sortBy","in":"query","schemaId":"schema_493","description":"The name of the field you wish to sort by"},{"name":"sortOrder","in":"query","schemaId":"schema_494","description":"The order of the sort"},{"name":"filter","in":"query","schemaId":"schema_490","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search expression based on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc7644#section-3.4.2.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM protocol"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For syntax and searchable fields, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/scim_search_syntax/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search query syntax"},"children":[]}]}]}]}]},{"name":"attributes","in":"query","schemaId":"schema_495","description":"The names of the user's attributes to return in the response, overriding the set of attributes that would be returned by default"},{"name":"excludedAttributes","in":"query","schemaId":"schema_495","description":"The names of the user's attributes to be removed from the default set of attributes to return"}],"pointer":"/paths/~1scim~1Users/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_490","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/scim+json"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1scim~1Users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/Users","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":[{"name":"startIndex","in":"query","required":false,"schemaId":"schema_491"},{"name":"count","in":"query","required":false,"schemaId":"schema_492"},{"name":"sortBy","in":"query","required":false,"schemaId":"schema_493"},{"name":"sortOrder","in":"query","required":false,"schemaId":"schema_494"},{"name":"filter","in":"query","required":false,"schemaId":"schema_490"},{"name":"attributes","in":"query","required":false,"schemaId":"schema_495"},{"name":"excludedAttributes","in":"query","required":false,"schemaId":"schema_495"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_490"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/scim/Users","href":"other/scimgetusersgetrequest","openApiOperationId":"scimGetUsersGetRequest","summary":"Get scim users"},"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":"components/schemas/ApiGetAllScimUsersOutput"}},"schemaId":"components/schemas/ApiGetAllScimUsersOutput"}],"pointer":"/paths/~1scim~1Users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiGetAllScimUsersOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGetAllScimUsersOutput"}}}],"examples":[]}]}]}]},"httpPath":"/scim/Users"},{"label":"Get scim users","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/user-scim.openapi/other/scimgetuserspostrequest","routeSlug":"/openapi/user/user-scim.openapi/other/scimgetuserspostrequest","metadata":{"seo":{"title":"Get scim users","description":"Search across your application’s users at Transmit. This endpoint also allows you to return all of your application’s users by sending no filters at all. Required permissions: apps:read, [appId]:read, users:read, apps:list, [appId]:list, users:list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scimGetUsersPostRequest","name":"Get scim users","isWebhook":false,"pointer":"/paths/~1scim~1Users~1.search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get scim users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search across your application’s users at Transmit. This endpoint also allows you to return all of your application’s users by sending no filters at all. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users:list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","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 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":{}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_490","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/scim+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_490","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/scim+json"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1scim~1Users~1.search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetScimUsersQueryParamsPostRequest"}},"schemaId":"components/schemas/GetScimUsersQueryParamsPostRequest","pointer":"/paths/~1scim~1Users~1.search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scim/Users/.search","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":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_490"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_490"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetScimUsersQueryParamsPostRequest"}},"responseCodes":["200"],"pointer":"/scim/Users/.search","href":"other/scimgetuserspostrequest","openApiOperationId":"scimGetUsersPostRequest","summary":"Get scim users"},"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/GetScimUsersQueryParamsPostRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetScimUsersQueryParamsPostRequest"}},"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":"components/schemas/ApiGetAllScimUsersOutput"}},"schemaId":"components/schemas/ApiGetAllScimUsersOutput"}],"pointer":"/paths/~1scim~1Users~1.search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiGetAllScimUsersOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGetAllScimUsersOutput"}}}],"examples":[]}]}]}]},"httpPath":"/scim/Users/.search"},{"label":"Get SCIM user by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/user-scim.openapi/other/scimgetuserbyid","routeSlug":"/openapi/user/user-scim.openapi/other/scimgetuserbyid","metadata":{"seo":{"title":"Get SCIM user by ID","description":"Search for a SCIM user by user ID. Required permissions: apps:read, [appId]:read, users:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scimGetUserById","name":"Get SCIM user by ID","isWebhook":false,"pointer":"/paths/~1scim~1Users~1{user_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get SCIM user by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search for a SCIM user by user ID. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","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 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":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_490","description":"The user ID to search for","required":true}],"pointer":"/paths/~1scim~1Users~1{user_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_490","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/scim+json"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1scim~1Users~1{user_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/Users/{user_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":"user_id","in":"path","required":true,"schemaId":"schema_490"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_490"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/scim/Users/{user_id}","href":"other/scimgetuserbyid","openApiOperationId":"scimGetUserById","summary":"Get SCIM user by ID"},"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":"components/schemas/ApiScimUser"}},"schemaId":"components/schemas/ApiScimUser"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScimHttpError"}},"schemaId":"components/schemas/ScimHttpError"}],"pointer":"/paths/~1scim~1Users~1{user_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiScimUser","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiScimUser"}}},{"code":"404","schemaId":"components/schemas/ScimHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScimHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/scim/Users/{user_id}"},{"label":"Replace user attributes","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/user-scim.openapi/other/scimreplaceuserattributes","routeSlug":"/openapi/user/user-scim.openapi/other/scimreplaceuserattributes","metadata":{"seo":{"title":"Replace user attributes","description":"Replace user attributes using SCIM protocol. Required permissions: apps:edit, [appId]:edit, users:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scimReplaceUserAttributes","name":"Replace user attributes","isWebhook":false,"pointer":"/paths/~1scim~1Users~1{user_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace user attributes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replace user attributes using SCIM protocol. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","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 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":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_490","description":"ID of the user","required":true}],"pointer":"/paths/~1scim~1Users~1{user_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_490","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/scim+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_490","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/scim+json"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1scim~1Users~1{user_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiReplaceScimUserInputDto"}},"schemaId":"components/schemas/ApiReplaceScimUserInputDto","pointer":"/paths/~1scim~1Users~1{user_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/scim/Users/{user_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":"user_id","in":"path","required":true,"schemaId":"schema_490"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_490"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_490"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiReplaceScimUserInputDto"}},"responseCodes":["200","409"],"pointer":"/scim/Users/{user_id}","href":"other/scimreplaceuserattributes","openApiOperationId":"scimReplaceUserAttributes","summary":"Replace user attributes"},"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/ApiReplaceScimUserInputDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiReplaceScimUserInputDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The user attributes have been successfully replaced.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiScimUser"}},"schemaId":"components/schemas/ApiScimUser"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScimHttpError"}},"schemaId":"components/schemas/ScimHttpError"}],"pointer":"/paths/~1scim~1Users~1{user_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiScimUser","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiScimUser"}}},{"code":"409","schemaId":"components/schemas/ScimHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScimHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/scim/Users/{user_id}"},{"label":"Delete SCIM user by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/user-scim.openapi/other/scimdeleteuserbyid","routeSlug":"/openapi/user/user-scim.openapi/other/scimdeleteuserbyid","metadata":{"seo":{"title":"Delete SCIM user by ID","description":"Delete a user from Transmit using SCIM protocol. Required permissions: apps:delete, [appId]:delete, users:delete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scimDeleteUserById","name":"Delete SCIM user by ID","isWebhook":false,"pointer":"/paths/~1scim~1Users~1{user_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete SCIM user by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a user from Transmit using SCIM protocol. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","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 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":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_490","description":"The user ID to delete","required":true}],"pointer":"/paths/~1scim~1Users~1{user_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_490","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/scim+json"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1scim~1Users~1{user_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/scim/Users/{user_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":"user_id","in":"path","required":true,"schemaId":"schema_490"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_490"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","404"],"pointer":"/scim/Users/{user_id}","href":"other/scimdeleteuserbyid","openApiOperationId":"scimDeleteUserById","summary":"Delete SCIM user by ID"},"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":"204","description":"The user has been successfully deleted."},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScimHttpError"}},"schemaId":"components/schemas/ScimHttpError"}],"pointer":"/paths/~1scim~1Users~1{user_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/ScimHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScimHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/scim/Users/{user_id}"}],"store":{"schemaStore":{"components/schemas/ApiGetAllScimUsersOutput":{"id":"components/schemas/ApiGetAllScimUsersOutput","kind":"json-schema","title":"ApiGetAllScimUsersOutput","data":{"type":"object","properties":{"schemas":{"description":"Schema uri","type":"array","items":{"type":"string"}},"totalResults":{"type":"number","description":"Number of total user results"},"Resources":{"description":"The returned users","type":"array","items":{"$ref":"#/components/schemas/ApiScimUser"}},"startIndex":{"type":"number","description":"The 1-based index of the first result in the current set of list results"},"itemsPerPage":{"type":"number","description":"The number of resources returned in a list response page"}},"required":["schemas","Resources"]}},"components/schemas/ApiCreateScimUserInputDto":{"id":"components/schemas/ApiCreateScimUserInputDto","kind":"json-schema","title":"ApiCreateScimUserInputDto","data":{"type":"object","properties":{"name":{"description":"Full name","allOf":[{"$ref":"#/components/schemas/ApiScimUserName"}]},"preferredLanguage":{"type":"string","description":"The preferred language of the user"},"emails":{"description":"The emails for the user","type":"array","items":{"$ref":"#/components/schemas/ApiScimUserEmail"}},"phoneNumbers":{"description":"The phone numbers for the user","type":"array","items":{"$ref":"#/components/schemas/ApiScimUserPhoneNumber"}},"photos":{"description":"The photos for the user, only 1 can be sent","type":"array","items":{"type":"string"}},"addresses":{"description":"The addresses for the user, only 1 can be stored","type":"array","items":{"$ref":"#/components/schemas/ApiScimUserAddress"}},"schemas":{"type":"array","description":"One or more schemas that are used in the API call. The core schema 'urn:ietf:params:scim:schemas:core:2.0:User' must be always specified.","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:User":{"type":"object","description":"Custom app data object for app-related user info"},"externalId":{"type":"string","description":"A unique identifier in a tenant"},"active":{"type":"boolean","description":"A Boolean value indicating the user's administrative status"},"custom_user_fields":{"type":"object","description":"Custom user fields defined by the tenant schema"},"userName":{"type":"string","description":"Unique identifier for the user"},"password":{"type":"string","description":"The password for the user"},"hashed_password":{"description":"The hashed password for the user","allOf":[{"$ref":"#/components/schemas/ApiHashedPasswordDto"}]}},"required":["schemas","userName"]}},"components/schemas/ApiScimUser":{"id":"components/schemas/ApiScimUser","kind":"json-schema","title":"ApiScimUser","data":{"type":"object","properties":{"schemas":{"description":"List of included SCIM schemas that are used to indicate the attributes contained within a resource.","type":"array","items":{"type":"string"}},"userName":{"type":"string","description":"Unique identifier of the user. In Transmit, the username can be used for password authentication unless a primary email is used instead."},"name":{"description":"Full name","allOf":[{"$ref":"#/components/schemas/ApiScimUserName"}]},"displayName":{"type":"string","description":"The name of the user, suitable for display to end-users"},"preferredLanguage":{"type":"string","description":"Indicates the user's preferred written or spoken languages and is\n      generally used for selecting a localized user interface"},"active":{"type":"boolean","description":"A Boolean value indicating the user's administrative status"},"emails":{"description":"Email addresses for the user.","type":"array","items":{"type":"string"}},"phoneNumbers":{"description":"Phone numbers for the user.","type":"array","items":{"type":"string"}},"photos":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A URI that is a uniform resource locator (as defined in Section 1.1.3 of [RFC3986]) that points to a resource location representing the user's image."},"children":[]}]}]}],"type":"array","items":{"type":"string"}},"addresses":{"description":"The user's addresses","type":"array","items":{"type":"string"}},"id":{"type":"string","description":"The ID of the user"},"externalId":{"type":"string","description":"The external ID of the user"},"meta":{"description":"A complex attribute containing resource metadata","allOf":[{"$ref":"#/components/schemas/ApiScimMetaData"}]},"custom_user_fields":{"type":"object","description":"Custom user fields defined by the tenant schema"},"urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:User":{"type":"object","description":"Custom app data object for app-related user info"},"urn:ietf:params:scim:schemas:extension:UserExtended:2.0:User":{"description":"Extended user fields","allOf":[{"$ref":"#/components/schemas/ApiUserExtendedScimDto"}]}},"required":["schemas","userName","id","meta","urn:ietf:params:scim:schemas:extension:UserExtended:2.0:User"]}},"components/schemas/ScimHttpError":{"id":"components/schemas/ScimHttpError","kind":"json-schema","title":"ScimHttpError","data":{"type":"object","properties":{"schemas":{"type":"string"},"status":{"type":"number","example":404},"detail":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["schemas","status"]}},"components/schemas/GetScimUsersQueryParamsPostRequest":{"id":"components/schemas/GetScimUsersQueryParamsPostRequest","kind":"json-schema","title":"GetScimUsersQueryParamsPostRequest","data":{"type":"object","properties":{"startIndex":{"type":"number","description":"The 1-based index of the first query result","default":1},"count":{"type":"number","description":"Number of users to return in page","maximum":5000,"default":1000},"sortBy":{"type":"string","description":"The name of the field you wish to sort by","enum":["emails","phoneNumbers","meta.created","lastAuth"],"default":"meta.created"},"sortOrder":{"type":"string","description":"The order of the sort","enum":["asc","desc"],"default":"asc"},"filter":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search expression based on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc7644#section-3.4.2.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM protocol"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For syntax and searchable fields, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/scim_search_syntax/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search query syntax"},"children":[]}]}]}]}]},"attributes":{"description":"The names of the user's attributes to return in the response, overriding the set of attributes that would be returned by default","type":"array","items":{"type":"string"}},"excludedAttributes":{"description":"The names of the user's attributes to be removed from the default set of attributes to return","type":"array","items":{"type":"string"}},"schemas":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schemas should be always set to [\"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"]"},"children":[]}]}]}],"items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:SearchRequest"]}}},"required":["schemas"]}},"components/schemas/ApiReplaceScimUserInputDto":{"id":"components/schemas/ApiReplaceScimUserInputDto","kind":"json-schema","title":"ApiReplaceScimUserInputDto","data":{"type":"object","properties":{"name":{"description":"Full name","allOf":[{"$ref":"#/components/schemas/ApiScimUserName"}]},"preferredLanguage":{"type":"string","description":"The preferred language of the user"},"emails":{"description":"The emails for the user","type":"array","items":{"$ref":"#/components/schemas/ApiScimUserEmail"}},"phoneNumbers":{"description":"The phone numbers for the user","type":"array","items":{"$ref":"#/components/schemas/ApiScimUserPhoneNumber"}},"photos":{"description":"The photos for the user, only 1 can be sent","type":"array","items":{"type":"string"}},"addresses":{"description":"The addresses for the user, only 1 can be stored","type":"array","items":{"$ref":"#/components/schemas/ApiScimUserAddress"}},"schemas":{"type":"array","description":"One or more schemas that are used in the API call. The core schema 'urn:ietf:params:scim:schemas:core:2.0:User' must be always specified.","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:CustomAppData:2.0:User":{"type":"object","description":"Custom app data object for app-related user info"},"externalId":{"type":"string","description":"A unique identifier in a tenant"},"active":{"type":"boolean","description":"A Boolean value indicating the user's administrative status"},"custom_user_fields":{"type":"object","description":"Custom user fields defined by the tenant schema"},"userName":{"type":"string","description":"Unique identifier for the user"},"password":{"type":"string","description":"The password for the user"},"hashed_password":{"description":"The hashed password for the user","allOf":[{"$ref":"#/components/schemas/ApiHashedPasswordDto"}]}},"required":["schemas"]}},"components/schemas/ApiScimUserEmail":{"id":"components/schemas/ApiScimUserEmail","kind":"json-schema","title":"ApiScimUserEmail","data":{"type":"object","properties":{"value":{"type":"string","description":"Email"},"primary":{"type":"boolean","description":"Indicates if email is the primary email of the user","default":false}},"required":["value"]}},"components/schemas/ApiScimUserPhoneNumber":{"id":"components/schemas/ApiScimUserPhoneNumber","kind":"json-schema","title":"ApiScimUserPhoneNumber","data":{"type":"object","properties":{"value":{"type":"string","description":"Phone number"},"primary":{"type":"boolean","description":"Indicates if phone number is the primary phone number of the user","default":false}},"required":["value"]}},"components/schemas/ApiScimUserAddress":{"id":"components/schemas/ApiScimUserAddress","kind":"json-schema","title":"ApiScimUserAddress","data":{"type":"object","properties":{"streetAddress":{"type":"string","description":"The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information"},"locality":{"type":"string","description":"The city or locality component"},"region":{"type":"string","description":"The state or region component"},"postalCode":{"type":"string","description":"The zip code or postal code component"},"country":{"type":"string","description":"The country name component"}}}},"components/schemas/ApiScimUserName":{"id":"components/schemas/ApiScimUserName","kind":"json-schema","title":"ApiScimUserName","data":{"type":"object","properties":{"honorificPrefix":{"type":"string","description":"Title"},"givenName":{"type":"string","description":"User's first name"},"familyName":{"type":"string","description":"User's last name"},"middleName":{"type":"string","description":"User's middle name"}}}},"components/schemas/ApiHashedPasswordDto":{"id":"components/schemas/ApiHashedPasswordDto","kind":"json-schema","title":"ApiHashedPasswordDto","data":{"type":"object","properties":{"password":{"type":"string"},"salt":{"type":"string"},"algorithm":{"type":"string","description":"Hash type of the hashed password","enum":["argon2","firebaseScrypt","bcrypt","sha","sha1","sha2","md5","smd5","sha512","ssha","ssha256","ssha512","sha256","aholdLegacySha256","drupalPhpass"]}},"required":["password","algorithm"]}},"components/schemas/ApiScimMetaData":{"id":"components/schemas/ApiScimMetaData","kind":"json-schema","title":"ApiScimMetaData","data":{"type":"object","properties":{"resourceType":{"type":"string","description":"Resource type"},"created":{"format":"date-time","type":"string","description":"The date time that the resource was created"},"lastModified":{"format":"date-time","type":"string","description":"The date time that the resource was last modified"},"location":{"type":"string","description":"The URI of the resource"}}}},"components/schemas/ApiUserExtendedScimDto":{"id":"components/schemas/ApiUserExtendedScimDto","kind":"json-schema","title":"ApiUserExtendedScimDto","data":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Status"},"lastAuth":{"format":"date-time","type":"string","description":"The last time the user authenticated"},"passwordInformation":{"description":"Password information","allOf":[{"$ref":"#/components/schemas/ApiPasswordInformation"}]}},"required":["status","lastAuth","passwordInformation"]}},"components/schemas/Status":{"id":"components/schemas/Status","kind":"json-schema","title":"Status","data":{"type":"string","enum":["Active","Disabled","Pending"]}},"components/schemas/ApiPasswordInformation":{"id":"components/schemas/ApiPasswordInformation","kind":"json-schema","title":"ApiPasswordInformation","data":{"type":"object","properties":{"expired":{"type":"boolean","description":"Whether the password is currently expired"},"temporary":{"type":"boolean","description":"Whether the password must be reset after first use"},"updated_at":{"type":"number","description":"The date the password was last updated, as unix epoch in milliseconds"},"expires_in":{"format":"date-time","type":"string","description":"The date the password will be expired"}},"required":["expired","temporary","updated_at"]}},"schema_490":{"kind":"json-schema","data":{"type":"string"},"id":"schema_490"},"schema_491":{"kind":"json-schema","data":{"default":1,"type":"number"},"id":"schema_491"},"schema_492":{"kind":"json-schema","data":{"maximum":5000,"default":1000,"type":"number"},"id":"schema_492"},"schema_493":{"kind":"json-schema","data":{"default":"meta.created","enum":["emails","phoneNumbers","meta.created","lastAuth"],"type":"string"},"id":"schema_493"},"schema_494":{"kind":"json-schema","data":{"default":"asc","enum":["asc","desc"],"type":"string"},"id":"schema_494"},"schema_495":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_495"}},"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"}]},"options":{"corsProxyUrl":"https://cors.redoc.ly","hideSchemaTitles":true,"onlyRequiredInSamples":false,"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":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/user/user-scim.openapi.json?download"},{"url":"/_bundle/openapi/user/user-scim.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Users-SCIM","description":"Manage user profiles using SCIM protocol"}},"baseSlug":"/openapi/user/user-scim.openapi","routesMapping":{}}