{"items":[{"type":"link","label":"Delegated Access","link":"/openapi/user/delegated-access.openapi","routeSlug":"/openapi/user/delegated-access.openapi","content":{"contentType":"overview","meta":{"name":"Delegated Access"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"delegated-access.openapi.json","url":"/_bundle/openapi/user/delegated-access.openapi.json?download"},{"kind":"download","label":"delegated-access.openapi.yaml","url":"/_bundle/openapi/user/delegated-access.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":"Delegated Access","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":"Manage delegated access, which allows a user to perform actions on behalf of another user. These APIs allow logged-in users to request consent from other app users, grant consent requests, view all consents related to their account, and revoke any granted permissions."},"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":"text","inline":true,"attributes":{"content":"To request delegated access, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/user/oidc.openapi/other/oidctoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth2.0 Token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a dependent user with delegated access, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/user/user.openapi/other/createuser#other/createuser/t=request&path=delegated_access"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create users"},"children":[]}]}]}]}]}],"sectionId":"/openapi/user/delegated-access.openapi"}],"sectionId":"/openapi/user/delegated-access.openapi"}]}]}},{"label":"Grant consent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/delegated-access.openapi/other/grantconsent","routeSlug":"/openapi/user/delegated-access.openapi/other/grantconsent","metadata":{"seo":{"title":"Grant consent","description":"Grant the requested consent once it's approved by the user. This will provide the requesting user (the actor) permissions to act on behalf of the user that approved the consent (the subject). Since the approving user must be logged-in, this is authorized using a user access token of the subject."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"grantConsent","name":"Grant consent","isWebhook":false,"pointer":"/paths/~1v1~1delegated-access~1consents~1me~1grant/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Grant consent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Grant the requested consent once it's approved by the user. This will provide the requesting user (the actor) permissions to act on behalf of the user that approved the consent (the subject). Since the approving user must be logged-in, this is authorized using a user access token of the subject."},{"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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiConsentId"}},"schemaId":"components/schemas/ApiConsentId","pointer":"/paths/~1v1~1delegated-access~1consents~1me~1grant/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/delegated-access/consents/me/grant","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":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiConsentId"}},"responseCodes":["204","400"],"pointer":"/v1/delegated-access/consents/me/grant","href":"other/grantconsent","openApiOperationId":"grantConsent","summary":"Grant consent"},"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/ApiConsentId","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiConsentId"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Consent has been created for the user"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}},"schemaId":"components/schemas/BadRequestHttpError"}],"pointer":"/paths/~1v1~1delegated-access~1consents~1me~1grant/post/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"}}}],"examples":[]}]}]}]},"httpPath":"/v1/delegated-access/consents/me/grant"},{"label":"Request consent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/delegated-access.openapi/other/requestconsent","routeSlug":"/openapi/user/delegated-access.openapi/other/requestconsent","metadata":{"seo":{"title":"Request consent","description":"Send a consent request to give the requesting user (the actor) permissions to act on behalf of another user (the subject) when needed. An email will be sent to the subject with a link to your consent page. The consent URI will include a query param named consent_id used to grant the consent, permissions array, and the subject's user ID as subject_id. Since this call must be initiated by a logged-in user, it's authorized using a user access token of the actor."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"requestConsent","name":"Request consent","isWebhook":false,"pointer":"/paths/~1v1~1delegated-access~1consents~1me~1request/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request consent","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":"Send a consent request to give the requesting user (the actor) permissions to act on behalf of another user (the subject) when needed. An email will be sent to the subject with a link to your consent page. The consent URI will include a query param named consent_id used to grant the consent, permissions array, and the subject's user ID as subject_id. Since this call must be initiated by a logged-in user, it's authorized using a user access token of the actor."},"children":[]}]}]}]},{"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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestConsentInputDto"}},"schemaId":"components/schemas/RequestConsentInputDto","pointer":"/paths/~1v1~1delegated-access~1consents~1me~1request/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/delegated-access/consents/me/request","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":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestConsentInputDto"}},"responseCodes":["200","400","404"],"pointer":"/v1/delegated-access/consents/me/request","href":"other/requestconsent","openApiOperationId":"requestConsent","summary":"Request consent"},"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/RequestConsentInputDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestConsentInputDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Consent request has been sent"},{"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~1delegated-access~1consents~1me~1request/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"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/delegated-access/consents/me/request"},{"label":"Get consents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/delegated-access.openapi/other/getuserconsents","routeSlug":"/openapi/user/delegated-access.openapi/other/getuserconsents","metadata":{"seo":{"title":"Get consents","description":"Get all the consents that were granted or requested by the specified user. This call is authorized by a user access token of this user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserConsents","name":"Get consents","isWebhook":false,"pointer":"/paths/~1v1~1delegated-access~1consents~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get consents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all the consents that were granted or requested by the specified user. This call is authorized by a user access token of this 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/delegated-access/consents/me","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":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v1/delegated-access/consents/me","href":"other/getuserconsents","openApiOperationId":"getUserConsents","summary":"Get consents"},"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","description":"The requested user permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserConsents"}},"schemaId":"components/schemas/UserConsents"},{"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~1delegated-access~1consents~1me/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserConsents","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserConsents"}}},{"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/delegated-access/consents/me"},{"label":"Revoke permissions as actor","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/delegated-access.openapi/other/removesubjectpermissionsofloggedinactor","routeSlug":"/openapi/user/delegated-access.openapi/other/removesubjectpermissionsofloggedinactor","metadata":{"seo":{"title":"Revoke permissions as actor","description":"Revokes my permissions (the actor) to act on behalf of another user (the subject). This call is initiated by the actor who is logged-in, so it's authorized using a user access token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeSubjectPermissionsOfLoggedInActor","name":"Revoke permissions as actor","isWebhook":false,"pointer":"/paths/~1v1~1delegated-access~1consents~1me~1permissions~1actor/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke permissions as actor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revokes my permissions (the actor) to act on behalf of another user (the subject). This call is initiated by the actor who is logged-in, so it's authorized using a user access token."},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserAccessToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"permissions","in":"query","schemaId":"schema_379","description":"Names of permissions to revoke. If no permissions are specified, all permissions will be revoked."},{"name":"subject_id","in":"query","schemaId":"schema_380","description":"ID of the user that granted the permissions.","required":true}],"pointer":"/paths/~1v1~1delegated-access~1consents~1me~1permissions~1actor/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/delegated-access/consents/me/permissions/actor","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[{"name":"permissions","in":"query","required":false,"schemaId":"schema_379"},{"name":"subject_id","in":"query","required":true,"schemaId":"schema_380"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v1/delegated-access/consents/me/permissions/actor","href":"other/removesubjectpermissionsofloggedinactor","openApiOperationId":"removeSubjectPermissionsOfLoggedInActor","summary":"Revoke permissions as actor"},"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","description":"Permissions revoked"},{"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~1delegated-access~1consents~1me~1permissions~1actor/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"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/delegated-access/consents/me/permissions/actor"},{"label":"Revoke permissions as subject","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/delegated-access.openapi/other/removeactorpermissionsofloggedinsubject","routeSlug":"/openapi/user/delegated-access.openapi/other/removeactorpermissionsofloggedinsubject","metadata":{"seo":{"title":"Revoke permissions as subject","description":"Revokes permissions of another user (the actor) to act on my behalf (the subject). This call is initiated by the subject who is logged-in, so it's authorized using a user access token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeActorPermissionsOfLoggedInSubject","name":"Revoke permissions as subject","isWebhook":false,"pointer":"/paths/~1v1~1delegated-access~1consents~1me~1permissions~1subject/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke permissions as subject","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revokes permissions of another user (the actor) to act on my behalf (the subject). This call is initiated by the subject who is logged-in, so it's authorized using a user access token."},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserAccessToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"permissions","in":"query","schemaId":"schema_379","description":"Names of permissions to revoke. If no permissions are specified, all permissions will be revoked."},{"name":"actor_id","in":"query","schemaId":"schema_380","description":"ID of the user that received the permissions.","required":true}],"pointer":"/paths/~1v1~1delegated-access~1consents~1me~1permissions~1subject/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/delegated-access/consents/me/permissions/subject","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[{"name":"permissions","in":"query","required":false,"schemaId":"schema_379"},{"name":"actor_id","in":"query","required":true,"schemaId":"schema_380"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v1/delegated-access/consents/me/permissions/subject","href":"other/removeactorpermissionsofloggedinsubject","openApiOperationId":"removeActorPermissionsOfLoggedInSubject","summary":"Revoke permissions as subject"},"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","description":"Permissions revoked"},{"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~1delegated-access~1consents~1me~1permissions~1subject/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"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/delegated-access/consents/me/permissions/subject"}],"store":{"schemaStore":{"components/schemas/ApiConsentId":{"id":"components/schemas/ApiConsentId","kind":"json-schema","title":"ApiConsentId","data":{"type":"object","properties":{"consent_id":{"type":"string","description":"Consent ID returned to your consent URI upon redirection"}},"required":["consent_id"]}},"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/RequestConsentInputDto":{"id":"components/schemas/RequestConsentInputDto","kind":"json-schema","title":"RequestConsentInputDto","data":{"type":"object","properties":{"permissions":{"description":"Names of permissions","type":"array","items":{"type":"string"}},"consent_uri":{"type":"string","example":"https://www.example.com/consent","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URI of your consent page, which the browser will redirect to when the user clicks the link in the consent email. The URI must accept the following query parameters: consent_id used to grant the consent, permissions array of permissions to present the user to approve, subject_id and actor_id. This URI must also be configured as an allowed redirect URI in the Admin Portal."},"children":[]}]}]}]},"subject_id":{"type":"string","description":"ID of the user that grants permissions to another user to act on their behalf"},"consent_expiration":{"type":"number","description":"Validity period of the consent in seconds. Once expired, new consent must be granted to obtain the permissions"}},"required":["permissions","consent_uri","subject_id"]}},"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/UserConsents":{"id":"components/schemas/UserConsents","kind":"json-schema","title":"UserConsents","data":{"type":"object","properties":{"consents_as_actor":{"description":"Consents requested by this user (as the actor)","type":"array","items":{"$ref":"#/components/schemas/ApiSubjectIdAndConsentData"}},"consents_as_subject":{"description":"Consents that this user was requested to grant (as the subject)","type":"array","items":{"$ref":"#/components/schemas/ApiActorIdAndConsentData"}}}}},"components/schemas/ApiSubjectIdAndConsentData":{"id":"components/schemas/ApiSubjectIdAndConsentData","kind":"json-schema","title":"ApiSubjectIdAndConsentData","data":{"type":"object","properties":{"subject_id":{"type":"string","description":"ID of the user that received the consent request"},"consents":{"description":"Consent data","type":"array","items":{"$ref":"#/components/schemas/ApiConsentData"}}},"required":["subject_id","consents"]}},"components/schemas/ApiActorIdAndConsentData":{"id":"components/schemas/ApiActorIdAndConsentData","kind":"json-schema","title":"ApiActorIdAndConsentData","data":{"type":"object","properties":{"actor_id":{"type":"string","description":"ID of the user that requested the consent"},"consents":{"description":"Consent data","type":"array","items":{"$ref":"#/components/schemas/ApiConsentData"}}},"required":["actor_id","consents"]}},"components/schemas/ApiConsentData":{"id":"components/schemas/ApiConsentData","kind":"json-schema","title":"ApiConsentData","data":{"type":"object","properties":{"consent_id":{"type":"string","description":"Consent ID returned to your consent URI upon redirection"},"permission":{"type":"string","description":"Names of permissions"},"consent_status":{"type":"string","enum":["PENDING","GRANTED","REVOKED","EXPIRED"],"description":"Status of the consent"},"expired_on":{"type":"number","description":"Expiration date of the consent, specified as unix epoch in seconds. Once expired, new consent must be granted to obtain the permissions"}},"required":["consent_id","permission","consent_status"]}},"schema_379":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_379"},"schema_380":{"kind":"json-schema","data":{"type":"string"},"id":"schema_380"}},"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/delegated-access.openapi.json?download"},{"url":"/_bundle/openapi/user/delegated-access.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Delegated Access","description":"Manage delegated access, which allows a user to perform actions on behalf of another user. These APIs allow logged-in users to request consent from other app users, grant consent requests, view all consents related to their account, and revoke any granted permissions.<br><br>To request delegated access, see [OAuth2.0 Token](/openapi/user/oidc.openapi/other/oidctoken).<br>To create a dependent user with delegated access, see [Create users](/openapi/user/user.openapi/other/createuser#other/createuser/t=request&path=delegated_access)"}},"baseSlug":"/openapi/user/delegated-access.openapi","routesMapping":{}}