mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-28 04:24:57 +02:00
1 line
9.9 KiB
JavaScript
1 line
9.9 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),o=(s(82723),s(9487)),d=s(41429),c=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"get-user",title:"Get your details",description:"Get your details",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VmFv2kgQ/St786mRDBhI0jurOjVX5VDSqokOopNKULXYA2ywd7e7awJC/u/VrG1iIL07pFO/AJ6dNzNv9s3gLTg+txCN4cGigUkASqPhTih5k0AEc3T+IADNDc/QoSHvLUieIUSwbnEtWk4tUUIAQkIEC+SJRxj8lguDCUTO5BiAdZuUMFZkOkUIANc6VQlCNOOpJYd4gRmHaAtuo72nM0LOoSBX7kER1SetmMv2er1eQzGhPFYradESsheG9JWgjY3QxAMiGOZxjNbO8pTt6EEAsZIOpSN/rnUqYn/QebIE2h6Xo6ZPGDvqhaEwTpQpSzO167DwAGbKZNw1LS9M/hyIZa8/XTzcEsPPvqGnRbhVyP5AJPh1xkV6Kv5J4RTxfWVoxyqjUPcLJU8u5fzi8u2v/V6316cQt2o6Ei49OUqCK4J/UJnmcnMqupYGhYgNcofJlXstyAukF/b6rW7YCt+OupfR+W/RxWU7DMMvEMA68/2shJ5w5/vsSlq751wnPyFPceiW01A23MrnghzPw/PjCaAhZlI5NlO5TH75/8SPxijzz9wPcxeNuoVMhcSv9Qh/peJrGhfHNG7kiqciYVf3N2xES+fnMmmmd2X646sRpVO5E/eoNu0lSYtxboTb+JXa3KXReEKrbZ/9AB3bqNywBB0XqYUAMnQLVS1qv6TdAiLozNHl5dq2aFb1zs5NSvvZOW2jTsc6Phdy3uJat+vJSfnU0hrocC06q65fr3WNQ+pj2aq9SncN41p8xA0E//7fQNSFnCkPrtpzp1EOxVz65q66cEh+tBCWCeuPExXnGUrnL5rNlGEHaDblFhOmJHML9Idk77e7zGqMxazSSJs9ykc5VBmy3CL9PaRCLm30KFtsfDebiVjwlP2NUyscTt7UnXt+fj7q2JnHDIRb5FNmUKsX97k3+rY2UbuHMwjAocns3WyIZiVirG7pB6k63rlTKZ/HXvlY7v/a9P4QREpMRYzSYkOrV4P7T6zfDiFoiOM/lNz5dPPh+vPwmqKSvMor6rbDdkgmrazLuGwkekW6e9e7E5HDtevolAs/O76obSXrMdSyngSwUNaRabulq34waVGQ+VuOhqZpEsCKG8GnpK3xpAhq6dEcJMLSQbJ78TgoZbdQ4M1f1TvMGaNLeq3EJW6OtL7iaU6eUATbyuEqjlG7xtnRqqJZ243z4HoEAfCceDcHbOkHrPpBXOojuWnE3q+mLIA+qZxXAe9oPD7i5vede3nyQ8DuJa/0plZMiqL4DrFTd0k=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/get-user",title:"Get your details",description:"Get your 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 details",description:"Get your details",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VmFv2kgQ/St786mRDBhI0jurOjVX5VDSqokOopNKULXYA2ywd7e7awJC/u/VrG1iIL07pFO/AJ6dNzNv9s3gLTg+txCN4cGigUkASqPhTih5k0AEc3T+IADNDc/QoSHvLUieIUSwbnEtWk4tUUIAQkIEC+SJRxj8lguDCUTO5BiAdZuUMFZkOkUIANc6VQlCNOOpJYd4gRmHaAtuo72nM0LOoSBX7kER1SetmMv2er1eQzGhPFYradESsheG9JWgjY3QxAMiGOZxjNbO8pTt6EEAsZIOpSN/rnUqYn/QebIE2h6Xo6ZPGDvqhaEwTpQpSzO167DwAGbKZNw1LS9M/hyIZa8/XTzcEsPPvqGnRbhVyP5AJPh1xkV6Kv5J4RTxfWVoxyqjUPcLJU8u5fzi8u2v/V6316cQt2o6Ei49OUqCK4J/UJnmcnMqupYGhYgNcofJlXstyAukF/b6rW7YCt+OupfR+W/RxWU7DMMvEMA68/2shJ5w5/vsSlq751wnPyFPceiW01A23MrnghzPw/PjCaAhZlI5NlO5TH75/8SPxijzz9wPcxeNuoVMhcSv9Qh/peJrGhfHNG7kiqciYVf3N2xES+fnMmmmd2X646sRpVO5E/eoNu0lSYtxboTb+JXa3KXReEKrbZ/9AB3bqNywBB0XqYUAMnQLVS1qv6TdAiLozNHl5dq2aFb1zs5NSvvZOW2jTsc6Phdy3uJat+vJSfnU0hrocC06q65fr3WNQ+pj2aq9SncN41p8xA0E//7fQNSFnCkPrtpzp1EOxVz65q66cEh+tBCWCeuPExXnGUrnL5rNlGEHaDblFhOmJHML9Idk77e7zGqMxazSSJs9ykc5VBmy3CL9PaRCLm30KFtsfDebiVjwlP2NUyscTt7UnXt+fj7q2JnHDIRb5FNmUKsX97k3+rY2UbuHMwjAocns3WyIZiVirG7pB6k63rlTKZ/HXvlY7v/a9P4QREpMRYzSYkOrV4P7T6zfDiFoiOM/lNz5dPPh+vPwmqKSvMor6rbDdkgmrazLuGwkekW6e9e7E5HDtevolAs/O76obSXrMdSyngSwUNaRabulq34waVGQ+VuOhqZpEsCKG8GnpK3xpAhq6dEcJMLSQbJ78TgoZbdQ4M1f1TvMGaNLeq3EJW6OtL7iaU6eUATbyuEqjlG7xtnRqqJZ243z4HoEAfCceDcHbOkHrPpBXOojuWnE3q+mLIA+qZxXAe9oPD7i5vede3nyQ8DuJa/0plZMiqL4DrFTd0k=",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"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get your details"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/getuser"}),"\n",(0,l.jsx)(a.p,{children:"Get your details"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,l.jsx)(m.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,l.jsx)(m.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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.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,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); |