Files
OpenSign/assets/js/1f73ca32.760fabc2.js
T

1 line
9.4 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:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>f});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),o=(a(82723),a(9487)),d=(a(41429),a(5397)),m=a(4667),c=a(9472),p=a(85162);const u={id:"get-user",title:"Get your details",description:"The Get User API enables you to get your own details.",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VW1v2zYQ/ivcfVoB2ZLtJN2EYWhWZEbSoglgBwPmGAUtnS0mEsmRlBPD0H8vjpIc2V6GeRj6xRbv7rn3h9yC4ysL8QzuLRqYB5CiTYzQTigJMUwzZGN0jLTs8u6aoeSLHC3bqJI5xVbo6NMw9SxZio6L3PYhAKXRcPJxnUIMK3TefQAGrVbSooV4C8Moor/9iJMySdDaZZmznRMIIFHSoXRkz7XOReIV4aMl0BZskmHB6cttNEIMavGIiYMAtCE3TtQhazEltbO0zgi5ggCWyhTcdSX4wgudk9HvY/E0HC2y+xuoAvjCCzzVw41C9hsiwa8KLvJT8Y8KF4gfGkE/UQW5usuUPDmVs/OL9z+NhoPhiFzcqMVUuPxkLymuCf5RFZrLzalopVFasZLkIjHIHaaX7u+cvEKG0XDUG0S96P10cBGf/RyfX/SjKPoTAngpfD+lnwuk3Pk+u7qs3bnU6XeIUx2albT6HbP6XJHhWXR2zADPNakcW6pSpj/8f8uPxijzz7Ufxq46eQuZC4lfWwp/peTbMs6Py7iWa56L1N8aU/WE8vtW0g3v6vDHoxG1kdfDXqldeV2kxaQ0wm0gnm3hpce16NX6eDav5gEU6DLV3HaUMHcZxBCu0JX13WfRrNFYjy9NDjFkzmkbh6F1fCXkqse17rfEyPnCEstDrkW4HgCFaFOYUJvqTuwlsusH1+ITbiBo6+xaBSBoPBny1O8hnZfKg5vqbzXKiVhJ37v1AI4fBWGZsF6dqqQsUDo/R7ZUhh2g2YJbTJmSzGXolSQf9QfMakzEslmBPnuQD3KiCmSlRbr9cyGfbPwge2x2u1yKRPCc/YELKxzOf2w79/z8fNSxdx4zFi4rF8ygVq/mKy/0be2idod3EIBDU9jb5QTNWiTYTOmNUKE3DpvF5olfbKyv91b04RBEi5aLBKXFzipeju8+s1E/gqCzHP8i5fDz9cerL5Mr8krrVY9o0I/6EYm0sq7gshNo3D7ZzXN9ON7tK0n/8/PfrKHDFxfqnAtPLl/WtiHGDFpizAPIlHUk2m5pWe5NXlUk/qtEQ3SbB7DmRlBkT7agXV5i0hNuqHtJgppot+Z5WTPg4HbZo+j4agoB8JIy6ZLmyZOm+SDvrUpuOr732VQnQL9V8AbgF2rdJ9z8ujOvNW8Cmvpaa+rfvKqqb0SaQJM=",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 details",description:"The Get User API enables you to get your own 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:"The Get User API enables you to get your own details.",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VW1v2zYQ/ivcfVoB2ZLtJN2EYWhWZEbSoglgBwPmGAUtnS0mEsmRlBPD0H8vjpIc2V6GeRj6xRbv7rn3h9yC4ysL8QzuLRqYB5CiTYzQTigJMUwzZGN0jLTs8u6aoeSLHC3bqJI5xVbo6NMw9SxZio6L3PYhAKXRcPJxnUIMK3TefQAGrVbSooV4C8Moor/9iJMySdDaZZmznRMIIFHSoXRkz7XOReIV4aMl0BZskmHB6cttNEIMavGIiYMAtCE3TtQhazEltbO0zgi5ggCWyhTcdSX4wgudk9HvY/E0HC2y+xuoAvjCCzzVw41C9hsiwa8KLvJT8Y8KF4gfGkE/UQW5usuUPDmVs/OL9z+NhoPhiFzcqMVUuPxkLymuCf5RFZrLzalopVFasZLkIjHIHaaX7u+cvEKG0XDUG0S96P10cBGf/RyfX/SjKPoTAngpfD+lnwuk3Pk+u7qs3bnU6XeIUx2albT6HbP6XJHhWXR2zADPNakcW6pSpj/8f8uPxijzz7Ufxq46eQuZC4lfWwp/peTbMs6Py7iWa56L1N8aU/WE8vtW0g3v6vDHoxG1kdfDXqldeV2kxaQ0wm0gnm3hpce16NX6eDav5gEU6DLV3HaUMHcZxBCu0JX13WfRrNFYjy9NDjFkzmkbh6F1fCXkqse17rfEyPnCEstDrkW4HgCFaFOYUJvqTuwlsusH1+ITbiBo6+xaBSBoPBny1O8hnZfKg5vqbzXKiVhJ37v1AI4fBWGZsF6dqqQsUDo/R7ZUhh2g2YJbTJmSzGXolSQf9QfMakzEslmBPnuQD3KiCmSlRbr9cyGfbPwge2x2u1yKRPCc/YELKxzOf2w79/z8fNSxdx4zFi4rF8ygVq/mKy/0be2idod3EIBDU9jb5QTNWiTYTOmNUKE3DpvF5olfbKyv91b04RBEi5aLBKXFzipeju8+s1E/gqCzHP8i5fDz9cerL5Mr8krrVY9o0I/6EYm0sq7gshNo3D7ZzXN9ON7tK0n/8/PfrKHDFxfqnAtPLl/WtiHGDFpizAPIlHUk2m5pWe5NXlUk/qtEQ3SbB7DmRlBkT7agXV5i0hNuqHtJgppot+Z5WTPg4HbZo+j4agoB8JIy6ZLmyZOm+SDvrUpuOr732VQnQL9V8AbgF2rdJ9z8ujOvNW8Cmvpaa+rfvKqqb0SaQJM=",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 j(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)(r(),{method:"get",path:"/getuser"}),"\n",(0,l.jsx)(s.p,{children:"The Get User API enables you to get your own details."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(p.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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)(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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.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)(p.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(j,{...e})}):j(e)}}}]);