Files
OpenSign/assets/js/1f73ca32.b4037d80.js
T

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:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),i=a(11151),n=a(58219),r=(a(62316),a(51039)),t=a.n(r),c=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={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:"eJy9Vttu20YQ/ZXtPMUAravdFkRRxA1cwU4QG5WNPshCsCKH4lrk7mZ3KUsQ+O/FLC+mJKeJXvKiy9z2zNkzQ+7A8aWFcAaPFg3MA1AaDXdCyZsYQlii844ANDc8R4eGoncgeY4Qwuaca3Hu1AolBCAkhJAij32Gwa+FMBhD6EyBAVi3zSjHilxnCAHgRmcqRggTnlkKiFLMOYQ7cFvtI50RcgklhXKfFBI+acVS9jabzQbKOZ1jtZIWLWWOBgP6itFGRmjqA0KYFlGE1iZFxtr2IIBISYfSUTzXOhORd/SfLSXtjuGoxTNGjrgwVMaJ6sjI99BGySJf+P5bzKPBoPQwi8x9v1xlJvYPeQggUSbnrmt5JebviViNxov08ZYI++zv57QKtwrZX4iUfp1zkZ2a/6xwgfi+NvQilVOp+1TJk6FcXP762+/j0XA0phK3avEgXHZylRjXlP5B5ZrL7anZjdKgLAPY5J6OWvYFzUQZgKtQ1f87BiEzIfFLI80vJMuypIiLwcWxQGnGmFSOJaqQ8S8/UZsXg4sygByt5cs3+X3l4xDk//VLXTb9Xh73eyPXPBMxu7q/YQ+0PH5uy5c/2nIXp6twHotBVEHVEtzjpGuv2LAYFUa4rd+h3eUZzua0y/ZpmqBjW1UYFqPjIrNAsF2q6s3st7JLIYT+El1R7WmLZt0s6cJktJCd0zbs97nWvUbTGV9YGtA+16K/Hvo92mCbEtEVl3sIW6K4Fh9xC8H3HwLUspCJ8sk1LXca5VQspSd1PYTDph9SYZmw3h2rqMhROq8ElijDDrLZgluMmZLMpeidZB/3hsxqjERSi6jHnuSTnKocWWGRngOZkCsbPslzNrtLEhEJnrF/cWGFw/m7hrGXl5cjxs58zkS4tFgwg1q9hi+90dPazWr/nEEADk1u75IpmrWIsL6dbxzV98H9ejR45EcDq83cmN4fJpECMxGhtNjR6NXk/hMb9wYQdETxA5D7n24+XH+eXlNVklV1RcPeoDcgk1bW5Vx2DnpDsnvX24rI4cb1dcaFnxkPalfLeQaNnOcBpMo6Mu12dNWPJitLMn8t0NAUzQNYcyP4grQ1m5dBIz3SfywsOeL2DeMASrtx4N0/9cvKGaNLegviCrdHWl/zrKBIKINdHXAVRahdx3e0y2jW2jGeXD9AALygvrsDtvIDVv+gXhqX3HZq76OpANAnwXkz4Q8aj4+4/bMNrzzfTGjf5qpoomJeluV/w9N2qg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=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:"eJy9Vttu20YQ/ZXtPMUAravdFkRRxA1cwU4QG5WNPshCsCKH4lrk7mZ3KUsQ+O/FLC+mJKeJXvKiy9z2zNkzQ+7A8aWFcAaPFg3MA1AaDXdCyZsYQlii844ANDc8R4eGoncgeY4Qwuaca3Hu1AolBCAkhJAij32Gwa+FMBhD6EyBAVi3zSjHilxnCAHgRmcqRggTnlkKiFLMOYQ7cFvtI50RcgklhXKfFBI+acVS9jabzQbKOZ1jtZIWLWWOBgP6itFGRmjqA0KYFlGE1iZFxtr2IIBISYfSUTzXOhORd/SfLSXtjuGoxTNGjrgwVMaJ6sjI99BGySJf+P5bzKPBoPQwi8x9v1xlJvYPeQggUSbnrmt5JebviViNxov08ZYI++zv57QKtwrZX4iUfp1zkZ2a/6xwgfi+NvQilVOp+1TJk6FcXP762+/j0XA0phK3avEgXHZylRjXlP5B5ZrL7anZjdKgLAPY5J6OWvYFzUQZgKtQ1f87BiEzIfFLI80vJMuypIiLwcWxQGnGmFSOJaqQ8S8/UZsXg4sygByt5cs3+X3l4xDk//VLXTb9Xh73eyPXPBMxu7q/YQ+0PH5uy5c/2nIXp6twHotBVEHVEtzjpGuv2LAYFUa4rd+h3eUZzua0y/ZpmqBjW1UYFqPjIrNAsF2q6s3st7JLIYT+El1R7WmLZt0s6cJktJCd0zbs97nWvUbTGV9YGtA+16K/Hvo92mCbEtEVl3sIW6K4Fh9xC8H3HwLUspCJ8sk1LXca5VQspSd1PYTDph9SYZmw3h2rqMhROq8ElijDDrLZgluMmZLMpeidZB/3hsxqjERSi6jHnuSTnKocWWGRngOZkCsbPslzNrtLEhEJnrF/cWGFw/m7hrGXl5cjxs58zkS4tFgwg1q9hi+90dPazWr/nEEADk1u75IpmrWIsL6dbxzV98H9ejR45EcDq83cmN4fJpECMxGhtNjR6NXk/hMb9wYQdETxA5D7n24+XH+eXlNVklV1RcPeoDcgk1bW5Vx2DnpDsnvX24rI4cb1dcaFnxkPalfLeQaNnOcBpMo6Mu12dNWPJitLMn8t0NAUzQNYcyP4grQ1m5dBIz3SfywsOeL2DeMASrtx4N0/9cvKGaNLegviCrdHWl/zrKBIKINdHXAVRahdx3e0y2jW2jGeXD9AALygvrsDtvIDVv+gXhqX3HZq76OpANAnwXkz4Q8aj4+4/bMNrzzfTGjf5qpoomJeluV/w9N2qg==",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 v(e){const s={h2:"h2",p:"p",...(0,i.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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get your details"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/getuser"}),"\n",(0,l.jsx)(s.p,{children:"Get your details"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{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)(s.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)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.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)(a,{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)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"user"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "result": {\n "objectId": "FGik23bhUJ",\n "Name": "Joe Bee",\n "Email": "joebee@example.com",\n "Phone": "4567832123",\n "JobTitle": "dev",\n "Company": "opensign"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.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)(a,{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)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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)(m.Z,{responseExample:'{\n "code": 404,\n "message": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.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)(a,{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)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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)(m.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]);