{"basePath":"/v1","consumes":["application/json"],"definitions":{"Address":{"properties":{"city":{"description":"City","type":"string"},"country":{"description":"Country full name","type":"string"},"countrycode":{"description":"Country Code","type":"string"},"postalcode":{"description":"Postal Code","type":"string"},"state":{"description":"State full name","type":"string"},"statecode":{"description":"State Code","type":"string"},"street":{"description":"Street number and name","type":"string"}},"type":"object"},"Error":{"properties":{"code":{"format":"int32","type":"integer"},"fields":{"type":"string"},"message":{"type":"string"}},"type":"object"},"ResponseMeta":{"properties":{"contact":{"description":"Microservice Contact Info","type":"string"},"copyright":{"description":"Copyright Info","type":"string"},"license":{"description":"License Information and Restrictions","type":"string"},"operationid":{"description":"Operation ID","type":"string"},"requestip":{"description":"Request IP Address","type":"string"},"requesttype":{"description":"Request Type","type":"string"},"requesturl":{"description":"Request URL","type":"string"},"serverinfo":{"description":"Data Server Info","type":"string"},"serverresponsetime":{"description":"Data Server Response Time (ms)","type":"string"},"servertimestamp":{"description":"Backend Server Timestamp","type":"string"},"taxnexusaccount":{"description":"Taxnexus Account Number used for recording transactions","type":"string"}},"type":"object"},"User":{"properties":{"aboutme":{"description":"About Me","type":"string"},"accountid":{"description":"Account ID","type":"string"},"address":{"$ref":"#/definitions/Address"},"alias":{"description":"Alias","type":"string"},"apikey":{"description":"API Key","type":"string"},"communitynickname":{"description":"Nickname","type":"string"},"companyname":{"description":"Company Name","type":"string"},"contactid":{"description":"Contact","type":"string"},"createdbyid":{"description":"Created User ID","type":"string"},"createddate":{"description":"Date Created","type":"string"},"delegatedapproverid":{"description":"Delegated Approver","type":"string"},"department":{"description":"Department","type":"string"},"division":{"description":"Division","type":"string"},"email":{"description":"Email address","type":"string"},"employeenumber":{"description":"Employee Number","type":"string"},"environment":{"description":"Environment","type":"string"},"extension":{"description":"Extension","type":"string"},"fabricapikey":{"description":"Fabric API Key","type":"string"},"fax":{"description":"Fax","type":"string"},"forecastenabled":{"description":"Allow Forecasting","type":"boolean"},"fullphotourl":{"description":"Full Photo URL","type":"string"},"id":{"description":"Taxnexus ID","type":"string"},"isactive":{"description":"Active","type":"boolean"},"isprofilephotoactive":{"description":"Has Profile Photo","type":"boolean"},"lastmodifiedbyid":{"description":"Last Modified User ID","type":"string"},"lastmodifieddate":{"description":"Last Modified Date","type":"string"},"managerid":{"description":"Manager","type":"string"},"mobilephone":{"description":"Mobile","type":"string"},"name":{"description":"Name","type":"string"},"outofofficemessage":{"description":"Out of office message","type":"string"},"phone":{"description":"Phone","type":"string"},"portalrole":{"description":"Portal Role Level","type":"string"},"profileid":{"description":"Profile","type":"string"},"receivesadmininfoemails":{"description":"Admin Info Emails","type":"boolean"},"receivesinfoemails":{"description":"Info Emails","type":"boolean"},"senderemail":{"description":"Email Sender Address","type":"string"},"sendername":{"description":"Email Sender Name","type":"string"},"signature":{"description":"Email Signature","type":"string"},"taxnexusaccount":{"description":"Taxnexus Account","type":"string"},"timezone":{"description":"Time Zone","type":"string"},"title":{"description":"Title","type":"string"},"username":{"description":"Username","type":"string"},"userroleid":{"description":"Role","type":"string"}},"type":"object"},"UserResponse":{"description":"An array Taxnexus user objects","properties":{"data":{"items":{"$ref":"#/definitions/User"},"type":"array"},"meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"}},"host":"auth.fabric.tnxs.net:8080","info":{"contact":{"email":"noc@taxnexus.net"},"description":"Authentication Microservice","license":{"name":"Proprietary - Copyright (c) 2018-2020 by Taxnexus, Inc."},"termsOfService":"http://taxnexus.net/terms/","title":"auth","version":"1.2.6"},"parameters":{"apiKeyQuery":{"description":"Service account or developer API key","in":"query","name":"apikey","type":"string"}},"paths":{"/users":{"get":{"description":"Checks for a valid API key, and returns full user record","operationId":"getUsers","parameters":[{"$ref":"#/parameters/apiKeyQuery"}],"responses":{"200":{"$ref":"#/responses/UserResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"summary":"Check API Key","tags":["User"]}}},"produces":["application/json"],"responses":{"AccessForbidden":{"description":"Access forbidden, account lacks access","schema":{"$ref":"#/definitions/Error"}},"NotFound":{"description":"Resource was not found","schema":{"$ref":"#/definitions/Error"}},"ServerError":{"description":"Server Internal Error","schema":{"$ref":"#/definitions/Error"}},"Unauthorized":{"description":"Access Unauthorized, invalid API-KEY was used","schema":{"$ref":"#/definitions/Error"}},"UnprocessableEntity":{"description":"Unprocessable Entity, likely a bad parameter","schema":{"$ref":"#/definitions/Error"}},"UserResponse":{"description":"Taxnexus Response with User objects","schema":{"$ref":"#/definitions/UserResponse"}}},"schemes":["http"],"security":[{"ApiKeyAuth":[]}],"securityDefinitions":{"ApiKeyAuth":{"in":"header","name":"X-API-Key","type":"apiKey"}},"swagger":"2.0"}
