{"items":[{"type":"link","label":"Consents","link":"/openapi/user/consents.openapi","routeSlug":"/openapi/user/consents.openapi","content":{"contentType":"overview","meta":{"name":"Consents"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"consents.openapi.json","url":"/_bundle/openapi/user/consents.openapi.json?download"},{"kind":"download","label":"consents.openapi.yaml","url":"/_bundle/openapi/user/consents.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.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Consents","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Manage consent requests and consents. These APIs allow third party clients to request consent from app users. They also allow users to grant consent requests, view all consents related to their account, and revoke any granted permissions."}],"sectionId":"/openapi/user/consents.openapi"}],"sectionId":"/openapi/user/consents.openapi"}]}]}},{"label":"Get all consents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/consents.openapi/other/getallconsents","routeSlug":"/openapi/user/consents.openapi/other/getallconsents","metadata":{"seo":{"title":"Get all consents","description":"Retrieve all consents. Required permissions: apps:read, [appId]:read, consents:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllConsents","name":"Get all consents","isWebhook":false,"pointer":"/paths/~1v1~1consents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all consents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all consents. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consents: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":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"client_id","in":"query","schemaId":"schema_368","description":"ID of the client whose consents are to be retrieved. If not provided, all consents will be retrieved."},{"name":"user_id","in":"query","schemaId":"schema_368","description":"ID of the user whose consents are to be retrieved. If not provided, all consents will be retrieved."}],"pointer":"/paths/~1v1~1consents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/consents","servers":[{"url":"https://api.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"parameters":{"path":[],"query":[{"name":"client_id","in":"query","required":false,"schemaId":"schema_368"},{"name":"user_id","in":"query","required":false,"schemaId":"schema_368"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/consents","href":"other/getallconsents","openApiOperationId":"getAllConsents","summary":"Get all consents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"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~1consents/get/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/consents"},{"label":"Get consent by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/consents.openapi/other/getconsent","routeSlug":"/openapi/user/consents.openapi/other/getconsent","metadata":{"seo":{"title":"Get consent by ID","description":"Retrieve a consent by ID. Required permissions: apps:read, [appId]:read, consents:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConsent","name":"Get consent by ID","isWebhook":false,"pointer":"/paths/~1v1~1consents~1{consentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get consent by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a consent by ID. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consents: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":"consentId","in":"path","schemaId":"schema_368","description":"ID of the consent to retrieve","required":true}],"pointer":"/paths/~1v1~1consents~1{consentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/consents/{consentId}","servers":[{"url":"https://api.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"parameters":{"path":[{"name":"consentId","in":"path","required":true,"schemaId":"schema_368"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/consents/{consentId}","href":"other/getconsent","openApiOperationId":"getConsent","summary":"Get consent by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"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":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"}],"pointer":"/paths/~1v1~1consents~1{consentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_370","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/consents/{consentId}"},{"label":"Delete consents by user ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/consents.openapi/other/deleteappconsents","routeSlug":"/openapi/user/consents.openapi/other/deleteappconsents","metadata":{"seo":{"title":"Delete consents by user ID","description":"Delete consents by user ID. If no consent ID is provided, all consents for the user are deleted. Required permissions: apps:delete, [appId]:delete, consents:delete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAppConsents","name":"Delete consents by user ID","isWebhook":false,"pointer":"/paths/~1v1~1consents~1clients~1{clientId}~1users~1{userId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete consents by user ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete consents by user ID. If no consent ID is provided, all consents for the user are deleted. "},"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":"consents: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_368","description":"ID of the client","required":true},{"name":"userId","in":"path","schemaId":"schema_368","description":"ID of the user","required":true}],"pointer":"/paths/~1v1~1consents~1clients~1{clientId}~1users~1{userId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"consent_id","in":"query","schemaId":"schema_368","description":"ID of the consent to delete"}],"pointer":"/paths/~1v1~1consents~1clients~1{clientId}~1users~1{userId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/consents/clients/{clientId}/users/{userId}","servers":[{"url":"https://api.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_368"},{"name":"userId","in":"path","required":true,"schemaId":"schema_368"}],"query":[{"name":"consent_id","in":"query","required":false,"schemaId":"schema_368"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/consents/clients/{clientId}/users/{userId}","href":"other/deleteappconsents","openApiOperationId":"deleteAppConsents","summary":"Delete consents by user ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"}],"pointer":"/paths/~1v1~1consents~1clients~1{clientId}~1users~1{userId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/consents/clients/{clientId}/users/{userId}"},{"label":"Get all consents for an app","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/consents.openapi/other/getallappconsents","routeSlug":"/openapi/user/consents.openapi/other/getallappconsents","metadata":{"seo":{"title":"Get all consents for an app","description":"Retrieve all consents for an app. Required permissions: apps:read, [appId]:read, consents:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllAppConsents","name":"Get all consents for an app","isWebhook":false,"pointer":"/paths/~1v1~1manage~1consents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all consents for an app","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all consents for an app. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consents: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":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"client_id","in":"query","schemaId":"schema_368","description":"ID of the client whose consents are to be retrieved. If not provided, all consents will be retrieved."},{"name":"user_id","in":"query","schemaId":"schema_368","description":"ID of the user whose consents are to be retrieved. If not provided, all consents will be retrieved."},{"name":"app_id","in":"query","schemaId":"schema_368","required":true}],"pointer":"/paths/~1v1~1manage~1consents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/manage/consents","servers":[{"url":"https://api.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"parameters":{"path":[],"query":[{"name":"client_id","in":"query","required":false,"schemaId":"schema_368"},{"name":"user_id","in":"query","required":false,"schemaId":"schema_368"},{"name":"app_id","in":"query","required":true,"schemaId":"schema_368"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/manage/consents","href":"other/getallappconsents","openApiOperationId":"getAllAppConsents","summary":"Get all consents for an app"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"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_371"}},"schemaId":"schema_371"}],"pointer":"/paths/~1v1~1manage~1consents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_371","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371"}}}],"examples":[]}]}]}]},"httpPath":"/v1/manage/consents"},{"label":"Delete consents by client ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/consents.openapi/other/deleteclientconsents","routeSlug":"/openapi/user/consents.openapi/other/deleteclientconsents","metadata":{"seo":{"title":"Delete consents by client ID","description":"Delete consents by client ID. If no consent ID is provided, all consents for the client are deleted. Required permissions: apps:delete, [appId]:delete, consents:delete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteClientConsents","name":"Delete consents by client ID","isWebhook":false,"pointer":"/paths/~1v1~1manage~1consents~1clients~1{clientId}~1users~1{userId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete consents by client ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete consents by client ID. If no consent ID is provided, all consents for the client are deleted. "},"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":"consents: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_368","description":"The client ID to search for","required":true},{"name":"userId","in":"path","schemaId":"schema_368","description":"ID of the user","required":true}],"pointer":"/paths/~1v1~1manage~1consents~1clients~1{clientId}~1users~1{userId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"consent_id","in":"query","schemaId":"schema_368","description":"ID of the consent to delete"},{"name":"app_id","in":"query","schemaId":"schema_368","required":true}],"pointer":"/paths/~1v1~1manage~1consents~1clients~1{clientId}~1users~1{userId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/manage/consents/clients/{clientId}/users/{userId}","servers":[{"url":"https://api.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_368"},{"name":"userId","in":"path","required":true,"schemaId":"schema_368"}],"query":[{"name":"consent_id","in":"query","required":false,"schemaId":"schema_368"},{"name":"app_id","in":"query","required":true,"schemaId":"schema_368"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/manage/consents/clients/{clientId}/users/{userId}","href":"other/deleteclientconsents","openApiOperationId":"deleteClientConsents","summary":"Delete consents by client ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"}],"pointer":"/paths/~1v1~1manage~1consents~1clients~1{clientId}~1users~1{userId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/manage/consents/clients/{clientId}/users/{userId}"},{"label":"Get all consents for current user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/consents.openapi/other/getalluserconsents","routeSlug":"/openapi/user/consents.openapi/other/getalluserconsents","metadata":{"seo":{"title":"Get all consents for current user","description":"Get all consents for current user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllUserConsents","name":"Get all consents for current user","isWebhook":false,"pointer":"/paths/~1v1~1consents~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all consents for current user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all consents for current user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserAccessToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/consents/me","servers":[{"url":"https://api.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/consents/me","href":"other/getalluserconsents","openApiOperationId":"getAllUserConsents","summary":"Get all consents for current user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"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_372"}},"schemaId":"schema_372"}],"pointer":"/paths/~1v1~1consents~1me/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}}],"examples":[]}]}]}]},"httpPath":"/v1/consents/me"},{"label":"Revoke a consent by ID for current user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/consents.openapi/other/deleteuserconsents","routeSlug":"/openapi/user/consents.openapi/other/deleteuserconsents","metadata":{"seo":{"title":"Revoke a consent by ID for current user","description":"Revoke a consent by ID for current user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUserConsents","name":"Revoke a consent by ID for current user","isWebhook":false,"pointer":"/paths/~1v1~1consents~1me~1clients~1{clientId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke a consent by ID for current user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revoke a consent by ID for current user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserAccessToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_368","description":"ID of the client","required":true}],"pointer":"/paths/~1v1~1consents~1me~1clients~1{clientId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"consent_id","in":"query","schemaId":"schema_368","description":"ID of the consent to delete"}],"pointer":"/paths/~1v1~1consents~1me~1clients~1{clientId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/consents/me/clients/{clientId}","servers":[{"url":"https://api.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_368"}],"query":[{"name":"consent_id","in":"query","required":false,"schemaId":"schema_368"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["404"],"pointer":"/v1/consents/me/clients/{clientId}","href":"other/deleteuserconsents","openApiOperationId":"deleteUserConsents","summary":"Revoke a consent by ID for current user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"}],"pointer":"/paths/~1v1~1consents~1me~1clients~1{clientId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/consents/me/clients/{clientId}"}],"store":{"schemaStore":{"components/schemas/ApiConsent":{"id":"components/schemas/ApiConsent","kind":"json-schema","title":"ApiConsent","data":{"type":"object","properties":{"consent_id":{"type":"string","description":"ID of the consent"},"tenant_id":{"type":"string","description":"ID of the tenant"},"app_id":{"type":"string","description":"ID of the app"},"client_id":{"type":"string","description":"ID of the client"},"user_id":{"type":"string","description":"ID of the user"},"scope":{"type":"string","description":"Configures the consent scope of the user"},"created_at":{"type":"number","description":"Date the consent was created in the tenant"},"expires_at":{"type":"number","description":"Date the consent will be expired"},"updated_at":{"type":"number","description":"Date the consent will be expired"}},"required":["consent_id","tenant_id","app_id","client_id","user_id","scope","created_at","expires_at","updated_at"]}},"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/ApiClientConsent":{"id":"components/schemas/ApiClientConsent","kind":"json-schema","title":"ApiClientConsent","data":{"type":"object","properties":{"consent_id":{"type":"string","description":"ID of the consent"},"tenant_id":{"type":"string","description":"ID of the tenant"},"app_id":{"type":"string","description":"ID of the app"},"client_id":{"type":"string","description":"ID of the client"},"user_id":{"type":"string","description":"ID of the user"},"scope":{"type":"string","description":"Configures the consent scope of the user"},"created_at":{"type":"number","description":"Date the consent was created in the tenant"},"expires_at":{"type":"number","description":"Date the consent will be expired"},"updated_at":{"type":"number","description":"Date the consent will be expired"},"client_name":{"type":"string","description":"Name of the client"}},"required":["consent_id","tenant_id","app_id","client_id","user_id","scope","created_at","expires_at","updated_at","client_name"]}},"schema_368":{"kind":"json-schema","data":{"type":"string"},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"title":"ApiOkResponse-getAllConsents","type":"object","required":["result"],"description":"Consent information","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ApiConsent"}}}},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"title":"ApiOkResponse-getConsent","type":"object","required":["result"],"description":"Consent information","properties":{"result":{"$ref":"#/components/schemas/ApiConsent"}}},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"title":"ApiOkResponse-getAllAppConsents","type":"object","required":["result"],"description":"Consent information","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ApiClientConsent"}}}},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"title":"ApiOkResponse-getAllUserConsents","type":"object","required":["result"],"description":"Consents information","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ApiConsent"}}}},"id":"schema_372"}},"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.transmitsecurity.io/cis"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"Production environment (EU)"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"Production environment (CA)"}]},"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/consents.openapi.json?download"},{"url":"/_bundle/openapi/user/consents.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Consents","description":"Manage consent requests and consents. These APIs allow third party clients to request consent from app users. They also allow users to grant consent requests, view all consents related to their account, and revoke any granted permissions."}},"baseSlug":"/openapi/user/consents.openapi","routesMapping":{}}