{"items":[{"type":"link","label":"Clients","link":"/openapi/user/clients.openapi","routeSlug":"/openapi/user/clients.openapi","content":{"contentType":"overview","meta":{"name":"Clients"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"clients.openapi.json","url":"/_bundle/openapi/user/clients.openapi.json?download"},{"kind":"download","label":"clients.openapi.yaml","url":"/_bundle/openapi/user/clients.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":"Clients","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows an application to manage its clients, including updating existing clients and creating additional clients. To authorize API calls, use an access token for the relevant application. To manage apps and their clients as a tenant admin, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/user/apps.openapi"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application APIs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/openapi/user/clients.openapi"}],"sectionId":"/openapi/user/clients.openapi"}]}]}},{"label":"Create client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/clients.openapi/other/createclient","routeSlug":"/openapi/user/clients.openapi/other/createclient","metadata":{"seo":{"title":"Create client","description":"Creates an additional client for the app. To authorize a request, use an access token for the relevant application. Required permissions: apps:create, [appId]:create, apps:edit, [appId]:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createClient","name":"Create client","isWebhook":false,"pointer":"/paths/~1v1~1clients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create client","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":"Creates an additional client for the app. To authorize a request, use an access token for the relevant 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":"apps:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_368"}},"schemaId":"schema_368","pointer":"/paths/~1v1~1clients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clients","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":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_368"}},"responseCodes":["201","400","409"],"pointer":"/v1/clients","href":"other/createclient","openApiOperationId":"createClient","summary":"Create client"},"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":"schema_368","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_368"}},"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_369"}},"schemaId":"schema_369"},{"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~1clients/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}}},{"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/clients"},{"label":"Get all clients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/clients.openapi/other/getall","routeSlug":"/openapi/user/clients.openapi/other/getall","metadata":{"seo":{"title":"Get all clients","description":"Retrieves a list of clients for the app. To authorize a request, use an access token for the relevant application. Required permissions: apps:read, [appId]:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAll","name":"Get all clients","isWebhook":false,"pointer":"/paths/~1v1~1clients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all clients","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 a list of clients for the app. To authorize a request, use an access token for the relevant 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":"apps:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clients","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":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/clients","href":"other/getall","openApiOperationId":"getAll","summary":"Get all clients"},"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_370"}},"schemaId":"schema_370"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}},"schemaId":"components/schemas/BadRequestHttpError"}],"pointer":"/paths/~1v1~1clients/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_370","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370"}}},{"code":"400","schemaId":"components/schemas/BadRequestHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/clients"},{"label":"Delete all clients","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/clients.openapi/other/deleteclients","routeSlug":"/openapi/user/clients.openapi/other/deleteclients","metadata":{"seo":{"title":"Delete all clients","description":"Deletes all clients associated with the app. To authorize a request, use an access token for the relevant application. Note that the application cannot be used without clients. Required permissions: apps:create, [appId]:create, apps:edit, [appId]:edit, apps:delete, [appId]:delete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteClients","name":"Delete all clients","isWebhook":false,"pointer":"/paths/~1v1~1clients/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete all clients","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":"Deletes all clients associated with the app. To authorize a request, use an access token for the relevant application. Note that the application cannot be used without clients. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clients","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":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","404"],"pointer":"/v1/clients","href":"other/deleteclients","openApiOperationId":"deleteClients","summary":"Delete all clients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"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~1clients/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/clients"},{"label":"Get client by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/clients.openapi/other/getclientbyid","routeSlug":"/openapi/user/clients.openapi/other/getclientbyid","metadata":{"seo":{"title":"Get client by ID","description":"Retrieves a client by client ID. To authorize a request, use an access token for the relevant application. Required permissions: apps:read, [appId]:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getClientById","name":"Get client by ID","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get client 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":"Retrieves a client by client ID. To authorize a request, use an access token for the relevant 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":"apps:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_371","description":"ID of the client to retrieve","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clients/{clientId}","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":"clientId","in":"path","required":true,"schemaId":"schema_371"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v1/clients/{clientId}","href":"other/getclientbyid","openApiOperationId":"getClientById","summary":"Get client 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_369"}},"schemaId":"schema_369"},{"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~1clients~1{clientId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}}},{"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/clients/{clientId}"},{"label":"Update client","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/clients.openapi/other/updateclient","routeSlug":"/openapi/user/clients.openapi/other/updateclient","metadata":{"seo":{"title":"Update client","description":"Update a client by its ID. To authorize a request, use an access token for the relevant application. Note: Fields that are objects cannot be partially updated, since the new value you set will just replace the current one. Required permissions: apps:create, [appId]:create, apps:edit, [appId]:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateClient","name":"Update client","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update client","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 a client by its ID. To authorize a request, use an access token for the relevant application. Note: Fields that are objects cannot be partially updated, since the new value you set will just replace the current 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":"apps:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_371","description":"ID of the client to update","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372","pointer":"/paths/~1v1~1clients~1{clientId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clients/{clientId}","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":"clientId","in":"path","required":true,"schemaId":"schema_371"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_372"}},"responseCodes":["200","400","404"],"pointer":"/v1/clients/{clientId}","href":"other/updateclient","openApiOperationId":"updateClient","summary":"Update client"},"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":"schema_372","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_372"}},"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_369"}},"schemaId":"schema_369"},{"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~1clients~1{clientId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}}},{"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/clients/{clientId}"},{"label":"Delete client","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/clients.openapi/other/deleteclient","routeSlug":"/openapi/user/clients.openapi/other/deleteclient","metadata":{"seo":{"title":"Delete client","description":"Deletes a client. To authorize a request, use an access token for the relevant application. Required permissions: apps:create, [appId]:create, apps:edit, [appId]:edit, apps:delete, [appId]:delete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteClient","name":"Delete client","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete client","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":"Deletes a client. To authorize a request, use an access token for the relevant 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":"apps:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_371","description":"ID of the client to delete","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clients/{clientId}","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":"clientId","in":"path","required":true,"schemaId":"schema_371"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","404"],"pointer":"/v1/clients/{clientId}","href":"other/deleteclient","openApiOperationId":"deleteClient","summary":"Delete client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"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~1clients~1{clientId}/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/clients/{clientId}"},{"label":"Update client resources","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/clients.openapi/other/updateresourcesofclient","routeSlug":"/openapi/user/clients.openapi/other/updateresourcesofclient","metadata":{"seo":{"title":"Update client resources","description":"Updates the list of resources that a client is allowed to explicitly request access to. To authorize a request, use an access token for the relevant application. Required permissions: apps:create, [appId]:create, apps:edit, [appId]:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateResourcesOfClient","name":"Update client resources","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1resources/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update client resources","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":"Updates the list of resources that a client is allowed to explicitly request access to. To authorize a request, use an access token for the relevant 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":"apps:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_371","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1resources/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiUpdateResourceInAppInput"}},"schemaId":"components/schemas/ApiUpdateResourceInAppInput","pointer":"/paths/~1v1~1clients~1{clientId}~1resources/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clients/{clientId}/resources","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":"clientId","in":"path","required":true,"schemaId":"schema_371"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiUpdateResourceInAppInput"}},"responseCodes":["200"],"pointer":"/v1/clients/{clientId}/resources","href":"other/updateresourcesofclient","openApiOperationId":"updateResourcesOfClient","summary":"Update client resources"},"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/ApiUpdateResourceInAppInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiUpdateResourceInAppInput"}},"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_369"}},"schemaId":"schema_369"}],"pointer":"/paths/~1v1~1clients~1{clientId}~1resources/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}}}],"examples":[]}]}]}]},"httpPath":"/v1/clients/{clientId}/resources"},{"label":"Generate client secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/clients.openapi/other/clientsgeneratesecret","routeSlug":"/openapi/user/clients.openapi/other/clientsgeneratesecret","metadata":{"seo":{"title":"Generate client secret","description":"Generates a new client secret. A client can have up to two active secrets at a time. To authorize a request, use an access token for the relevant application. Required permissions: apps:create, [appId]:create, apps:edit, [appId]:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"clientsGenerateSecret","name":"Generate client secret","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1secrets/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate client secret","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":"Generates a new client secret. A client can have up to two active secrets at a time. To authorize a request, use an access token for the relevant 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":"apps:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_371","description":"ID of the client","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1secrets/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clients/{clientId}/secrets","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":"clientId","in":"path","required":true,"schemaId":"schema_371"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["201","400","404"],"pointer":"/v1/clients/{clientId}/secrets","href":"other/clientsgeneratesecret","openApiOperationId":"clientsGenerateSecret","summary":"Generate client secret"},"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":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiClientSecretResult"}},"schemaId":"components/schemas/ApiClientSecretResult"},{"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~1clients~1{clientId}~1secrets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ApiClientSecretResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiClientSecretResult"}}},{"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/clients/{clientId}/secrets"},{"label":"List client secrets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/clients.openapi/other/clientsgetactivesecrets","routeSlug":"/openapi/user/clients.openapi/other/clientsgetactivesecrets","metadata":{"seo":{"title":"List client secrets","description":"Retrieves the active client secrets for the client. To authorize a request, use an access token for the relevant application. Required permissions: apps:read, [appId]:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"clientsGetActiveSecrets","name":"List client secrets","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1secrets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List client secrets","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 the active client secrets for the client. To authorize a request, use an access token for the relevant 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":"apps:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_371","description":"ID of the client","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1secrets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clients/{clientId}/secrets","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":"clientId","in":"path","required":true,"schemaId":"schema_371"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/clients/{clientId}/secrets","href":"other/clientsgetactivesecrets","openApiOperationId":"clientsGetActiveSecrets","summary":"List client secrets"},"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_373"}},"schemaId":"schema_373"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"}],"pointer":"/paths/~1v1~1clients~1{clientId}~1secrets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_373","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_373"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/clients/{clientId}/secrets"},{"label":"Revoke client secret","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/clients.openapi/other/clientsrevokesecret","routeSlug":"/openapi/user/clients.openapi/other/clientsrevokesecret","metadata":{"seo":{"title":"Revoke client secret","description":"Revokes the specified client secret. Fails if the secret is the only active one for the client. To authorize a request, use an access token for the relevant application. Required permissions: apps:delete, [appId]:delete, apps:create, [appId]:create, apps:edit, [appId]:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"clientsRevokeSecret","name":"Revoke client secret","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{clientId}~1secrets~1{secretId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke client secret","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":"Revokes the specified client secret. Fails if the secret is the only active one for the client. To authorize a request, use an access token for the relevant 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":"apps:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_371","description":"ID of the client","required":true},{"name":"secretId","in":"path","schemaId":"schema_371","description":"ID of the secret to revoke","required":true}],"pointer":"/paths/~1v1~1clients~1{clientId}~1secrets~1{secretId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clients/{clientId}/secrets/{secretId}","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":"clientId","in":"path","required":true,"schemaId":"schema_371"},{"name":"secretId","in":"path","required":true,"schemaId":"schema_371"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","404"],"pointer":"/v1/clients/{clientId}/secrets/{secretId}","href":"other/clientsrevokesecret","openApiOperationId":"clientsRevokeSecret","summary":"Revoke client secret"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"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~1clients~1{clientId}~1secrets~1{secretId}/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/clients/{clientId}/secrets/{secretId}"}],"store":{"schemaStore":{"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/ApiOidcClient":{"id":"components/schemas/ApiOidcClient","kind":"json-schema","title":"ApiOidcClient","data":{"type":"object","properties":{"app_id":{"type":"string","description":"Application ID"},"tenant_id":{"type":"string","description":"Tenant ID"},"client_id":{"type":"string","description":"Client ID used for API requests"},"client_secret":{"type":"string","description":"Client secret used to obtain tokens for API authorization","deprecated":true},"name":{"type":"string","description":"Client name displayed in the Admin Portal"},"description":{"type":"string","description":"Short description of your client, displayed in the Admin Portal"},"resources":{"description":"List of resources this client is allowed to explicitly request access to","type":"array","items":{"type":"string"}},"created_at":{"format":"date-time","type":"string","description":"Date the client was created"},"updated_at":{"format":"date-time","type":"string","description":"Date the client was last updated"},"authentication_protocol":{"type":"string","description":"Authentication protocol used by the client","enum":["oidc","saml"]},"client_group_id":{"type":"string","description":"Id of client group where client is assigned"},"default_custom_claims":{"type":"array","description":"List of all the custom claims the client wants to receive by default","items":{"type":"string","enum":["tid","fname","lname","mname","email","email_verified","phone_number","phone_number_verified","groups","new_user","birthday","language","city","address","country","street_address","address_type","webauthn","roles","ts_roles","role_values","ts_permissions","permissions","approval_data","custom_group_data","username","secondary_phone_numbers","secondary_emails","picture","created_at","last_auth","auth_time","external_account_id","external_user_id","app_name","custom_data","custom_app_data","ai_actor"]}},"default_user_info_claims":{"type":"array","description":"List of client default custom claims returned by the UserInfo endpoint","items":{"type":"string","enum":["tid","fname","lname","mname","email","email_verified","phone_number","phone_number_verified","groups","new_user","birthday","language","city","address","country","street_address","address_type","webauthn","roles","ts_roles","role_values","ts_permissions","permissions","approval_data","custom_group_data","username","secondary_phone_numbers","secondary_emails","picture","created_at","last_auth","auth_time","external_account_id","external_user_id","app_name","custom_data","custom_app_data","ai_actor"]}},"sync_id_token_claims_to_userinfo":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, UserInfo custom claims are kept in sync with default_custom_claims"},"children":[]}]}]}],"default":false},"short_cookies_samesite_type":{"type":"string","enum":["lax","none"],"description":"Short cookies samesite type. Possible values: \"none\", \"lax\", \"strict\". Default: \"lax\"","default":"lax"},"redirect_uris":{"description":"List of URIs approved for redirects for your client","type":"array","items":{"type":"string"}},"client_type":{"type":"string","enum":["web","native"],"description":"Type of client","default":"web"},"response_types":{"type":"array","default":["code","id_token","none"],"example":["code"],"items":{"type":"string","enum":["code","id_token"]}},"token_endpoint_auth_method":{"type":"string","enum":["client_secret_basic","self_signed_tls_client_auth","tls_client_auth","none","private_key_jwt"],"description":"This field is deprecated- to configure pkce use \"pkce\" field instead","deprecated":true},"pkce":{"type":"string","enum":["enforcePkceInsteadOfClientCredentials","enforcePkceAlongsideClientCredentials","allowPkceAlongsideClientCredentials"],"description":"PKCE configuration"},"device_authorization":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc8628"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth Device Authorization Flow"},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/ApiDeviceAuthConfiguration"}]},"ciba_authorization":{"description":"CIBA authorization flow configuration","allOf":[{"$ref":"#/components/schemas/ApiCibaAuthConfiguration"}]},"supported_prompts":{"type":"array","description":"Supported prompts for oidc authentication flow","items":{"type":"string","enum":["login","consent","none"]}},"authentication_configuration":{"description":"JWKS configuration for mTLS authentication","allOf":[{"$ref":"#/components/schemas/ApiClientAuthenticationConfiguration"}]},"token_expiration":{"description":"Token expiration configuration","allOf":[{"$ref":"#/components/schemas/ApiTokenExpirationConfiguration"}]},"session_expiration":{"type":"number","description":"Session expiration time (seconds)"},"enforce_par":{"type":"boolean","description":"Enforce PAR (Pushed Authorization Request) for this client"},"fapi_version_compliancy":{"type":"boolean","description":"FAPI compliance"},"id_token_encryption":{"description":"ID Token encryption configuration","allOf":[{"$ref":"#/components/schemas/ApiIdTokenEncryptionConfiguration"}]}},"required":["app_id","tenant_id","client_id","client_secret","name","description","resources","created_at","updated_at","authentication_protocol","client_group_id","default_custom_claims","redirect_uris","device_authorization","ciba_authorization","supported_prompts","token_expiration","session_expiration","enforce_par","fapi_version_compliancy"]}},"components/schemas/ApiSamlClient":{"id":"components/schemas/ApiSamlClient","kind":"json-schema","title":"ApiSamlClient","data":{"type":"object","properties":{"app_id":{"type":"string","description":"Application ID"},"tenant_id":{"type":"string","description":"Tenant ID"},"client_id":{"type":"string","description":"Client ID used for API requests"},"client_secret":{"type":"string","description":"Client secret used to obtain tokens for API authorization","deprecated":true},"name":{"type":"string","description":"Client name displayed in the Admin Portal"},"description":{"type":"string","description":"Short description of your client, displayed in the Admin Portal"},"resources":{"description":"List of resources this client is allowed to explicitly request access to","type":"array","items":{"type":"string"}},"created_at":{"format":"date-time","type":"string","description":"Date the client was created"},"updated_at":{"format":"date-time","type":"string","description":"Date the client was last updated"},"authentication_protocol":{"type":"string","description":"Authentication protocol used by the client","enum":["oidc","saml"]},"client_group_id":{"type":"string","description":"Id of client group where client is assigned"},"default_custom_claims":{"type":"array","description":"List of all the custom claims the client wants to receive by default","items":{"type":"string","enum":["tid","fname","lname","mname","email","email_verified","phone_number","phone_number_verified","groups","new_user","birthday","language","city","address","country","street_address","address_type","webauthn","roles","ts_roles","role_values","ts_permissions","permissions","approval_data","custom_group_data","username","secondary_phone_numbers","secondary_emails","picture","created_at","last_auth","auth_time","external_account_id","external_user_id","app_name","custom_data","custom_app_data","ai_actor"]}},"default_user_info_claims":{"type":"array","description":"List of client default custom claims returned by the UserInfo endpoint","items":{"type":"string","enum":["tid","fname","lname","mname","email","email_verified","phone_number","phone_number_verified","groups","new_user","birthday","language","city","address","country","street_address","address_type","webauthn","roles","ts_roles","role_values","ts_permissions","permissions","approval_data","custom_group_data","username","secondary_phone_numbers","secondary_emails","picture","created_at","last_auth","auth_time","external_account_id","external_user_id","app_name","custom_data","custom_app_data","ai_actor"]}},"sync_id_token_claims_to_userinfo":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, UserInfo custom claims are kept in sync with default_custom_claims"},"children":[]}]}]}],"default":false},"short_cookies_samesite_type":{"type":"string","enum":["lax","none"],"description":"Short cookies samesite type. Possible values: \"none\", \"lax\", \"strict\". Default: \"lax\"","default":"lax"},"optional_acs_url":{"type":"boolean","description":"Allow the ACS URL to be optional"},"sp_acs_url":{"type":"string","description":"SAML ACS URL"},"sp_entity_id":{"type":"string","description":"SP SAML entity ID"},"metadata_url":{"type":"string","description":"SAML IDP metadata URL"},"sso_url":{"type":"string","description":"SAML SSO URL"},"entity_id":{"type":"string","description":"SAML Entity ID"},"x509_certificate":{"type":"string","description":"X.509 certificate"},"sp_name_id_type":{"type":"string","description":"SAML NameID Type","enum":["email","secondaryEmail","username","phoneNumber","externalUserId"]},"sign_assertion":{"type":"boolean","description":"Sign SAML assertion"},"use_centralized_login":{"type":"boolean","description":"When enabled, SAML SP-initiated SSO redirects to the tenant centralized hub application instead of hosted login"}},"required":["app_id","tenant_id","client_id","client_secret","name","description","resources","created_at","updated_at","authentication_protocol","client_group_id","default_custom_claims","optional_acs_url","sp_acs_url","sp_entity_id","metadata_url","sso_url","entity_id","x509_certificate","sp_name_id_type","sign_assertion"]}},"components/schemas/ApiCreateOidcClientInput":{"id":"components/schemas/ApiCreateOidcClientInput","kind":"json-schema","title":"ApiCreateOidcClientInput","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the client","example":"My Client"},"description":{"type":"string","description":"Short description of the client"},"resources":{"description":"List of resources IDs associated with this client","type":"array","items":{"type":"string"}},"authentication_protocol":{"type":"string","enum":["oidc","saml"],"description":"Authentication protocol used by the client","default":"oidc"},"client_group_id":{"type":"string","description":"Id of client group to associate with"},"default_custom_claims":{"type":"array","description":"List of client default custom claims","items":{"type":"string","enum":["tid","fname","lname","mname","email","email_verified","phone_number","phone_number_verified","groups","new_user","birthday","language","city","address","country","street_address","address_type","webauthn","roles","ts_roles","role_values","ts_permissions","permissions","approval_data","custom_group_data","username","secondary_phone_numbers","secondary_emails","picture","created_at","last_auth","auth_time","external_account_id","external_user_id","app_name","custom_data","custom_app_data","ai_actor"]}},"default_user_info_claims":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of client default custom claims returned by the UserInfo endpoint. Mutually exclusive with sync_id_token_claims_to_userinfo=true in the same request."},"children":[]}]}]}],"items":{"type":"string","enum":["tid","fname","lname","mname","email","email_verified","phone_number","phone_number_verified","groups","new_user","birthday","language","city","address","country","street_address","address_type","webauthn","roles","ts_roles","role_values","ts_permissions","permissions","approval_data","custom_group_data","username","secondary_phone_numbers","secondary_emails","picture","created_at","last_auth","auth_time","external_account_id","external_user_id","app_name","custom_data","custom_app_data","ai_actor"]}},"sync_id_token_claims_to_userinfo":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, UserInfo custom claims are kept in sync with default_custom_claims (the ID Token list). Mutually exclusive with explicit default_user_info_claims in the same request."},"children":[]}]}]}],"default":false},"short_cookies_samesite_type":{"type":"string","enum":["lax","none"],"description":"Short cookies samesite type. Possible values: \"none\", \"lax\", \"strict\". Default: \"lax\"","default":"lax"},"redirect_uris":{"description":"List of URIs approved for redirects for your client","example":["https://www.example.com/login"],"type":"array","items":{"type":"string"}},"client_type":{"type":"string","enum":["web","native"],"description":"Client type","default":"web"},"device_authorization":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc8628"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth Device Authorization Flow"},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/ApiDeviceAuthConfiguration"}]},"ciba_authorization":{"description":"CIBA authorization flow configuration","allOf":[{"$ref":"#/components/schemas/ApiCibaAuthConfiguration"}]},"is_third_party":{"type":"boolean","description":"Is third party client"},"allowed_scopes":{"description":"Allowed scopes","type":"array","items":{"type":"string"}},"consent_uri":{"type":"string","description":"Consent URI"},"consent_validity_period":{"type":"number","description":"Consent validity period"},"pkce":{"type":"string","enum":["enforcePkceInsteadOfClientCredentials","enforcePkceAlongsideClientCredentials","allowPkceAlongsideClientCredentials"],"description":"PKCE configuration"},"supported_prompts":{"type":"array","example":["login","consent","none"],"description":"Supported prompts for the OIDC authentication flow","items":{"type":"string","enum":["login","consent","none"]}},"token_expiration":{"description":"Token expiration settings","allOf":[{"$ref":"#/components/schemas/ApiTokenExpirationConfiguration"}]},"session_expiration":{"type":"number","description":"Session expiration time (seconds)"},"enforce_par":{"type":"boolean","description":"enforce PAR (Pushed Authorization Request) for this client"},"role_ids":{"description":"Role IDs","type":"array","items":{"type":"string"}},"fapi_version_compliancy":{"type":"boolean","description":"FAPI 2.0 compliancy configuration"},"token_endpoint_auth_method":{"type":"string","enum":["client_secret_basic","self_signed_tls_client_auth","tls_client_auth","none","private_key_jwt"],"description":"This field is deprecated- to configure pkce use \"pkce\" field instead","default":"client_secret_basic","deprecated":true},"response_types":{"type":"array","default":["code","id_token"],"example":["code"],"items":{"type":"string","enum":["code","id_token"]}},"authentication_configuration":{"description":"Client authentication configuration","allOf":[{"$ref":"#/components/schemas/ApiClientAuthenticationConfiguration"}]},"id_token_encryption":{"description":"ID Token encryption configuration","allOf":[{"$ref":"#/components/schemas/ApiIdTokenEncryptionConfiguration"}]}},"required":["name"]}},"components/schemas/ApiCreateSamlClientInput":{"id":"components/schemas/ApiCreateSamlClientInput","kind":"json-schema","title":"ApiCreateSamlClientInput","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the client","example":"My Client"},"description":{"type":"string","description":"Short description of the client"},"resources":{"description":"List of resources IDs associated with this client","type":"array","items":{"type":"string"}},"authentication_protocol":{"type":"string","enum":["oidc","saml"],"description":"Authentication protocol used by the client","default":"oidc"},"client_group_id":{"type":"string","description":"Id of client group to associate with"},"default_custom_claims":{"type":"array","description":"List of client default custom claims","items":{"type":"string","enum":["tid","fname","lname","mname","email","email_verified","phone_number","phone_number_verified","groups","new_user","birthday","language","city","address","country","street_address","address_type","webauthn","roles","ts_roles","role_values","ts_permissions","permissions","approval_data","custom_group_data","username","secondary_phone_numbers","secondary_emails","picture","created_at","last_auth","auth_time","external_account_id","external_user_id","app_name","custom_data","custom_app_data","ai_actor"]}},"default_user_info_claims":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of client default custom claims returned by the UserInfo endpoint. Mutually exclusive with sync_id_token_claims_to_userinfo=true in the same request."},"children":[]}]}]}],"items":{"type":"string","enum":["tid","fname","lname","mname","email","email_verified","phone_number","phone_number_verified","groups","new_user","birthday","language","city","address","country","street_address","address_type","webauthn","roles","ts_roles","role_values","ts_permissions","permissions","approval_data","custom_group_data","username","secondary_phone_numbers","secondary_emails","picture","created_at","last_auth","auth_time","external_account_id","external_user_id","app_name","custom_data","custom_app_data","ai_actor"]}},"sync_id_token_claims_to_userinfo":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, UserInfo custom claims are kept in sync with default_custom_claims (the ID Token list). Mutually exclusive with explicit default_user_info_claims in the same request."},"children":[]}]}]}],"default":false},"short_cookies_samesite_type":{"type":"string","enum":["lax","none"],"description":"Short cookies samesite type. Possible values: \"none\", \"lax\", \"strict\". Default: \"lax\"","default":"lax"},"sp_acs_url":{"type":"string","description":"SAML ACS URL"},"sp_entity_id":{"type":"string","description":"SAML Service provider entity ID"},"sp_name_id_type":{"type":"string","enum":["email","secondaryEmail","username","phoneNumber","externalUserId"],"description":"SAML Name ID Type"},"supported_prompts":{"type":"array","example":["login","consent","none"],"description":"Supported prompts for the OIDC authentication flow","items":{"type":"string","enum":["login","consent","none"]}},"sign_assertion":{"type":"boolean","description":"Sign SAML assertion"},"optional_acs_url":{"type":"boolean","description":"Allow ACS URL to be optional"},"use_centralized_login":{"type":"boolean","description":"When enabled, SAML SP-initiated SSO redirects to the tenant centralized hub application instead of hosted login"}},"required":["name","sp_entity_id"]}},"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/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/ApiUpdateOidcClientInput":{"id":"components/schemas/ApiUpdateOidcClientInput","kind":"json-schema","title":"ApiUpdateOidcClientInput","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the client","example":"My Client"},"description":{"type":"string","description":"Short description of the client"},"resources":{"description":"List of resources IDs associated with this client","type":"array","items":{"type":"string"}},"client_group_id":{"type":"string","description":"Id of client group to associate with"},"default_custom_claims":{"type":"array","description":"List of client default custom claims","items":{"type":"string","enum":["tid","fname","lname","mname","email","email_verified","phone_number","phone_number_verified","groups","new_user","birthday","language","city","address","country","street_address","address_type","webauthn","roles","ts_roles","role_values","ts_permissions","permissions","approval_data","custom_group_data","username","secondary_phone_numbers","secondary_emails","picture","created_at","last_auth","auth_time","external_account_id","external_user_id","app_name","custom_data","custom_app_data","ai_actor"]}},"default_user_info_claims":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of client default custom claims returned by the UserInfo endpoint. Mutually exclusive with sync_id_token_claims_to_userinfo=true in the same request."},"children":[]}]}]}],"items":{"type":"string","enum":["tid","fname","lname","mname","email","email_verified","phone_number","phone_number_verified","groups","new_user","birthday","language","city","address","country","street_address","address_type","webauthn","roles","ts_roles","role_values","ts_permissions","permissions","approval_data","custom_group_data","username","secondary_phone_numbers","secondary_emails","picture","created_at","last_auth","auth_time","external_account_id","external_user_id","app_name","custom_data","custom_app_data","ai_actor"]}},"sync_id_token_claims_to_userinfo":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, UserInfo custom claims are kept in sync with default_custom_claims (the ID Token list). Mutually exclusive with explicit default_user_info_claims in the same request."},"children":[]}]}]}],"default":false},"short_cookies_samesite_type":{"type":"string","enum":["lax","none"],"description":"Short cookies samesite type. Possible values: \"none\", \"lax\", \"strict\". Default: \"lax\"","default":"lax"},"redirect_uris":{"description":"List of URIs approved for redirects for your client","example":["https://www.example.com/login"],"type":"array","items":{"type":"string"}},"client_type":{"type":"string","enum":["web","native"],"description":"Client type","default":"web"},"device_authorization":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc8628"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth Device Authorization Flow"},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/ApiDeviceAuthConfiguration"}]},"ciba_authorization":{"description":"CIBA authorization flow configuration","allOf":[{"$ref":"#/components/schemas/ApiCibaAuthConfiguration"}]},"is_third_party":{"type":"boolean","description":"Is third party client"},"allowed_scopes":{"description":"Allowed scopes","type":"array","items":{"type":"string"}},"consent_uri":{"type":"string","description":"Consent URI"},"consent_validity_period":{"type":"number","description":"Consent validity period"},"pkce":{"type":"string","enum":["enforcePkceInsteadOfClientCredentials","enforcePkceAlongsideClientCredentials","allowPkceAlongsideClientCredentials"],"description":"PKCE configuration"},"supported_prompts":{"type":"array","example":["login","consent","none"],"description":"Supported prompts for the OIDC authentication flow","items":{"type":"string","enum":["login","consent","none"]}},"token_expiration":{"description":"Token expiration settings","allOf":[{"$ref":"#/components/schemas/ApiTokenExpirationConfiguration"}]},"session_expiration":{"type":"number","description":"Session expiration time (seconds)"},"enforce_par":{"type":"boolean","description":"enforce PAR (Pushed Authorization Request) for this client"},"role_ids":{"description":"Role IDs","type":"array","items":{"type":"string"}},"fapi_version_compliancy":{"type":"boolean","description":"FAPI 2.0 compliancy configuration"},"token_endpoint_auth_method":{"type":"string","enum":["client_secret_basic","self_signed_tls_client_auth","tls_client_auth","none","private_key_jwt"],"description":"This field is deprecated- to configure pkce use \"pkce\" field instead","default":"client_secret_basic","deprecated":true},"response_types":{"type":"array","default":["code","id_token"],"example":["code"],"items":{"type":"string","enum":["code","id_token"]}},"authentication_configuration":{"description":"Client authentication configuration","allOf":[{"$ref":"#/components/schemas/ApiClientAuthenticationConfiguration"}]},"id_token_encryption":{"description":"ID Token encryption configuration","allOf":[{"$ref":"#/components/schemas/ApiIdTokenEncryptionConfiguration"}]}}}},"components/schemas/ApiUpdateSamlClientInput":{"id":"components/schemas/ApiUpdateSamlClientInput","kind":"json-schema","title":"ApiUpdateSamlClientInput","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the client","example":"My Client"},"description":{"type":"string","description":"Short description of the client"},"resources":{"description":"List of resources IDs associated with this client","type":"array","items":{"type":"string"}},"client_group_id":{"type":"string","description":"Id of client group to associate with"},"default_custom_claims":{"type":"array","description":"List of client default custom claims","items":{"type":"string","enum":["tid","fname","lname","mname","email","email_verified","phone_number","phone_number_verified","groups","new_user","birthday","language","city","address","country","street_address","address_type","webauthn","roles","ts_roles","role_values","ts_permissions","permissions","approval_data","custom_group_data","username","secondary_phone_numbers","secondary_emails","picture","created_at","last_auth","auth_time","external_account_id","external_user_id","app_name","custom_data","custom_app_data","ai_actor"]}},"default_user_info_claims":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of client default custom claims returned by the UserInfo endpoint. Mutually exclusive with sync_id_token_claims_to_userinfo=true in the same request."},"children":[]}]}]}],"items":{"type":"string","enum":["tid","fname","lname","mname","email","email_verified","phone_number","phone_number_verified","groups","new_user","birthday","language","city","address","country","street_address","address_type","webauthn","roles","ts_roles","role_values","ts_permissions","permissions","approval_data","custom_group_data","username","secondary_phone_numbers","secondary_emails","picture","created_at","last_auth","auth_time","external_account_id","external_user_id","app_name","custom_data","custom_app_data","ai_actor"]}},"sync_id_token_claims_to_userinfo":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, UserInfo custom claims are kept in sync with default_custom_claims (the ID Token list). Mutually exclusive with explicit default_user_info_claims in the same request."},"children":[]}]}]}],"default":false},"short_cookies_samesite_type":{"type":"string","enum":["lax","none"],"description":"Short cookies samesite type. Possible values: \"none\", \"lax\", \"strict\". Default: \"lax\"","default":"lax"},"sp_acs_url":{"type":"string","description":"SAML ACS URL"},"sp_entity_id":{"type":"string","description":"SAML Service provider entity ID"},"sp_name_id_type":{"type":"string","enum":["email","secondaryEmail","username","phoneNumber","externalUserId"],"description":"SAML Name ID Type"},"supported_prompts":{"type":"array","example":["login","consent","none"],"description":"Supported prompts for the OIDC authentication flow","items":{"type":"string","enum":["login","consent","none"]}},"sign_assertion":{"type":"boolean","description":"Sign SAML assertion"},"optional_acs_url":{"type":"boolean","description":"Allow ACS URL to be optional"},"use_centralized_login":{"type":"boolean","description":"When enabled, SAML SP-initiated SSO redirects to the tenant centralized hub application instead of hosted login"}}}},"components/schemas/ApiUpdateResourceInAppInput":{"id":"components/schemas/ApiUpdateResourceInAppInput","kind":"json-schema","title":"ApiUpdateResourceInAppInput","data":{"type":"object","properties":{"resource_ids":{"type":"array","items":{"type":"string"},"description":"List of resources this application is allowed to explicitly request access to"}},"required":["resource_ids"]}},"components/schemas/ApiClientSecretResult":{"id":"components/schemas/ApiClientSecretResult","kind":"json-schema","title":"ApiClientSecretResult","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the client secret"},"client_secret":{"type":"string","description":"Client secret value"},"created_at":{"format":"date-time","type":"string","description":"Date the secret was created"}},"required":["id","client_secret","created_at"]}},"components/schemas/ApiDeviceAuthConfiguration":{"id":"components/schemas/ApiDeviceAuthConfiguration","kind":"json-schema","title":"ApiDeviceAuthConfiguration","data":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if the client is allowed to use the OAuth device authorization flow","default":false},"approval_uri":{"type":"string","description":"The URI of the page that allows the user to approve the access request","example":"https://www.example.com/device/approval"},"success_uri":{"type":"string","description":"Callback URI that receives an indication of whether the end-user authentication was completed successfully.","example":"https://www.example.com/device/complete"},"input_uri":{"type":"string","description":"The URI of the page that allows the user to enter the code","example":"https://www.example.com/device/start"}},"required":["enabled","approval_uri","success_uri","input_uri"]}},"components/schemas/ApiCibaAuthConfiguration":{"id":"components/schemas/ApiCibaAuthConfiguration","kind":"json-schema","title":"ApiCibaAuthConfiguration","data":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if the client is allowed to use the OAuth CIBA authorization flow","default":false},"login_uri":{"type":"string","description":"The URI of the page that allows the user to log-in and verify the access request","example":"https://www.example.com/ciba/login"}},"required":["enabled"]}},"components/schemas/ApiClientAuthenticationConfiguration":{"id":"components/schemas/ApiClientAuthenticationConfiguration","kind":"json-schema","title":"ApiClientAuthenticationConfiguration","data":{"type":"object","properties":{"method":{"type":"string","enum":["client_secret_basic","self_signed_tls_client_auth","tls_client_auth","private_key_jwt"],"description":"Client authentication method","default":"client_secret_basic"},"tls_client_auth":{"description":"TLS client authentication configuration for mTLS","allOf":[{"$ref":"#/components/schemas/TlsClientAuth"}]},"isMtlsCertTokenBound":{"type":"boolean","description":"States whether to bind the access token to the client certificate when mTLS is enabled"},"jwks":{"type":"object","description":"A set of JWK keys containing the public keys for the Client to use for authentication"}},"required":["method"]}},"components/schemas/ApiTokenExpirationConfiguration":{"id":"components/schemas/ApiTokenExpirationConfiguration","kind":"json-schema","title":"ApiTokenExpirationConfiguration","data":{"type":"object","properties":{"access_token_ttl":{"type":"number","description":"Access token time-to-live"},"refresh_token_ttl":{"type":"number","description":"Refresh token time-to-live"},"max_refresh_rotate":{"type":"number","description":"Maximum time the refresh token can be rotated"}}}},"components/schemas/ApiIdTokenEncryptionConfiguration":{"id":"components/schemas/ApiIdTokenEncryptionConfiguration","kind":"json-schema","title":"ApiIdTokenEncryptionConfiguration","data":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if ID token encryption is enabled for the client","default":false},"jwks":{"type":"object","description":"A set of JWK keys containing the public keys for the client to use for ID token encryption"}},"required":["enabled"]}},"components/schemas/TlsClientAuth":{"id":"components/schemas/TlsClientAuth","kind":"json-schema","title":"TlsClientAuth","data":{"type":"object","properties":{"certificate_chain":{"type":"string","description":"Certificate chain including intermediate CA certificates used for client certificate validation"},"distinguished_name":{"type":"number","description":"The length of the generated OTP code. Must be between 4 and 8.","example":6},"ocsp_on":{"type":"boolean","description":"Enables OCSP (Online Certificate Status Protocol) verification"},"ocsp_responder_uri":{"type":"string","description":"OCSP responder URI"},"ocsp_responder_certificate":{"type":"string","description":"OCSP responder certificate used for signature verification"},"ocsp_fail_open":{"type":"boolean","description":"OCSP fail-open"}}}},"schema_368":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ApiCreateOidcClientInput"},{"$ref":"#/components/schemas/ApiCreateSamlClientInput"}]},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ApiOidcClient"},{"$ref":"#/components/schemas/ApiSamlClient"}]},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"items":{"anyOf":[{"$ref":"#/components/schemas/ApiOidcClient"},{"$ref":"#/components/schemas/ApiSamlClient"}]},"type":"array"},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"type":"string"},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ApiUpdateOidcClientInput"},{"$ref":"#/components/schemas/ApiUpdateSamlClientInput"}]},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ApiClientSecretResult"}},"id":"schema_373"}},"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/clients.openapi.json?download"},{"url":"/_bundle/openapi/user/clients.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Clients","description":"Allows an application to manage its clients, including updating existing clients and creating additional clients. To authorize API calls, use an access token for the relevant application. To manage apps and their clients as a tenant admin, see [Application APIs](/openapi/user/apps.openapi.json)."}},"baseSlug":"/openapi/user/clients.openapi","routesMapping":{}}