1"use strict";(globalThis.webpackChunkvoiden_docs=globalThis.webpackChunkvoiden_docs||[]).push([[7891],{244:(e,t,n)=>{n.d(t,{A:()=>i});const i=n.p+"assets/images/authorization-authtype-842b4efc3554175e72fb282f174279d1.png"},2031:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"core-features-section/voiden-blocks/advanced-authorization/authorization-block","title":"Authorization Block","description":"Authorization Block provides flexible authentication configuration options for API requests in Voiden.","source":"@site/docs/core-features-section/voiden-blocks/advanced-authorization/auth.md","sourceDirName":"core-features-section/voiden-blocks/advanced-authorization","slug":"/core-features-section/voiden-blocks/advanced-authorization/authorization-block","permalink":"/docs/core-features-section/voiden-blocks/advanced-authorization/authorization-block","draft":false,"unlisted":false,"editUrl":"https://github.com/VoidenHQ/docs/tree/main/docs/core-features-section/voiden-blocks/advanced-authorization/auth.md","tags":[],"version":"current","lastUpdatedAt":1764771954000,"sidebarPosition":1,"frontMatter":{"id":"authorization-block","title":"Authorization Block","sidebar_label":"Authorization Block","sidebar_position":1}}');var r=n(4848),s=n(8453);const o={id:"authorization-block",title:"Authorization Block",sidebar_label:"Authorization Block",sidebar_position:1},a="Authorization Block",d={},c=[{value:"Try it Out",id:"try-it-out",level:3},{value:"Supported Authorization Types",id:"supported-authorization-types",level:3}];function l(e){const t={a:"a",blockquote:"blockquote",br:"br",code:"code",h1:"h1",h3:"h3",header:"header",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"authorization-block",children:"Authorization Block"})}),"\n",(0,r.jsxs)(t.p,{children:["Authorization Block provides flexible authentication configuration options for API requests in ",(0,r.jsx)(t.strong,{children:"Voiden"}),".\nIt allows users to easily select and configure various authentication mechanisms supported by ",(0,r.jsx)(t.strong,{children:"Voiden"}),"."]}),"\n",(0,r.jsxs)(t.p,{children:["While ",(0,r.jsx)(t.strong,{children:"Voiden"})," includes another flexible Request Configuration Block ",(0,r.jsx)(t.a,{href:"/docs/core-features-section/voiden-blocks/rest-blocks/headers-block",children:"Headers"}),"\u2014 designed to handle any kind of headers, query parameters, or metadata \u2014\nthe Authorization Block is primarily responsible for managing authentication and authorization details only."]}),"\n",(0,r.jsx)(t.p,{children:"This separation ensures a clean and modular approach:"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:["The ",(0,r.jsx)(t.a,{href:"/docs/core-features-section/voiden-blocks/rest-blocks/headers-block",children:"Header Block"})," manages custom request data like headers, params, or meta information."]}),"\n",(0,r.jsx)(t.li,{children:"The Authorization Block manages how a user or service authenticates before making a request."}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"Together, they allow full control over API requests while maintaining clarity and security."}),"\n",(0,r.jsx)(t.h3,{id:"try-it-out",children:"Try it Out"}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsxs)(t.li,{children:["In your Voiden file, type ",(0,r.jsx)(t.code,{children:"/auth"})," and press ",(0,r.jsx)(t.strong,{children:"Enter"})," to create a ",(0,r.jsx)(t.strong,{children:"Authorization Block"}),"."]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.img,{alt:"Authorization Block Slash Command",src:n(2167).A+"",width:"3164",height:"1912"})}),"\n",(0,r.jsxs)(t.ol,{start:"2",children:["\n",(0,r.jsxs)(t.li,{children:["Select Authorization type for your ",(0,r.jsx)(t.strong,{children:"Authorization"}),"."]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.img,{alt:"Authorization Block Response",src:n(244).A+"",width:"2940",height:"1688"})}),"\n",(0,r.jsxs)(t.ol,{start:"3",children:["\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsx)(t.p,{children:"Fill the required params for the Authorization Type."}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsxs)(t.p,{children:["Hit ",(0,r.jsx)(t.strong,{children:"Cmd + Enter"})," (Mac) or ",(0,r.jsx)(t.strong,{children:"Ctrl + Enter"})," (Windows/Linux) to run the request",(0,r.jsx)(t.br,{}),"\n",(0,r.jsx)(t.strong,{children:"or"})," click the ",(0,r.jsx)(t.strong,{children:"green Play button"})," in the toolbar."]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsxs)(t.p,{children:["Check the ",(0,r.jsx)(t.strong,{children:"Response Panel"})]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:["\ud83c\udfa9 ",(0,r.jsx)(t.strong,{children:"Pro Tip:"})," Want to temporarily disable a header without deleting it?",(0,r.jsx)(t.br,{}),"\n","Use ",(0,r.jsx)(t.strong,{children:"Cmd + /"})," (Mac) or ",(0,r.jsx)(t.strong,{children:"Ctrl + /"})," (Windows/Linux) to comment it out.",(0,r.jsx)(t.br,{}),"\n","It\u2019ll stay visible but won\u2019t be sent with the request \u2014 perfect for quick testing."]}),"\n"]}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"supported-authorization-types",children:"Supported Authorization Types"}),"\n",(0,r.jsx)(t.p,{children:"Below are all supported authorization options with descriptions:"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Value"}),(0,r.jsx)(t.th,{children:"Label"}),(0,r.jsx)(t.th,{children:"Description"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"inherit"}),(0,r.jsx)(t.td,{children:"inherit"}),(0,r.jsx)(t.td,{children:"Uses the authorization settings from a parent configuration or global context."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"none"}),(0,r.jsx)(t.td,{children:"No Authorization"}),(0,r.jsx)(t.td,{children:"Disables authorization for the current request."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"bearer"}),(0,r.jsx)(t.td,{children:"Bearer Token"}),(0,r.jsx)(t.td,{children:"Uses a Bearer token (commonly used in OAuth 2.0). Example: Authorization: Bearer"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"basic"}),(0,r.jsx)(t.td,{children:"Basic Authorization"}),(0,r.jsx)(t.td,{children:"Uses Base64-encoded username and password. Example: Authorization: Basic"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"apiKey"}),(0,r.jsx)(t.td,{children:"API Key"}),(0,r.jsx)(t.td,{children:"Uses a predefined API key sent in the header, query, or body, depending on configuration."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"oauth2"}),(0,r.jsx)(t.td,{children:"OAuth 2.0"}),(0,r.jsx)(t.td,{children:"Uses OAuth 2.0 protocol for secure delegated access via access tokens."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"oauth1"}),(0,r.jsx)(t.td,{children:"OAuth 1.0"}),(0,r.jsx)(t.td,{children:"Uses OAuth 1.0 protocol with request signing for older integrations."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"digest"}),(0,r.jsx)(t.td,{children:"Digest"}),(0,r.jsx)(t.td,{children:"Uses HTTP Digest Authentication \u2014 a challenge\u2013response mechanism for added security."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"ntlm"}),(0,r.jsx)(t.td,{children:"NTLM"}),(0,r.jsx)(t.td,{children:"Windows-based authentication commonly used in enterprise networks."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"awsSignature"}),(0,r.jsx)(t.td,{children:"AWS"}),(0,r.jsx)(t.td,{children:"Uses AWS Signature Version 4 for authenticating requests to AWS services."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"hawk"}),(0,r.jsx)(t.td,{children:"Hawk"}),(0,r.jsx)(t.td,{children:"A cryptographic authentication scheme using MAC (Message Authentication Code)."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"atlassianAsap"}),(0,r.jsx)(t.td,{children:"ASAP"}),(0,r.jsx)(t.td,{children:"Atlassian Service Authentication Protocol \u2014 used for secure service-to-service communication."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"netrc"}),(0,r.jsx)(t.td,{children:"Netrc"}),(0,r.jsx)(t.td,{children:"Uses credentials from a .netrc file for authentication."})]})]})]})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},2167:(e,t,n)=>{n.d(t,{A:()=>i});const i=n.p+"assets/images/authorization-block-992c2bdb5fc48f0a147b8edbf8450f41.png"},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>a});var i=n(6540);const r={},s=i.createContext(r);function o(e){const t=i.useContext(s);return i.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.