mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-21 17:17:44 +02:00
1 line
10 KiB
JavaScript
1 line
10 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>g});var i=a(85893),l=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),o=(a(82723),a(9487)),c=(a(41429),a(5397)),d=a(4667),m=a(9472),p=a(85162);const u={id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/itXftkKKLbz2k0YhmZbF6QtlgJJEGCJUVDSWWJMkRx5kmMY/rZfsp+2XzIcZTm20xYLNvSLLZL33BvvnuNCkCyDSG/FdUAvxokoMOReOVLWiFRcVQhnSMCncPrhHNDITGOAuW2ALJRI/OnBzgzIPLeNISiQpNJhIBJhHXrJus4LkYoSKZpJhMfgrAkYRLoQB6MR/21bvmzyHEOYNBrWSkQicmsIDbG8dE6rPB4M7wODFiLkFdaSv2juUKTCZveYk0iE86yGVGey22an1pKBvDKlSMTE+lrS5g4+yNppFvr1TE0PDrPq+q1YJsLIGp+r4a1F+AmR4VhLpZ+Lv7eYIb5ebQxyW7MqV1nzbFeOjk9efXd4sH9wyCrubXalSD9bS4Etw3NbO2nmz0Vbhyao0kQVHiVhcUqfUvIIORgdHO7tj/ZGr672T9Kj79Pjk8FoNPpdJOKhjvns7kUUkmKeqQtrvW5c8RXsLHfFGi79DbFuvWTBo9HR0w6IPWcswcQ2pnjx/xU/em/9l2Pftb3c8FsZrQx+7Fv4Izvfh3H8NIxz00qtisgeV3aK5utGsmmeOvNPr0Z1QvFcbIW6ud8FGTBvvKK5SG8X4mFPOrXXnae34+U4ETVSZVdsxw5LqkQqhiVS03FfQN+iDxHfeC1SURG5kA6HQZoisw+Dvim0zAJ3+FA6NWz3xTLZRUjnniEdSJbKlHtfRI0fQ7zka+gyvRXoOt/SqXc4Fz0TbkklQvH1VyiLWOe8ntgIXmX3wqG5VKWJd9Pui93hc4M6tzXynKEKoRf/+8+/IqKweVOjoVg6L+Ci8eDsDD2PDGkKmGh8UJnGKCy1trP12Aooa40h6DkoQ1h6SQiFKhVJDZwVZUrIpZOZ0oqLjcVsN+k26jUM4KZCqtDz0TceQUKBLWquUdDWTlkPWZAN2TraWPkMM+unE3YpAQlZE5TBECAg9hA0lTQ5Qn8XCVgP0gAaQu+8CghS1Sw8sR5wMlG5YsXcWV7mBLU0skQ2lgD7zVlw3raqwADeZk0gCFY3MRC2WGM/zA1iEQbwi2qxC5w3u6mOBZQNq0ggtwXCqtE4DFNAhoHAsXmVY1QaSHoCjS36WHvxJieN1uAsM4CSGuxk625ZEXlpAs+NzqH+atbpc97y6yDaKOR8AHfmzlxysTQBuQC0MtOQ3pk9uF2X2Q1mQRGOv+37YTabPemDl9uYM0VVk4FHZx9xZdyMXbMJXy9eikQQ+jpcTC7RtyrHVRN+xuYwCg9XvCjzyIur1wH32OtdAHOUVjmagBssdnr24T20cDgYiWSj8/+Fw8P35z+/+e3yDetlbur6b38wGozi68IGqqXZMHXWl8rOm2+3hxePTP+f35IrziF8oKHTUkWmjmEuVix7K3qWHSeisoF4a7HIZMBrr5dL3v6jQc/cPU5EK71iDyJzJz1TMS1Pcc75zHN0zOGt1E1Hdzujaovvz95ciUTIhj3ZZMhpZMjVB2vvj8x8Q/c2dXYO8C+z+CcBP3AK3+H8x7V4d/JZwCq+XprzN14ul/8AL/4hhw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,x={id:"API-docs/get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",source:"@site/docs/API-docs/get-user.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-user",permalink:"/docs/API-docs/get-user",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/itXftkKKLbz2k0YhmZbF6QtlgJJEGCJUVDSWWJMkRx5kmMY/rZfsp+2XzIcZTm20xYLNvSLLZL33BvvnuNCkCyDSG/FdUAvxokoMOReOVLWiFRcVQhnSMCncPrhHNDITGOAuW2ALJRI/OnBzgzIPLeNISiQpNJhIBJhHXrJus4LkYoSKZpJhMfgrAkYRLoQB6MR/21bvmzyHEOYNBrWSkQicmsIDbG8dE6rPB4M7wODFiLkFdaSv2juUKTCZveYk0iE86yGVGey22an1pKBvDKlSMTE+lrS5g4+yNppFvr1TE0PDrPq+q1YJsLIGp+r4a1F+AmR4VhLpZ+Lv7eYIb5ebQxyW7MqV1nzbFeOjk9efXd4sH9wyCrubXalSD9bS4Etw3NbO2nmz0Vbhyao0kQVHiVhcUqfUvIIORgdHO7tj/ZGr672T9Kj79Pjk8FoNPpdJOKhjvns7kUUkmKeqQtrvW5c8RXsLHfFGi79DbFuvWTBo9HR0w6IPWcswcQ2pnjx/xU/em/9l2Pftb3c8FsZrQx+7Fv4Izvfh3H8NIxz00qtisgeV3aK5utGsmmeOvNPr0Z1QvFcbIW6ud8FGTBvvKK5SG8X4mFPOrXXnae34+U4ETVSZVdsxw5LqkQqhiVS03FfQN+iDxHfeC1SURG5kA6HQZoisw+Dvim0zAJ3+FA6NWz3xTLZRUjnniEdSJbKlHtfRI0fQ7zka+gyvRXoOt/SqXc4Fz0TbkklQvH1VyiLWOe8ntgIXmX3wqG5VKWJd9Pui93hc4M6tzXynKEKoRf/+8+/IqKweVOjoVg6L+Ci8eDsDD2PDGkKmGh8UJnGKCy1trP12Aooa40h6DkoQ1h6SQiFKhVJDZwVZUrIpZOZ0oqLjcVsN+k26jUM4KZCqtDz0TceQUKBLWquUdDWTlkPWZAN2TraWPkMM+unE3YpAQlZE5TBECAg9hA0lTQ5Qn8XCVgP0gAaQu+8CghS1Sw8sR5wMlG5YsXcWV7mBLU0skQ2lgD7zVlw3raqwADeZk0gCFY3MRC2WGM/zA1iEQbwi2qxC5w3u6mOBZQNq0ggtwXCqtE4DFNAhoHAsXmVY1QaSHoCjS36WHvxJieN1uAsM4CSGuxk625ZEXlpAs+NzqH+atbpc97y6yDaKOR8AHfmzlxysTQBuQC0MtOQ3pk9uF2X2Q1mQRGOv+37YTabPemDl9uYM0VVk4FHZx9xZdyMXbMJXy9eikQQ+jpcTC7RtyrHVRN+xuYwCg9XvCjzyIur1wH32OtdAHOUVjmagBssdnr24T20cDgYiWSj8/+Fw8P35z+/+e3yDetlbur6b38wGozi68IGqqXZMHXWl8rOm2+3hxePTP+f35IrziF8oKHTUkWmjmEuVix7K3qWHSeisoF4a7HIZMBrr5dL3v6jQc/cPU5EK71iDyJzJz1TMS1Pcc75zHN0zOGt1E1Hdzujaovvz95ciUTIhj3ZZMhpZMjVB2vvj8x8Q/c2dXYO8C+z+CcBP3AK3+H8x7V4d/JZwCq+XprzN14ul/8AL/4hhw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Introduction",permalink:"/docs/API-docs/opensign-api-v-1"},next:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"}},j={},g=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get your account details"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,i.jsx)(s.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"jobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "name": "Joe Bee",\n "email": "joebee@example.com",\n "phone": "4567832123",\n "jobTitle": "dev",\n "company": "opensign",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"User not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}}}]); |