{"items":[{"type":"link","label":"Organizations","link":"/openapi/user/organizations.openapi","routeSlug":"/openapi/user/organizations.openapi","content":{"contentType":"overview","meta":{"name":"Organizations"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"organizations.openapi.json","url":"/_bundle/openapi/user/organizations.openapi.json?download"},{"kind":"download","label":"organizations.openapi.yaml","url":"/_bundle/openapi/user/organizations.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":"Organizations","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"In business-to-business (B2B) use cases, organizations represent your business customers and partners. You can manage these organizations, and delegate access so they can manage their own membership. Using member APIs, organizations can manage the profiles of their users, control which apps they can access, and federate login to those apps using their own SAML-based identity providers."}],"sectionId":"/openapi/user/organizations.openapi"}],"sectionId":"/openapi/user/organizations.openapi"}]}]}},{"label":"Create organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/createorganization","routeSlug":"/openapi/user/organizations.openapi/other/createorganization","metadata":{"seo":{"title":"Create organization","description":"Create an organization that represents your business customer or partner. This should be called from the backend, using an admin access token (generated by a management app). Required permissions: organizations:create, orgs:create."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrganization","name":"Create organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create organization","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":"Create an organization that represents your business customer or partner. This should be called from the backend, using an admin access token (generated by a management app). "},"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":"organizations:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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/ApiCreateOrganizationInput"}},"schemaId":"components/schemas/ApiCreateOrganizationInput","pointer":"/paths/~1v1~1organizations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/organizations","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/ApiCreateOrganizationInput"}},"responseCodes":["201","400","409"],"pointer":"/v1/organizations","href":"other/createorganization","openApiOperationId":"createOrganization","summary":"Create organization"},"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/ApiCreateOrganizationInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCreateOrganizationInput"}},"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_415"}},"schemaId":"schema_415"},{"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/IdentifierIsTakenHttpError"}},"schemaId":"components/schemas/IdentifierIsTakenHttpError"}],"pointer":"/paths/~1v1~1organizations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_415","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}}},{"code":"400","schemaId":"components/schemas/BadRequestHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}}},{"code":"409","schemaId":"components/schemas/IdentifierIsTakenHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentifierIsTakenHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/organizations"},{"label":"Get organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/getallorganizations","routeSlug":"/openapi/user/organizations.openapi/other/getallorganizations","metadata":{"seo":{"title":"Get organizations","description":"Retrieve a list of all organizations. This should be called from the backend, using an admin access token (generated by a management app). Required permissions: organizations:read, orgs:read, organizations:list, orgs:list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllOrganizations","name":"Get organizations","isWebhook":false,"pointer":"/paths/~1v1~1organizations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get organizations","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":"Retrieve a list of all organizations. This should be called from the backend, using an admin access token (generated by a management app). "},"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":"organizations:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizations:list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_416","description":"Maximum number of results to return. Defaults to 1000, maximum 1000."},{"name":"offset","in":"query","schemaId":"schema_416","description":"Number of results to skip. Defaults to 0."},{"name":"search","in":"query","schemaId":"schema_417","description":"Filter results by organization name"},{"name":"sort_field","in":"query","schemaId":"schema_418","description":"The name of the field you wish to sort by."},{"name":"sort_order","in":"query","schemaId":"schema_419","description":"The order of the sort"},{"name":"app_id","in":"query","schemaId":"schema_420","description":"Filter results by application IDs"}],"pointer":"/paths/~1v1~1organizations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations","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":"limit","in":"query","required":false,"schemaId":"schema_416"},{"name":"offset","in":"query","required":false,"schemaId":"schema_416"},{"name":"search","in":"query","required":false,"schemaId":"schema_417"},{"name":"sort_field","in":"query","required":false,"schemaId":"schema_418"},{"name":"sort_order","in":"query","required":false,"schemaId":"schema_419"},{"name":"app_id","in":"query","required":false,"schemaId":"schema_420"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/organizations","href":"other/getallorganizations","openApiOperationId":"getAllOrganizations","summary":"Get organizations"},"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/ApiGetOrganizationsPaginated"}},"schemaId":"components/schemas/ApiGetOrganizationsPaginated"}],"pointer":"/paths/~1v1~1organizations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiGetOrganizationsPaginated","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGetOrganizationsPaginated"}}}],"examples":[]}]}]}]},"httpPath":"/v1/organizations"},{"label":"Get organization by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/getorganization","routeSlug":"/openapi/user/organizations.openapi/other/getorganization","metadata":{"seo":{"title":"Get organization by ID","description":"Retrieve an organization by ID. This should be called from the backend, using an admin access token (generated by a management app). Required permissions: organizations:read, orgs:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrganization","name":"Get organization by ID","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get organization 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":"Retrieve an organization by ID. This should be called from the backend, using an admin access token (generated by a management app). "},"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":"organizations:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"organization_id","in":"path","schemaId":"schema_417","description":"ID of the organization to retrieve","required":true}],"pointer":"/paths/~1v1~1organizations~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{organization_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":"organization_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/organizations/{organization_id}","href":"other/getorganization","openApiOperationId":"getOrganization","summary":"Get organization 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":"schema_421"}},"schemaId":"schema_421"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"}],"pointer":"/paths/~1v1~1organizations~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_421","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/organizations/{organization_id}"},{"label":"Update organization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/updateorganization","routeSlug":"/openapi/user/organizations.openapi/other/updateorganization","metadata":{"seo":{"title":"Update organization","description":"Update an organization's basic configuration. This should be called from the backend, using an admin access token (generated by a management app). Required permissions: organizations:edit, orgs:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrganization","name":"Update organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{organization_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update organization","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":"Update an organization's basic configuration. This should be called from the backend, using an admin access token (generated by a management app). "},"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":"organizations:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"organization_id","in":"path","schemaId":"schema_417","description":"ID of the organization to update","required":true}],"pointer":"/paths/~1v1~1organizations~1{organization_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiUpdateOrganizationInput"}},"schemaId":"components/schemas/ApiUpdateOrganizationInput","pointer":"/paths/~1v1~1organizations~1{organization_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{organization_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":"organization_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiUpdateOrganizationInput"}},"responseCodes":["200","400","404"],"pointer":"/v1/organizations/{organization_id}","href":"other/updateorganization","openApiOperationId":"updateOrganization","summary":"Update organization"},"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/ApiUpdateOrganizationInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiUpdateOrganizationInput"}},"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_422"}},"schemaId":"schema_422"},{"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"}],"pointer":"/paths/~1v1~1organizations~1{organization_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_422"}}},{"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"}}}],"examples":[]}]}]}]},"httpPath":"/v1/organizations/{organization_id}"},{"label":"Delete organization","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/deleteorganization","routeSlug":"/openapi/user/organizations.openapi/other/deleteorganization","metadata":{"seo":{"title":"Delete organization","description":"Delete an organization. This should be called from the backend, using an admin access token (generated by a management app). Required permissions: organizations:delete, orgs:delete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrganization","name":"Delete organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{organization_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete organization","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 an organization. This should be called from the backend, using an admin access token (generated by a management app). "},"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":"organizations:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"organization_id","in":"path","schemaId":"schema_417","description":"The ID of the organization that should be deleted","required":true}],"pointer":"/paths/~1v1~1organizations~1{organization_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/organizations/{organization_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":"organization_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["400","404"],"pointer":"/v1/organizations/{organization_id}","href":"other/deleteorganization","openApiOperationId":"deleteOrganization","summary":"Delete organization"},"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":"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"}],"pointer":"/paths/~1v1~1organizations~1{organization_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"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"}}}],"examples":[]}]}]}]},"httpPath":"/v1/organizations/{organization_id}"},{"label":"Get organization by name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/getorganizationbyname","routeSlug":"/openapi/user/organizations.openapi/other/getorganizationbyname","metadata":{"seo":{"title":"Get organization by name","description":"Retrieve an organization by name. This should be called from the backend, using an admin access token (generated by a management app). Required permissions: organizations:read, orgs:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrganizationByName","name":"Get organization by name","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1name~1{organization_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get organization by name","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":"Retrieve an organization by name. This should be called from the backend, using an admin access token (generated by a management app). "},"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":"organizations:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"organization_name","in":"path","schemaId":"schema_417","description":"Name of the organization to retrieve","required":true}],"pointer":"/paths/~1v1~1organizations~1name~1{organization_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/name/{organization_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":"organization_name","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/organizations/name/{organization_name}","href":"other/getorganizationbyname","openApiOperationId":"getOrganizationByName","summary":"Get organization by name"},"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_423"}},"schemaId":"schema_423"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"}],"pointer":"/paths/~1v1~1organizations~1name~1{organization_name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_423","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/organizations/name/{organization_name}"},{"label":"Add apps to organization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/addappstoorganization","routeSlug":"/openapi/user/organizations.openapi/other/addappstoorganization","metadata":{"seo":{"title":"Add apps to organization","description":"Add apps to the organization so its members can access them. If the organization already has apps, this can be used to add additional ones. This should be called from the backend, using an admin access token (generated by a management app). Required permissions: organizations:edit, orgs:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addAppsToOrganization","name":"Add apps to organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{organization_id}~1apps/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add apps to organization","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 apps to the organization so its members can access them. If the organization already has apps, this can be used to add additional ones. This should be called from the backend, using an admin access token (generated by a management app). "},"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":"organizations:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"organization_id","in":"path","schemaId":"schema_417","description":"The ID of the organization that should be updated","required":true}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1apps/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiAppIds"}},"schemaId":"components/schemas/ApiAppIds","pointer":"/paths/~1v1~1organizations~1{organization_id}~1apps/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{organization_id}/apps","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":"organization_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiAppIds"}},"responseCodes":["204","400","404"],"pointer":"/v1/organizations/{organization_id}/apps","href":"other/addappstoorganization","openApiOperationId":"addAppsToOrganization","summary":"Add apps to organization"},"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/ApiAppIds","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiAppIds"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"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"}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1apps/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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"}}}],"examples":[]}]}]}]},"httpPath":"/v1/organizations/{organization_id}/apps"},{"label":"Remove apps from organization","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/removeappsfromorganization","routeSlug":"/openapi/user/organizations.openapi/other/removeappsfromorganization","metadata":{"seo":{"title":"Remove apps from organization","description":"Remove apps from the organization so its members cannot access them. This should be called from the backend, using an admin access token (generated by a management app). Required permissions: organizations:edit, orgs:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeAppsFromOrganization","name":"Remove apps from organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{organization_id}~1apps/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove apps from organization","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":"Remove apps from the organization so its members cannot access them. This should be called from the backend, using an admin access token (generated by a management app). "},"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":"organizations:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"organization_id","in":"path","schemaId":"schema_417","description":"The ID of the organization that should be updated","required":true}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1apps/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiAppIds"}},"schemaId":"components/schemas/ApiAppIds","pointer":"/paths/~1v1~1organizations~1{organization_id}~1apps/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/organizations/{organization_id}/apps","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":"organization_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiAppIds"}},"responseCodes":["204","400","404"],"pointer":"/v1/organizations/{organization_id}/apps","href":"other/removeappsfromorganization","openApiOperationId":"removeAppsFromOrganization","summary":"Remove apps from organization"},"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/ApiAppIds","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiAppIds"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"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"}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1apps/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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"}}}],"examples":[]}]}]}]},"httpPath":"/v1/organizations/{organization_id}/apps"},{"label":"Upload organization logo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/uploadlogo","routeSlug":"/openapi/user/organizations.openapi/other/uploadlogo","metadata":{"seo":{"title":"Upload organization logo","description":"Upload the organization logo and update the logo URL in the database. This should be called from the backend, using an admin access token (generated by a management app). Required permissions: organizations:edit, orgs:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadLogo","name":"Upload organization logo","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{organization_id}~1logo/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload organization logo","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":"Upload the organization logo and update the logo URL in the database. This should be called from the backend, using an admin access token (generated by a management app). "},"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":"organizations:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"organization_id","in":"path","schemaId":"schema_417","description":"ID of the organization to upload the logo for","required":true}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1logo/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/LogoUploadDto"}},"schemaId":"components/schemas/LogoUploadDto","pointer":"/paths/~1v1~1organizations~1{organization_id}~1logo/post/requestBody","description":"Logo image"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/organizations/{organization_id}/logo","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":"organization_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/LogoUploadDto"}},"responseCodes":["202"],"pointer":"/v1/organizations/{organization_id}/logo","href":"other/uploadlogo","openApiOperationId":"uploadLogo","summary":"Upload organization logo"},"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/LogoUploadDto","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/LogoUploadDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202"}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1logo/post/responses"}],"panels":[]}]},"httpPath":"/v1/organizations/{organization_id}/logo"},{"label":"Get organizations by application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/getorganizationsbyapp","routeSlug":"/openapi/user/organizations.openapi/other/getorganizationsbyapp","metadata":{"seo":{"title":"Get organizations by application","description":"Retrieve all organizations associated with a specific application, including child organizations. This should be called from the backend, using an admin access token (generated by a management app). Required permissions: organizations:read, orgs:read, organizations:list, orgs:list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrganizationsByApp","name":"Get organizations by application","isWebhook":false,"pointer":"/paths/~1v1~1manage~1apps~1{app_id}~1organizations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get organizations by application","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":"Retrieve all organizations associated with a specific application, including child organizations. This should be called from the backend, using an admin access token (generated by a management app). "},"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":"organizations:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizations:list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"app_id","in":"path","schemaId":"schema_417","description":"ID of the application","required":true}],"pointer":"/paths/~1v1~1manage~1apps~1{app_id}~1organizations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_416","description":"Maximum number of results to return. Defaults to 1000, maximum 1000."},{"name":"offset","in":"query","schemaId":"schema_416","description":"Number of results to skip. Defaults to 0."},{"name":"search","in":"query","schemaId":"schema_417","description":"Filter results by organization name"},{"name":"sort_field","in":"query","schemaId":"schema_418","description":"The name of the field you wish to sort by."},{"name":"sort_order","in":"query","schemaId":"schema_419","description":"The order of the sort"}],"pointer":"/paths/~1v1~1manage~1apps~1{app_id}~1organizations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/manage/apps/{app_id}/organizations","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":"app_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_416"},{"name":"offset","in":"query","required":false,"schemaId":"schema_416"},{"name":"search","in":"query","required":false,"schemaId":"schema_417"},{"name":"sort_field","in":"query","required":false,"schemaId":"schema_418"},{"name":"sort_order","in":"query","required":false,"schemaId":"schema_419"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/manage/apps/{app_id}/organizations","href":"other/getorganizationsbyapp","openApiOperationId":"getOrganizationsByApp","summary":"Get organizations by application"},"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/ApiGetOrganizationsPaginated"}},"schemaId":"components/schemas/ApiGetOrganizationsPaginated"}],"pointer":"/paths/~1v1~1manage~1apps~1{app_id}~1organizations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiGetOrganizationsPaginated","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGetOrganizationsPaginated"}}}],"examples":[]}]}]}]},"httpPath":"/v1/manage/apps/{app_id}/organizations"},{"label":"Get child organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/getmanagedorganizations","routeSlug":"/openapi/user/organizations.openapi/other/getmanagedorganizations","metadata":{"seo":{"title":"Get child organizations","description":"Retrieves a paginated list of child organizations for the organization associated with the authenticated user. The parent organization ID is derived from the user access token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getManagedOrganizations","name":"Get child organizations","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1me~1managed-organizations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get child organizations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a paginated list of child organizations for the organization associated with the authenticated user. The parent organization ID is derived from the user access token."},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserAccessToken","scopes":[],"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"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_416","description":"Maximum number of results to return. Defaults to 1000, maximum 1000."},{"name":"offset","in":"query","schemaId":"schema_416","description":"Number of results to skip. Defaults to 0."},{"name":"search","in":"query","schemaId":"schema_417","description":"Filter results by organization name"},{"name":"sort_field","in":"query","schemaId":"schema_418","description":"The name of the field you wish to sort by."},{"name":"sort_order","in":"query","schemaId":"schema_419","description":"The order of the sort"},{"name":"app_id","in":"query","schemaId":"schema_420","description":"Filter results by application IDs"}],"pointer":"/paths/~1v1~1organizations~1me~1managed-organizations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/me/managed-organizations","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":"limit","in":"query","required":false,"schemaId":"schema_416"},{"name":"offset","in":"query","required":false,"schemaId":"schema_416"},{"name":"search","in":"query","required":false,"schemaId":"schema_417"},{"name":"sort_field","in":"query","required":false,"schemaId":"schema_418"},{"name":"sort_order","in":"query","required":false,"schemaId":"schema_419"},{"name":"app_id","in":"query","required":false,"schemaId":"schema_420"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/organizations/me/managed-organizations","href":"other/getmanagedorganizations","openApiOperationId":"getManagedOrganizations","summary":"Get child organizations"},"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/ApiGetOrganizationsPaginated"}},"schemaId":"components/schemas/ApiGetOrganizationsPaginated"}],"pointer":"/paths/~1v1~1organizations~1me~1managed-organizations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiGetOrganizationsPaginated","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGetOrganizationsPaginated"}}}],"examples":[]}]}]}]},"httpPath":"/v1/organizations/me/managed-organizations"},{"label":"Create managed organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/createmanagedorganization","routeSlug":"/openapi/user/organizations.openapi/other/createmanagedorganization","metadata":{"seo":{"title":"Create managed organization","description":"Create a managed organization in context of a specific app. This should be called from the backend, using an admin access token (generated by a management app) or an organization admin access token. Required permissions: organizations:create, orgs:create."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createManagedOrganization","name":"Create managed organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1managed-organizations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create managed organization","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":"Create a managed organization in context of a specific app. This should be called from the backend, using an admin access token (generated by a management app) or an organization admin access token. "},"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":"organizations:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"organization_id","in":"path","schemaId":"schema_417","description":"The ID of the organization that creates the managed organization","required":true},{"name":"app_id","in":"path","schemaId":"schema_417","description":"ID of application","required":true}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1managed-organizations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCreateManagedOrganizationInput"}},"schemaId":"components/schemas/ApiCreateManagedOrganizationInput","pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1managed-organizations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/organizations/{organization_id}/applications/{app_id}/managed-organizations","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":"organization_id","in":"path","required":true,"schemaId":"schema_417"},{"name":"app_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiCreateManagedOrganizationInput"}},"responseCodes":["201","409"],"pointer":"/v1/organizations/{organization_id}/applications/{app_id}/managed-organizations","href":"other/createmanagedorganization","openApiOperationId":"createManagedOrganization","summary":"Create managed organization"},"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/ApiCreateManagedOrganizationInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCreateManagedOrganizationInput"}},"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_424"}},"schemaId":"schema_424"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentifierIsTakenHttpError"}},"schemaId":"components/schemas/IdentifierIsTakenHttpError"}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1managed-organizations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_424","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_424"}}},{"code":"409","schemaId":"components/schemas/IdentifierIsTakenHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentifierIsTakenHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/organizations/{organization_id}/applications/{app_id}/managed-organizations"},{"label":"Get managed organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/getallmanagedorganization","routeSlug":"/openapi/user/organizations.openapi/other/getallmanagedorganization","metadata":{"seo":{"title":"Get managed organizations","description":"Retrieves a list of all managed organizations. This should be called using a user access token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllManagedOrganization","name":"Get managed organizations","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1managed-organizations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get managed organizations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all managed organizations. This should be called using a user access token."},{"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":"organization_id","in":"path","schemaId":"schema_417","description":"The ID of the organization that created the managed organizations","required":true},{"name":"app_id","in":"path","schemaId":"schema_417","description":"ID of application","required":true}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1managed-organizations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_416","description":"Maximum number of results to return. Defaults to 1000, maximum 1000."},{"name":"offset","in":"query","schemaId":"schema_416","description":"Number of results to skip. Defaults to 0."},{"name":"search","in":"query","schemaId":"schema_417","description":"Filter results by organization name"},{"name":"sort_field","in":"query","schemaId":"schema_418","description":"The name of the field you wish to sort by."},{"name":"sort_order","in":"query","schemaId":"schema_419","description":"The order of the sort"}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1managed-organizations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{organization_id}/applications/{app_id}/managed-organizations","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":"organization_id","in":"path","required":true,"schemaId":"schema_417"},{"name":"app_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_416"},{"name":"offset","in":"query","required":false,"schemaId":"schema_416"},{"name":"search","in":"query","required":false,"schemaId":"schema_417"},{"name":"sort_field","in":"query","required":false,"schemaId":"schema_418"},{"name":"sort_order","in":"query","required":false,"schemaId":"schema_419"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/organizations/{organization_id}/applications/{app_id}/managed-organizations","href":"other/getallmanagedorganization","openApiOperationId":"getAllManagedOrganization","summary":"Get managed organizations"},"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/ApiGetOrganizationsPaginated"}},"schemaId":"components/schemas/ApiGetOrganizationsPaginated"}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1managed-organizations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiGetOrganizationsPaginated","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGetOrganizationsPaginated"}}}],"examples":[]}]}]}]},"httpPath":"/v1/organizations/{organization_id}/applications/{app_id}/managed-organizations"},{"label":"Get SSO configuration for specific application in the organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/getappssoconfiguration","routeSlug":"/openapi/user/organizations.openapi/other/getappssoconfiguration","metadata":{"seo":{"title":"Get SSO configuration for specific application in the organization","description":"Get SSO configuration for specific application in the organization. Required permissions: organizations:read, orgs:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppSSOConfiguration","name":"Get SSO configuration for specific application in the organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1sso/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get SSO configuration for specific application in the organization","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":"Get SSO configuration for specific application in the organization. "},"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":"organizations:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"organization_id","in":"path","schemaId":"schema_417","description":"ID of the organization","required":true},{"name":"app_id","in":"path","schemaId":"schema_417","description":"ID of the application","required":true}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1sso/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{organization_id}/applications/{app_id}/sso","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":"organization_id","in":"path","required":true,"schemaId":"schema_417"},{"name":"app_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/organizations/{organization_id}/applications/{app_id}/sso","href":"other/getappssoconfiguration","openApiOperationId":"getAppSSOConfiguration","summary":"Get SSO configuration for specific application in the organization"},"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_425"}},"schemaId":"schema_425"}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1sso/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_425","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}}}],"examples":[]}]}]}]},"httpPath":"/v1/organizations/{organization_id}/applications/{app_id}/sso"},{"label":"Set SSO SAML configuration for specific application in the organization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/setappssosamlconfiguration","routeSlug":"/openapi/user/organizations.openapi/other/setappssosamlconfiguration","metadata":{"seo":{"title":"Set SSO SAML configuration for specific application in the organization","description":"Set SSO SAML configuration for specific application in the organization. Creates a new configuration if it does not exist, or updates an existing one. Required permissions: organizations:edit, orgs:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setAppSSOSamlConfiguration","name":"Set SSO SAML configuration for specific application in the organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1sso~1saml~1set/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set SSO SAML configuration for specific application in the organization","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":"Set SSO SAML configuration for specific application in the organization. Creates a new configuration if it does not exist, or updates an existing one. "},"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":"organizations:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"organization_id","in":"path","schemaId":"schema_417","description":"ID of the organization","required":true},{"name":"app_id","in":"path","schemaId":"schema_417","description":"ID of the application","required":true}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1sso~1saml~1set/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SsoSamlConfigurationInput"}},"schemaId":"components/schemas/SsoSamlConfigurationInput","pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1sso~1saml~1set/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{organization_id}/applications/{app_id}/sso/saml/set","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":"organization_id","in":"path","required":true,"schemaId":"schema_417"},{"name":"app_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SsoSamlConfigurationInput"}},"responseCodes":["200"],"pointer":"/v1/organizations/{organization_id}/applications/{app_id}/sso/saml/set","href":"other/setappssosamlconfiguration","openApiOperationId":"setAppSSOSamlConfiguration","summary":"Set SSO SAML configuration for specific application in the organization"},"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/SsoSamlConfigurationInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SsoSamlConfigurationInput"}},"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_426"}},"schemaId":"schema_426"}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1sso~1saml~1set/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_426","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}}}],"examples":[]}]}]}]},"httpPath":"/v1/organizations/{organization_id}/applications/{app_id}/sso/saml/set"},{"label":"Set SSO OIDC configuration for specific application in the organization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/setappssooidcconfiguration","routeSlug":"/openapi/user/organizations.openapi/other/setappssooidcconfiguration","metadata":{"seo":{"title":"Set SSO OIDC configuration for specific application in the organization","description":"Set SSO OIDC configuration for specific application in the organization. Creates a new configuration if it does not exist, or updates an existing one. Required permissions: organizations:edit, orgs:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setAppSSOOIDCConfiguration","name":"Set SSO OIDC configuration for specific application in the organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1sso~1oidc~1set/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set SSO OIDC configuration for specific application in the organization","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":"Set SSO OIDC configuration for specific application in the organization. Creates a new configuration if it does not exist, or updates an existing one. "},"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":"organizations:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"organization_id","in":"path","schemaId":"schema_417","description":"ID of the organization","required":true},{"name":"app_id","in":"path","schemaId":"schema_417","description":"ID of the application","required":true}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1sso~1oidc~1set/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SsoOidcConfigurationInput"}},"schemaId":"components/schemas/SsoOidcConfigurationInput","pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1sso~1oidc~1set/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{organization_id}/applications/{app_id}/sso/oidc/set","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":"organization_id","in":"path","required":true,"schemaId":"schema_417"},{"name":"app_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SsoOidcConfigurationInput"}},"responseCodes":["200"],"pointer":"/v1/organizations/{organization_id}/applications/{app_id}/sso/oidc/set","href":"other/setappssooidcconfiguration","openApiOperationId":"setAppSSOOIDCConfiguration","summary":"Set SSO OIDC configuration for specific application in the organization"},"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/SsoOidcConfigurationInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SsoOidcConfigurationInput"}},"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_427"}},"schemaId":"schema_427"}],"pointer":"/paths/~1v1~1organizations~1{organization_id}~1applications~1{app_id}~1sso~1oidc~1set/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_427","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427"}}}],"examples":[]}]}]}]},"httpPath":"/v1/organizations/{organization_id}/applications/{app_id}/sso/oidc/set"},{"label":"Set org's roles and role groups","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/setassignedrolesandgroups","routeSlug":"/openapi/user/organizations.openapi/other/setassignedrolesandgroups","metadata":{"seo":{"title":"Set org's roles and role groups","description":"Update the roles and role groups of the organization for a specific application, which will replace any existing assignments. These roles and role groups must first be created for the application. Once added to the organization, roles that belong to these role groups or are directly assigned can be assigned to members of the organization to control their access to the application. Required permissions: organizations:edit, orgs:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setAssignedRolesAndGroups","name":"Set org's roles and role groups","isWebhook":false,"pointer":"/paths/~1v1~1applications~1{app_id}~1organizations~1{organization_id}~1roles-and-groups~1set/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set org's roles and role groups","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":"Update the roles and role groups of the organization for a specific application, which will replace any existing assignments. These roles and role groups must first be created for the application. Once added to the organization, roles that belong to these role groups or are directly assigned can be assigned to members of the organization to control their access to the application. "},"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":"organizations:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"app_id","in":"path","schemaId":"schema_417","description":"ID of the application","required":true},{"name":"organization_id","in":"path","schemaId":"schema_417","description":"ID of the organization","required":true}],"pointer":"/paths/~1v1~1applications~1{app_id}~1organizations~1{organization_id}~1roles-and-groups~1set/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RolesAndRoleGroupsInputDto"}},"schemaId":"components/schemas/RolesAndRoleGroupsInputDto","pointer":"/paths/~1v1~1applications~1{app_id}~1organizations~1{organization_id}~1roles-and-groups~1set/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/applications/{app_id}/organizations/{organization_id}/roles-and-groups/set","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":"app_id","in":"path","required":true,"schemaId":"schema_417"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RolesAndRoleGroupsInputDto"}},"responseCodes":["202"],"pointer":"/v1/applications/{app_id}/organizations/{organization_id}/roles-and-groups/set","href":"other/setassignedrolesandgroups","openApiOperationId":"setAssignedRolesAndGroups","summary":"Set org's roles and role groups"},"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/RolesAndRoleGroupsInputDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RolesAndRoleGroupsInputDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202"}],"pointer":"/paths/~1v1~1applications~1{app_id}~1organizations~1{organization_id}~1roles-and-groups~1set/post/responses"}],"panels":[]}]},"httpPath":"/v1/applications/{app_id}/organizations/{organization_id}/roles-and-groups/set"},{"label":"Get org's roles and role groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/getassignedrolesandgroups","routeSlug":"/openapi/user/organizations.openapi/other/getassignedrolesandgroups","metadata":{"seo":{"title":"Get org's roles and role groups","description":"Retrieves all roles and role groups that were added to the organization for a specific application. Roles that belong to these role groups or are directly assigned can be assigned to members of the organization to control their access to the application. Required permissions: organizations:read, orgs:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssignedRolesAndGroups","name":"Get org's roles and role groups","isWebhook":false,"pointer":"/paths/~1v1~1applications~1{app_id}~1organizations~1{organization_id}~1roles-and-groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get org's roles and role groups","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":"Retrieves all roles and role groups that were added to the organization for a specific application. Roles that belong to these role groups or are directly assigned can be assigned to members of the organization to control their access to the application. "},"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":"organizations:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"app_id","in":"path","schemaId":"schema_417","description":"ID of the application","required":true},{"name":"organization_id","in":"path","schemaId":"schema_417","description":"ID of the organization","required":true}],"pointer":"/paths/~1v1~1applications~1{app_id}~1organizations~1{organization_id}~1roles-and-groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/applications/{app_id}/organizations/{organization_id}/roles-and-groups","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":"app_id","in":"path","required":true,"schemaId":"schema_417"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/applications/{app_id}/organizations/{organization_id}/roles-and-groups","href":"other/getassignedrolesandgroups","openApiOperationId":"getAssignedRolesAndGroups","summary":"Get org's roles and role groups"},"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_428"}},"schemaId":"schema_428"}],"pointer":"/paths/~1v1~1applications~1{app_id}~1organizations~1{organization_id}~1roles-and-groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_428","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_428"}}}],"examples":[]}]}]}]},"httpPath":"/v1/applications/{app_id}/organizations/{organization_id}/roles-and-groups"},{"label":"Set org's role groups","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/setassignedrolegroups","routeSlug":"/openapi/user/organizations.openapi/other/setassignedrolegroups","metadata":{"seo":{"title":"Set org's role groups","description":"Update the role groups of the organization for a specific application, which will replace any existing role groups for the organization. These role groups must first be created for the application. Once added to the organization, roles that belong to these role groups can be assigned to members of the organization to control their access to the application. Required permissions: organizations:edit, orgs:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setAssignedRoleGroups","name":"Set org's role groups","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1applications~1{app_id}~1organizations~1{organization_id}~1role-groups~1set/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set org's role groups","isWebhook":false,"deprecated":true,"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":"Update the role groups of the organization for a specific application, which will replace any existing role groups for the organization. These role groups must first be created for the application. Once added to the organization, roles that belong to these role groups can be assigned to members of the organization to control their access to the application. "},"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":"organizations:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"app_id","in":"path","schemaId":"schema_417","description":"ID of the application to set the roles to","required":true},{"name":"organization_id","in":"path","schemaId":"schema_417","description":"ID of the organization to set the roles to","required":true}],"pointer":"/paths/~1v1~1applications~1{app_id}~1organizations~1{organization_id}~1role-groups~1set/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiRoleGroupIds"}},"schemaId":"components/schemas/ApiRoleGroupIds","pointer":"/paths/~1v1~1applications~1{app_id}~1organizations~1{organization_id}~1role-groups~1set/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/applications/{app_id}/organizations/{organization_id}/role-groups/set","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":"app_id","in":"path","required":true,"schemaId":"schema_417"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiRoleGroupIds"}},"responseCodes":["202"],"pointer":"/v1/applications/{app_id}/organizations/{organization_id}/role-groups/set","href":"other/setassignedrolegroups","openApiOperationId":"setAssignedRoleGroups","summary":"Set org's role groups"},"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/ApiRoleGroupIds","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiRoleGroupIds"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202"}],"pointer":"/paths/~1v1~1applications~1{app_id}~1organizations~1{organization_id}~1role-groups~1set/post/responses"}],"panels":[]}]},"httpPath":"/v1/applications/{app_id}/organizations/{organization_id}/role-groups/set"},{"label":"Get org's role groups","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/organizations.openapi/other/getassignedrolegroups","routeSlug":"/openapi/user/organizations.openapi/other/getassignedrolegroups","metadata":{"seo":{"title":"Get org's role groups","description":"Retrieves all role groups that were added to the organization for a specific application. Roles that belong to these role groups can be assigned to members of the organization to control their access to the application. Required permissions: organizations:read, orgs:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssignedRoleGroups","name":"Get org's role groups","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1applications~1{app_id}~1organizations~1{organization_id}~1role-groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get org's role groups","isWebhook":false,"deprecated":true,"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":"Retrieves all role groups that were added to the organization for a specific application. Roles that belong to these role groups can be assigned to members of the organization to control their access to the application. "},"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":"organizations:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"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":"app_id","in":"path","schemaId":"schema_417","description":"ID of the application to assign the roles to","required":true},{"name":"organization_id","in":"path","schemaId":"schema_417","description":"ID of the organization to assign the roles to","required":true}],"pointer":"/paths/~1v1~1applications~1{app_id}~1organizations~1{organization_id}~1role-groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/applications/{app_id}/organizations/{organization_id}/role-groups","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":"app_id","in":"path","required":true,"schemaId":"schema_417"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_417"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AdminAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/applications/{app_id}/organizations/{organization_id}/role-groups","href":"other/getassignedrolegroups","openApiOperationId":"getAssignedRoleGroups","summary":"Get org's role groups"},"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_429"}},"schemaId":"schema_429"}],"pointer":"/paths/~1v1~1applications~1{app_id}~1organizations~1{organization_id}~1role-groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}}],"examples":[]}]}]}]},"httpPath":"/v1/applications/{app_id}/organizations/{organization_id}/role-groups"}],"store":{"schemaStore":{"components/schemas/ApiCreateOrganizationInput":{"id":"components/schemas/ApiCreateOrganizationInput","kind":"json-schema","title":"ApiCreateOrganizationInput","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the organization"},"domain":{"type":"string","description":"Domain of the organization","deprecated":true},"domains":{"description":"Domains of the organization","type":"array","items":{"type":"string"}},"app_ids":{"description":"A list of applications the organization can access","type":"array","items":{"type":"string"}},"enabled":{"type":"boolean","description":"Indicates if the organization is currently enabled"},"alias_name":{"type":"string","description":"Alias name of the organization"}},"required":["name","domain","domains","app_ids"]}},"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/IdentifierIsTakenHttpError":{"id":"components/schemas/IdentifierIsTakenHttpError","kind":"json-schema","title":"IdentifierIsTakenHttpError","data":{"type":"object","properties":{"message":{"type":"string"},"error_code":{"type":"number"},"ts_error_code":{"type":"string"}},"required":["message","error_code","ts_error_code"]}},"components/schemas/ApiOrganization":{"id":"components/schemas/ApiOrganization","kind":"json-schema","title":"ApiOrganization","data":{"type":"object","properties":{"organization_id":{"type":"string","description":"ID of the organization"},"app_ids":{"description":"A list of applications the organization can access","type":"array","items":{"type":"string"}},"name":{"type":"string","description":"Name of the organization"},"domain":{"type":"string","description":"Domain of the organization","deprecated":true},"domains":{"description":"Domains of the organization","type":"array","items":{"type":"string"}},"created_at":{"type":"number","description":"Date the organization was created in the tenant"},"updated_at":{"type":"number","description":"Date the organization was last updated"},"enabled":{"type":"boolean","description":"Indicates if the organization is currently enabled"},"managed_organizations_by_app":{"type":"object","description":"Mapping of app IDs to managed organization IDs assigned to this app","additionalProperties":{"type":"array","items":{"type":"string"}}},"managing_organization_id":{"type":"string","description":"ID of the managing organization"},"logo_url":{"type":"string","description":"The URL of the organization's logo"},"alias_name":{"type":"string","description":"Alias name of the organization"}},"required":["organization_id","app_ids","name","domain","enabled"]}},"components/schemas/ApiGetOrganizationsPaginated":{"id":"components/schemas/ApiGetOrganizationsPaginated","kind":"json-schema","title":"ApiGetOrganizationsPaginated","data":{"type":"object","properties":{"total_count":{"type":"number"},"page_info":{"$ref":"#/components/schemas/PageInfo"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ApiOrganization"}}},"required":["total_count","page_info","result"]}},"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/ApiUpdateOrganizationInput":{"id":"components/schemas/ApiUpdateOrganizationInput","kind":"json-schema","title":"ApiUpdateOrganizationInput","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the organization"},"domain":{"type":"string","description":"Domain of the organization","deprecated":true},"domains":{"description":"Domains of the organization","type":"array","items":{"type":"string"}},"enabled":{"type":"boolean","description":"Indicates if the organization is currently enabled"},"alias_name":{"type":"string","description":"Alias name of the organization"}}}},"components/schemas/ApiAppIds":{"id":"components/schemas/ApiAppIds","kind":"json-schema","title":"ApiAppIds","data":{"type":"object","properties":{"app_ids":{"description":"A list of applications to add the organization to","type":"array","items":{"type":"string"}}},"required":["app_ids"]}},"components/schemas/LogoUploadDto":{"id":"components/schemas/LogoUploadDto","kind":"json-schema","title":"LogoUploadDto","data":{"type":"object","properties":{"logo":{"type":"string","format":"binary"}},"required":["logo"]}},"components/schemas/ApiGetManagedOrganizationsPaginated":{"id":"components/schemas/ApiGetManagedOrganizationsPaginated","kind":"json-schema","title":"ApiGetManagedOrganizationsPaginated","data":{"type":"object","properties":{"total_count":{"type":"number"},"page_info":{"$ref":"#/components/schemas/PageInfo"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ApiOrganization"}}},"required":["total_count","page_info","result"]}},"components/schemas/ApiCreateManagedOrganizationInput":{"id":"components/schemas/ApiCreateManagedOrganizationInput","kind":"json-schema","title":"ApiCreateManagedOrganizationInput","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the organization"},"domain":{"type":"string","description":"Domain of the organization","deprecated":true},"domains":{"description":"Domains of the organization","type":"array","items":{"type":"string"}},"enabled":{"type":"boolean","description":"Indicates if the organization is currently enabled"},"alias_name":{"type":"string","description":"Alias name of the managed organization"}},"required":["name","domain","domains"]}},"components/schemas/ApiAppSSOConfiguration":{"id":"components/schemas/ApiAppSSOConfiguration","kind":"json-schema","title":"ApiAppSSOConfiguration","data":{"type":"object","properties":{"app_id":{"type":"string","description":"ID of the application"},"name":{"type":"string","description":"Name of the SSO configuration"},"enabled":{"type":"boolean","description":"Indicates whether the SSO configuration is enabled"},"sso_provider":{"type":"string","enum":["SAML","OIDC"],"description":"SSO provider type","default":"SAML"},"configuration":{"oneOf":[{"$ref":"#/components/schemas/ApiSAMLConfiguration","description":"Configuration of the SAML provider"},{"$ref":"#/components/schemas/ApiOIDCConfiguration","description":"Configuration of the OIDC provider"}],"description":"Configuration of the SSO provider"},"group_role_mapping":{"description":"Group-to-role mapping configuration","allOf":[{"$ref":"#/components/schemas/ApiGroupRoleMappingConfig"}]}},"required":["app_id","name","enabled","configuration"]}},"components/schemas/SsoSamlConfigurationInput":{"id":"components/schemas/SsoSamlConfigurationInput","kind":"json-schema","title":"SsoSamlConfigurationInput","data":{"type":"object","properties":{"service_provider":{"$ref":"#/components/schemas/ApiSAMLServiceProviderConfigurationInput"},"identity_provider":{"$ref":"#/components/schemas/ApiSAMLIdentityProviderConfigurationInput"},"name":{"type":"string","description":"Name of the SSO configuration"},"enabled":{"type":"boolean","description":"Indicates whether the SSO configuration is enabled","default":true},"sso_signup_enabled":{"type":"boolean","description":"Indicates whether public signup through SSO is allowed"},"group_role_mapping":{"description":"Group-to-role mapping configuration","allOf":[{"$ref":"#/components/schemas/ApiGroupRoleMappingConfigInput"}]}},"required":["service_provider","identity_provider","name"]}},"components/schemas/String":{"id":"components/schemas/String","kind":"json-schema","title":"String","data":{"type":"object","properties":{}}},"components/schemas/SsoOidcConfigurationInput":{"id":"components/schemas/SsoOidcConfigurationInput","kind":"json-schema","title":"SsoOidcConfigurationInput","data":{"type":"object","properties":{"client_id":{"type":"string","maxLength":150,"description":"The client ID of the OIDC provider"},"client_secret":{"type":"string","maxLength":150,"description":"The client secret of the OIDC provider"},"issuer_url":{"type":"string","description":"The issuer URL of the OIDC provider"},"email_attr":{"type":"string","description":"The email attribute on the decoded token to be used as the user email"},"redirect_uri":{"type":"string","description":"Redirect URI for backend-driven flows"},"identifier_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier type used to look up the user during authentication (e.g. email, phone_number, username)"},"children":[]}]}]}]},"name":{"type":"string","description":"Name of the SSO configuration"},"enabled":{"type":"boolean","description":"Indicates whether the SSO configuration is enabled","default":true},"sso_signup_enabled":{"type":"boolean","description":"Indicates whether public signup through SSO is allowed"},"group_role_mapping":{"description":"Group-to-role mapping configuration","allOf":[{"$ref":"#/components/schemas/ApiGroupRoleMappingConfigInput"}]}},"required":["client_id","client_secret","issuer_url","name"]}},"components/schemas/PageInfo":{"id":"components/schemas/PageInfo","kind":"json-schema","title":"PageInfo","data":{"type":"object","properties":{"has_next_page":{"type":"boolean"},"has_previous_page":{"type":"boolean"}},"required":["has_next_page","has_previous_page"]}},"components/schemas/ApiSAMLServiceProviderConfigurationInput":{"id":"components/schemas/ApiSAMLServiceProviderConfigurationInput","kind":"json-schema","title":"ApiSAMLServiceProviderConfigurationInput","data":{"type":"object","properties":{"default_redirect_uri":{"type":"string","description":"Default redirect URI for the application","default":""},"acs_url":{"type":"string","description":"Custom ACS URL for backend-driven flows"}}}},"components/schemas/ApiSAMLIdentityProviderConfigurationInput":{"id":"components/schemas/ApiSAMLIdentityProviderConfigurationInput","kind":"json-schema","title":"ApiSAMLIdentityProviderConfigurationInput","data":{"type":"object","properties":{"entity_id":{"type":"string","description":"Entity ID of the identity provider"},"sso_url":{"type":"string","description":"Single sign-on URL of the SAML identity provider, which will receive the authentication request"},"signing_certificates":{"description":"Certificates used to validate the signature of the SAML response. Provided by the SAML identity provider.","type":"array","items":{"type":"string"}},"nameid_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identifier in the SAML nameId (email, phone_number, username, etc.)"},"children":[]}]}]}]}},"required":["entity_id","sso_url","signing_certificates"]}},"components/schemas/ApiSAMLConfiguration":{"id":"components/schemas/ApiSAMLConfiguration","kind":"json-schema","title":"ApiSAMLConfiguration","data":{"type":"object","properties":{"service_provider":{"$ref":"#/components/schemas/ApiDirectSAMLServiceProviderConfiguration"},"identity_provider":{"$ref":"#/components/schemas/ApiSAMLIdentityProviderConfiguration"}},"required":["service_provider","identity_provider"]}},"components/schemas/ApiOIDCConfiguration":{"id":"components/schemas/ApiOIDCConfiguration","kind":"json-schema","title":"ApiOIDCConfiguration","data":{"type":"object","properties":{"client_id":{"type":"string","description":"The client ID of the OIDC provider"},"client_secret":{"type":"string","description":"The client secret of the OIDC provider"},"issuer_url":{"type":"string","description":"The issuer URL of the OIDC provider"},"email_attr":{"type":"string","description":"The email attribute on the decoded token to be used as the user email"},"redirect_uri":{"type":"string","description":"Redirect URI for backend-driven flows"},"identifier_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier type used to look up the user during authentication (e.g. email, phone_number, username)"},"children":[]}]}]}]}},"required":["client_id","client_secret","issuer_url"]}},"components/schemas/ApiGroupRoleMappingConfig":{"id":"components/schemas/ApiGroupRoleMappingConfig","kind":"json-schema","title":"ApiGroupRoleMappingConfig","data":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether group-to-role mapping is enabled for this SSO configuration"},"group_claim_name":{"type":"string","description":"Attribute/claim in the SSO response that carries the group names"},"mappings":{"description":"Mappings of federated IdP group name to Mosaic role IDs","type":"array","items":{"$ref":"#/components/schemas/ApiGroupRoleMappingItem"}},"default_role_ids":{"description":"Fallback Mosaic role IDs used when no mapping resolves","type":"array","items":{"type":"string"}}},"required":["enabled","mappings","default_role_ids"]}},"components/schemas/ApiGroupRoleMappingConfigInput":{"id":"components/schemas/ApiGroupRoleMappingConfigInput","kind":"json-schema","title":"ApiGroupRoleMappingConfigInput","data":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Link federated IdP groups to user roles to automate permission assignments","default":false},"group_claim_name":{"type":"string","description":"Attribute/claim in the SSO response that carries the group names (e.g. groups, memberOf, or a URI)","default":"groups"},"mappings":{"description":"Mappings of federated IdP group name to Mosaic role IDs","type":"array","items":{"$ref":"#/components/schemas/ApiGroupRoleMappingItemInput"}},"default_role_ids":{"description":"Fallback Mosaic role IDs used when no mapping resolves","type":"array","items":{"type":"string"}}}}},"components/schemas/ApiDirectSAMLServiceProviderConfiguration":{"id":"components/schemas/ApiDirectSAMLServiceProviderConfiguration","kind":"json-schema","title":"ApiDirectSAMLServiceProviderConfiguration","data":{"type":"object","properties":{"acs_url":{"type":"string","description":"Assertion consumer service URL of the application, which receives the SAML response."},"entity_id":{"type":"string","description":"Entity ID that identifies the SAML service provider"},"default_redirect_uri":{"type":"string","description":"Default redirect URI for the application"}},"required":["acs_url","entity_id"]}},"components/schemas/ApiSAMLIdentityProviderConfiguration":{"id":"components/schemas/ApiSAMLIdentityProviderConfiguration","kind":"json-schema","title":"ApiSAMLIdentityProviderConfiguration","data":{"type":"object","properties":{"entity_id":{"type":"string","description":"Entity ID of the identity provider"},"sso_url":{"type":"string","description":"Single sign-on URL of the SAML identity provider, which will receive the authentication request"},"signing_certificates":{"description":"Certificates used to validate the signature of the SAML response. Provided by the SAML identity provider.","type":"array","items":{"type":"string"}},"sign_saml_requests":{"type":"boolean","description":"Signing SAML Requests","default":false},"nameid_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identifier in the SAML nameId (email, phone_number, username, etc.)"},"children":[]}]}]}]}},"required":["entity_id","sso_url","signing_certificates"]}},"components/schemas/ApiGroupRoleMappingItem":{"id":"components/schemas/ApiGroupRoleMappingItem","kind":"json-schema","title":"ApiGroupRoleMappingItem","data":{"type":"object","properties":{"idp_group_name":{"type":"string","description":"Federated IdP group name as it appears in the SSO response"},"role_ids":{"description":"Mosaic role IDs to assign for this group (1 group to N roles)","type":"array","items":{"type":"string"}}},"required":["idp_group_name","role_ids"]}},"components/schemas/ApiGroupRoleMappingItemInput":{"id":"components/schemas/ApiGroupRoleMappingItemInput","kind":"json-schema","title":"ApiGroupRoleMappingItemInput","data":{"type":"object","properties":{"idp_group_name":{"type":"string","description":"Federated IdP group name as it appears in the SSO response"},"role_ids":{"description":"Mosaic role IDs to assign for this group (1 group to N roles)","type":"array","items":{"type":"string"}}},"required":["idp_group_name","role_ids"]}},"components/schemas/ApiRoleGroupIds":{"id":"components/schemas/ApiRoleGroupIds","kind":"json-schema","title":"ApiRoleGroupIds","data":{"type":"object","properties":{"role_group_ids":{"description":"Role group ids","type":"array","items":{"type":"string"}}},"required":["role_group_ids"]}},"components/schemas/RoleGroupsAndDefaultOrgRolesDto":{"id":"components/schemas/RoleGroupsAndDefaultOrgRolesDto","kind":"json-schema","title":"RoleGroupsAndDefaultOrgRolesDto","data":{"type":"object","properties":{"role_groups":{"description":"Role groups","type":"array","items":{"$ref":"#/components/schemas/ApiRoleGroup"}},"default_organization_roles":{"description":"Default organization roles","type":"array","items":{"$ref":"#/components/schemas/ApiRole"}}},"required":["role_groups","default_organization_roles"]}},"components/schemas/RolesAndRoleGroupsInputDto":{"id":"components/schemas/RolesAndRoleGroupsInputDto","kind":"json-schema","title":"RolesAndRoleGroupsInputDto","data":{"type":"object","properties":{"role_group_ids":{"description":"Role group ids","type":"array","items":{"type":"string"}},"role_ids":{"description":"Role ids","type":"array","items":{"type":"string"}}}}},"components/schemas/RolesAndRoleGroupsDto":{"id":"components/schemas/RolesAndRoleGroupsDto","kind":"json-schema","title":"RolesAndRoleGroupsDto","data":{"type":"object","properties":{"role_groups":{"description":"Role groups","type":"array","items":{"$ref":"#/components/schemas/ApiRoleGroup"}},"default_organization_roles":{"description":"Default organization roles","type":"array","items":{"$ref":"#/components/schemas/ApiRole"}},"roles":{"description":"Assigned roles","type":"array","items":{"$ref":"#/components/schemas/ApiRole"}}},"required":["role_groups","default_organization_roles","roles"]}},"components/schemas/ApiRoleGroup":{"id":"components/schemas/ApiRoleGroup","kind":"json-schema","title":"ApiRoleGroup","data":{"type":"object","properties":{"group_id":{"type":"string","description":"Group ID"},"name":{"type":"string","description":"Group name"},"description":{"type":"string","description":"Group description"},"roles":{"description":"Group's roles","type":"array","items":{"$ref":"#/components/schemas/ApiRole"}},"display_name":{"type":"string","description":"Role group's display name"}},"required":["group_id","name","roles"]}},"components/schemas/ApiRole":{"id":"components/schemas/ApiRole","kind":"json-schema","title":"ApiRole","data":{"type":"object","properties":{"role_id":{"type":"string","description":"Role ID"},"role_name":{"type":"string","description":"Role name"},"permissions":{"description":"Role permissions","type":"array","items":{"type":"string"}},"app_id":{"type":"string","description":"Role's app id"},"description":{"type":"string","description":"Role's description"},"display_name":{"type":"string","description":"Role's display name"}},"required":["role_id","role_name"]}},"schema_415":{"kind":"json-schema","data":{"title":"ApiCreatedResponse-createOrganization","type":"object","required":["result"],"description":"Organization created","properties":{"result":{"$ref":"#/components/schemas/ApiOrganization"}}},"id":"schema_415"},"schema_416":{"kind":"json-schema","data":{"type":"number"},"id":"schema_416"},"schema_417":{"kind":"json-schema","data":{"type":"string"},"id":"schema_417"},"schema_418":{"kind":"json-schema","data":{"default":"created_at","enum":["name","created_at","status"],"type":"string"},"id":"schema_418"},"schema_419":{"kind":"json-schema","data":{"default":"asc","enum":["asc","desc"],"type":"string"},"id":"schema_419"},"schema_420":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_420"},"schema_421":{"kind":"json-schema","data":{"title":"ApiOkResponse-getOrganization","type":"object","required":["result"],"description":"Organization information","properties":{"result":{"$ref":"#/components/schemas/ApiOrganization"}}},"id":"schema_421"},"schema_422":{"kind":"json-schema","data":{"title":"ApiOkResponse-updateOrganization","type":"object","required":["result"],"description":"Updated organization","properties":{"result":{"$ref":"#/components/schemas/ApiOrganization"}}},"id":"schema_422"},"schema_423":{"kind":"json-schema","data":{"title":"ApiOkResponse-getOrganizationByName","type":"object","required":["result"],"description":"Organization information","properties":{"result":{"$ref":"#/components/schemas/ApiOrganization"}}},"id":"schema_423"},"schema_424":{"kind":"json-schema","data":{"title":"ApiCreatedResponse-createManagedOrganization","type":"object","required":["result"],"description":"Managed organization created","properties":{"result":{"$ref":"#/components/schemas/ApiOrganization"}}},"id":"schema_424"},"schema_425":{"kind":"json-schema","data":{"title":"ApiOkResponse-getAppSSOConfiguration","type":"object","required":["result"],"description":"SSO configuration of the application","properties":{"result":{"$ref":"#/components/schemas/ApiAppSSOConfiguration"}}},"id":"schema_425"},"schema_426":{"kind":"json-schema","data":{"title":"ApiOkResponse-setAppSSOSamlConfiguration","type":"object","required":["result"],"description":"SSO configuration set","properties":{"result":{"$ref":"#/components/schemas/String"}}},"id":"schema_426"},"schema_427":{"kind":"json-schema","data":{"title":"ApiOkResponse-setAppSSOOIDCConfiguration","type":"object","required":["result"],"description":"SSO configuration set","properties":{"result":{"$ref":"#/components/schemas/String"}}},"id":"schema_427"},"schema_428":{"kind":"json-schema","data":{"title":"ApiOkResponse-getAssignedRolesAndGroups","type":"object","required":["result"],"description":"","properties":{"result":{"$ref":"#/components/schemas/RolesAndRoleGroupsDto"}}},"id":"schema_428"},"schema_429":{"kind":"json-schema","data":{"title":"ApiOkResponse-getAssignedRoleGroups","type":"object","required":["result"],"description":"","properties":{"result":{"$ref":"#/components/schemas/RoleGroupsAndDefaultOrgRolesDto"}}},"id":"schema_429"}},"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/organizations.openapi.json?download"},{"url":"/_bundle/openapi/user/organizations.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Organizations","description":"In business-to-business (B2B) use cases, organizations represent your business customers and partners. You can manage these organizations, and delegate access so they can manage their own membership. Using member APIs, organizations can manage the profiles of their users, control which apps they can access, and federate login to those apps using their own SAML-based identity providers."}},"baseSlug":"/openapi/user/organizations.openapi","routesMapping":{}}