mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-12 20:57:40 +02:00
1 line
10 KiB
JavaScript
1 line
10 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>f});var n=s(85893),l=s(11151),t=s(58219),i=(s(62316),s(51039)),r=s.n(i),o=(s(82723),s(9487)),c=(s(41429),s(5397)),m=s(4667),d=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/itXftkKKLbz2k0YhmZbF6QtlgJJEGCJUVDSWWJMkRx5kmMY/rZfsp+2XzIcZTm20xYLNvSLLR3vnnvh3XNaCJJlEOmtuA7oxTgRBYbcK0fKGpGKqwrhDAn4FE4/nAMamWkMMLcNkIUSiR892JkBmee2MQQFklQ6DEQirEMvGeu8EKkokaKbRHgMzpqAQaQLcTAa8d+258smzzGESaNhDSISkVtDaIj1pXNa5fFgeB/YaCFCXmEt+YnmDkUqbHaPOYlEOM8wpDqXnZiDWmsG8sqUIhET62tJmxJ8kLXTrPTrmZoeHGbV9VuxTISRNT4X4a1F+AmRzbGWSj/X/t5ihvh6JRjktmYoV1nz7FCOjk9efXd4sH9wyBD3NrtSpJ+NUmDL5rmtnTTz51pbhyao0kQIj5KwOKVPgTyaHIwODvf2R3ujV1f7J+nR9+nxyWA0Gv0uEvFQx3p29yIKSbHO1KW1fm9c8RX8LHfVGm79DbXufcmKR6OjpxMQZ85YgoltTPHi/2t+9N76L+e+63u5EbcyWhn82I/wRw6+T+P4aRrnppVaFZE9ruwUzdfNZNM9de6fXo3qlOK52Ep1U94lGTBvvKK5SG8X4mFPOrXXnae34+U4ETVSZVdsxwFLqkQqhiVS03FfQN+iD9G+8VqkoiJyIR0OpXODfiC0zAJP91A6NWz3xTLZ1Q4kS2XKvS9ajR8DvuSidnXbCntdPenUO5yLnte2tBKh+DIrlEXsWn6f2Gi8qtWFQ3OpShMr3e6L3VVygzq3NfLWoAqhV//7z7+iRWHzpkZDsRFewEXjwdkZel4A0hQw0figMo1RWWptZ+slFFDWGkPQc1CGsPSSEApVKpIauCrKlJBLJzOlFbcOq9lub210XxjATYVUoeejbzyChAJb1NxxoK2dMg5ZkA3ZOvpYxQwz66cTDikBCVkTlMEQICD2JmgqaXKE/i4SsB6kATSE3nkVEKSqWXliPeBkonLFwDwnXuYEtTSyRHaWAMfNVXDetqrAAN5mTSAIVjcxEfZYY7+aDWIRBvCLarFLnIXdjsYCyoYhEshtgbAaG07DFJBhIHDsXuUYQQNJT6CxRR97L97kpNEanOV5VlKDnWzdLQORlybwFugC6q9mXT7nLe/66KOQ8wHcmTtzyc3SBOQG0MpMQ3pn9uB23WY3mAVFOP62n4fZbPZkDl5u25wpqpoMPDr7aFdGYZyaTfP1y0uRCEJfh4vJJfpW5bgaws/4HEbl4YrlZB5ZbrXrecZe7xow42iVowm4wUmnZx/eQwuHg5FINib/XwQ8fH/+85vfLt8wLjNNN3/7g9FgFL8VbKBamg1XZ32r7HzB7c7w4pG3//OX4YpzCB9o6LRUkXdjmosVZ96KnjPHiahsIBYtFpkMeO31csniPxr0zMTjRLTSK44g8nDSMxWT7BTnXM88R8eM3ErddHS3s3i22PvszZVIhGw4kk2GnEaGXD0wen9k5hvY29TZBcC/zOKfNPiBS/gO5z+u1buTzxqs8uu1uX7j5XL5D/0vD7U=",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+2XzIcZTm20xYLNvSLLR3vnnvh3XNaCJJlEOmtuA7oxTgRBYbcK0fKGpGKqwrhDAn4FE4/nAMamWkMMLcNkIUSiR892JkBmee2MQQFklQ6DEQirEMvGeu8EKkokaKbRHgMzpqAQaQLcTAa8d+258smzzGESaNhDSISkVtDaIj1pXNa5fFgeB/YaCFCXmEt+YnmDkUqbHaPOYlEOM8wpDqXnZiDWmsG8sqUIhET62tJmxJ8kLXTrPTrmZoeHGbV9VuxTISRNT4X4a1F+AmRzbGWSj/X/t5ihvh6JRjktmYoV1nz7FCOjk9efXd4sH9wyBD3NrtSpJ+NUmDL5rmtnTTz51pbhyao0kQIj5KwOKVPgTyaHIwODvf2R3ujV1f7J+nR9+nxyWA0Gv0uEvFQx3p29yIKSbHO1KW1fm9c8RX8LHfVGm79DbXufcmKR6OjpxMQZ85YgoltTPHi/2t+9N76L+e+63u5EbcyWhn82I/wRw6+T+P4aRrnppVaFZE9ruwUzdfNZNM9de6fXo3qlOK52Ep1U94lGTBvvKK5SG8X4mFPOrXXnae34+U4ETVSZVdsxwFLqkQqhiVS03FfQN+iD9G+8VqkoiJyIR0OpXODfiC0zAJP91A6NWz3xTLZ1Q4kS2XKvS9ajR8DvuSidnXbCntdPenUO5yLnte2tBKh+DIrlEXsWn6f2Gi8qtWFQ3OpShMr3e6L3VVygzq3NfLWoAqhV//7z7+iRWHzpkZDsRFewEXjwdkZel4A0hQw0figMo1RWWptZ+slFFDWGkPQc1CGsPSSEApVKpIauCrKlJBLJzOlFbcOq9lub210XxjATYVUoeejbzyChAJb1NxxoK2dMg5ZkA3ZOvpYxQwz66cTDikBCVkTlMEQICD2JmgqaXKE/i4SsB6kATSE3nkVEKSqWXliPeBkonLFwDwnXuYEtTSyRHaWAMfNVXDetqrAAN5mTSAIVjcxEfZYY7+aDWIRBvCLarFLnIXdjsYCyoYhEshtgbAaG07DFJBhIHDsXuUYQQNJT6CxRR97L97kpNEanOV5VlKDnWzdLQORlybwFugC6q9mXT7nLe/66KOQ8wHcmTtzyc3SBOQG0MpMQ3pn9uB23WY3mAVFOP62n4fZbPZkDl5u25wpqpoMPDr7aFdGYZyaTfP1y0uRCEJfh4vJJfpW5bgaws/4HEbl4YrlZB5ZbrXrecZe7xow42iVowm4wUmnZx/eQwuHg5FINib/XwQ8fH/+85vfLt8wLjNNN3/7g9FgFL8VbKBamg1XZ32r7HzB7c7w4pG3//OX4YpzCB9o6LRUkXdjmosVZ96KnjPHiahsIBYtFpkMeO31csniPxr0zMTjRLTSK44g8nDSMxWT7BTnXM88R8eM3ErddHS3s3i22PvszZVIhGw4kk2GnEaGXD0wen9k5hvY29TZBcC/zOKfNPiBS/gO5z+u1buTzxqs8uu1uX7j5XL5D/0vD7U=",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={},f=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,l.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,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(a.p,{children:"Get your account details"})}),"\n",(0,n.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,n.jsx)(a.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,n.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(t.Z,{children:[(0,n.jsxs)(p.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"jobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,n.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,n.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,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.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,n.jsxs)(p.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"User not found!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(p.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,n.jsx)(a,{...e,children:(0,n.jsx)(g,{...e})}):g(e)}}}]); |