mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-22 01:24:54 +02:00
1 line
9.5 KiB
JavaScript
1 line
9.5 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:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>j});var t=s(85893),i=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),o=(s(82723),s(9487)),c=(s(41429),s(5397)),d=s(4667),m=s(9472),p=s(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/ivcfWoB2ZLtJF2FYWg2ZEbaoilgBwPmGAUtnS3GEsmRlBPD0H8fjpIc2W6LGRv6JRHv7rn3h/QOHF9ZiGdwb9HAPIAUbWKEdkJJiGGaIRujY6Rl159vGUq+yNGyrSqZU2yFjj4NU0+S8SRRpXQsRcdFbvsQgNJoOPm6TSGGFTofJgCDVitp0UK8g2EU0b/DyJMySdDaZZmzvRMIIFHSoXRkz7XOReIV4aMl0A5skmHB6cttNUIMavGIiYMAtCE3TtQhazEltbe0zgi5ggCWyhTcdSX4zAudk9EfY7EejhbZ/XuoApC8wHM9vFfIfkMkOBZc5OfiHxUuEN81gn6iCnKlMyXPTuXi8urNz6PhYDgiF49qMRUuP9tLihuCJ6rQXG7PRSuN0oqV9C4McofptfuakxfIMBqOeoOoF72ZDq7ii7fx5VU/iqK/IIDnwveznguk3Pk+u7qs/bnU6Q+IUx2blbT6HbP6XJHhRXRxygDPOakcW6pSpj/9f8uPxijz/dqPY1edvIXMhcQvLYW/UPJtGZenZdzKDc9F6m+PqVqj/LGVdMO7OvzpaERt5PVwUGpXXhdpMSmNcFuIZzt47nEterU+ns2reQAFukw1tx0lzF0GMYQrdGV991k0GzTW40uTQwyZc9rGYci17reEyPnCErtDrkW4GUAVHFtbx1dCrnrfRc1fEp5QU+u+HaS97x7X4gNuob3XDqwCEDTMDHnqt5bOS+XBTa/uNMqJWEnf6c0ATp8SYZmwXp2qpCxQOj91tlSGHaHZgltMmZLMZeiVJB/1B8xqTMSyWZg+e5APcqIKZKVFeityIdc2fpA9NrtbLkUieM7+xIUVDuev2s49PT2ddOy1x4yFy8oFM6jVi/nKC31bu6j94TUE4NAU9m45QbMRCTZT+kao0BuHDQ144mnQPAat6N0xiNYyFwlKi53FvR5//sg2bNSPIOisx79IOvx4+/vNp8kN+aV1rIc06Ef9yD8oyrqCy06ocfvUHz3zx4PevZD7P/98aBbT4bMLdc6FJ6cvc9cQawYtseYBZMo6Eu12tD73Jq8qEv9doiG6zgPYcCMoA0/WoF1nYuIat9TPJEFNtN3wvKw5cXQ7HVB8fDOFAHhJmXRptPY0aj7Ie6uS247vQ37VCdBfovpXAb9QCz/g9te9ea35JqCpr7Wm/s2rqvoH+d5bFA==",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/ivcfWoB2ZLtJF2FYWg2ZEbaoilgBwPmGAUtnS3GEsmRlBPD0H8fjpIc2W6LGRv6JRHv7rn3h/QOHF9ZiGdwb9HAPIAUbWKEdkJJiGGaIRujY6Rl159vGUq+yNGyrSqZU2yFjj4NU0+S8SRRpXQsRcdFbvsQgNJoOPm6TSGGFTofJgCDVitp0UK8g2EU0b/DyJMySdDaZZmzvRMIIFHSoXRkz7XOReIV4aMl0A5skmHB6cttNUIMavGIiYMAtCE3TtQhazEltbe0zgi5ggCWyhTcdSX4zAudk9EfY7EejhbZ/XuoApC8wHM9vFfIfkMkOBZc5OfiHxUuEN81gn6iCnKlMyXPTuXi8urNz6PhYDgiF49qMRUuP9tLihuCJ6rQXG7PRSuN0oqV9C4McofptfuakxfIMBqOeoOoF72ZDq7ii7fx5VU/iqK/IIDnwveznguk3Pk+u7qs/bnU6Q+IUx2blbT6HbP6XJHhRXRxygDPOakcW6pSpj/9f8uPxijz/dqPY1edvIXMhcQvLYW/UPJtGZenZdzKDc9F6m+PqVqj/LGVdMO7OvzpaERt5PVwUGpXXhdpMSmNcFuIZzt47nEterU+ns2reQAFukw1tx0lzF0GMYQrdGV991k0GzTW40uTQwyZc9rGYci17reEyPnCErtDrkW4GUAVHFtbx1dCrnrfRc1fEp5QU+u+HaS97x7X4gNuob3XDqwCEDTMDHnqt5bOS+XBTa/uNMqJWEnf6c0ATp8SYZmwXp2qpCxQOj91tlSGHaHZgltMmZLMZeiVJB/1B8xqTMSyWZg+e5APcqIKZKVFeityIdc2fpA9NrtbLkUieM7+xIUVDuev2s49PT2ddOy1x4yFy8oFM6jVi/nKC31bu6j94TUE4NAU9m45QbMRCTZT+kao0BuHDQ144mnQPAat6N0xiNYyFwlKi53FvR5//sg2bNSPIOisx79IOvx4+/vNp8kN+aV1rIc06Ef9yD8oyrqCy06ocfvUHz3zx4PevZD7P/98aBbT4bMLdc6FJ6cvc9cQawYtseYBZMo6Eu12tD73Jq8qEv9doiG6zgPYcCMoA0/WoF1nYuIat9TPJEFNtN3wvKw5cXQ7HVB8fDOFAHhJmXRptPY0aj7Ie6uS247vQ37VCdBfovpXAb9QCz/g9te9ea35JqCpr7Wm/s2rqvoH+d5bFA==",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={},j=[{value:"Request",id:"request",level:2}];function f(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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get your account details"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,t.jsx)(a.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"jobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,t.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,t.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,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.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,t.jsxs)(p.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"User not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); |