{"id":8344,"date":"2022-06-18T23:16:29","date_gmt":"2022-06-18T23:16:29","guid":{"rendered":"https:\/\/www.use-snip.com\/kb\/?post_type=ht_kb&p=8344"},"modified":"2022-06-21T20:18:19","modified_gmt":"2022-06-21T20:18:19","slug":"web-api-add-a-user","status":"publish","type":"ht_kb","link":"https:\/\/www.use-snip.com\/kb\/knowledge-base\/web-api-add-a-user\/","title":{"rendered":"Web API, Add a User"},"content":{"rendered":"

This article describes the step-by-step<\/em> process to remotely add a new User Account (NTRIP Client<\/a>) to the Caster.\u00a0 When the Web API Plug-In is present, SNIP<\/strong><\/span> allows adding new User Accounts remotely with a browser.\u00a0 For the Caster Admin account this process is never limited (you can create as many NTRIP Client accounts as you wish).\u00a0 For Customer Accounts, the number of Users which can be added by that Customer is limited by the value set by the Caster Administrator for the Customer.\u00a0\u00a0 An active Web API Plug-in<\/a> is required for this feature.\u00a0 First Login<\/strong> <\/a>from an authorized account with read-write<\/em> privileges, not with read-only<\/em> privileges.<\/p>\n

From the Web API top page<\/a>, go to the\u00a0Current Client Connections and Accounts <\/strong>section at the top of the page.\u00a0 Press the button marked Add a New User Account (NTRIP Client)<\/strong>.\u00a0\u00a0 This button is displayed below the (optional) table of users which are sending in $GGA sentences<\/a> (which you can enable\/disable in the Preferences<\/strong> dialog<\/a>).<\/p>\n

You will then be taken to a page to establish the name<\/strong> to be used with new User Account.\u00a0 See this article<\/a> for details of the naming process.\u00a0 Once a name has been determined, you will be taken to the New Account page, shown below (click to enlarge).<\/p>\n

\"\"<\/a>The data fields all follow the same general flow as the SNIP<\/strong><\/span> dialog for a new User Account<\/a> does.<\/p>\n

The name<\/strong> you enter on the prior page is used.\u00a0 This is the name the NTRIP Client will\u00a0 use to connect.<\/p>\n

The password<\/strong> field is completed with a suggested password.\u00a0 You may change this if desired.\u00a0 This is the password the NTRIP Client will\u00a0 use to connect.<\/p>\n

The number or simultaneous connections<\/strong> is how many concurrent connection the account is allowed to have.\u00a0 You may wish to set this value to be “1” depending on how you allow your clients access.<\/p>\n

Not every user restriction<\/a> type is can be set on the Web API page.\u00a0 The most common one is, restricting Caster access to an end date<\/a> beyond which the user can no longer connect (typically tied to a subscription service of some kind) is provided.<\/p>\n

The reminder of the form deals with assigning ownership of the User Account to a Customer Account<\/a> (or by default the Admin account).\u00a0 Select the Customer Account you want from the drop down menu.<\/p>\n

When the form is submitted (press the Create <\/strong>button), the new account is created and an email with similar details is sent to the Admin and the owner of the account (if the eMail Plug-In<\/a> is active)\u00a0\u00a0 See the below image.\u00a0 If there are any creation problems, a page with a summary of\u00a0 the errors is presented.<\/p>\n

\"\"<\/a><\/p>\n

Use by Customer Accounts<\/h2>\n

When this process is performed by a browser logged in with a Customer Account, the top of the page also provides a summary of how many User Accounts they have already created (and therefore own<\/em>) and how many more they are allowed to create.\u00a0 The ownership section is automatically assigned to their account (and they cannot edit this).<\/p>\n","protected":false},"excerpt":{"rendered":"

This article describes the step-by-step process to remotely add a new User Account (NTRIP Client) to the Caster.\u00a0 When the Web API Plug-In is present, SNIP allows adding new User Accounts remotely with a browser.\u00a0 For the Caster Admin account this process is never limited (you can create as many […]<\/p>\n","protected":false},"author":13,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"_exactmetrics_skip_tracking":false,"_exactmetrics_sitenote_active":false,"_exactmetrics_sitenote_note":"","_exactmetrics_sitenote_category":0,"footnotes":""},"ht-kb-category":[418],"ht-kb-tag":[178,495,518],"class_list":["post-8344","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-reports","ht_kb_tag-new-users","ht_kb_tag-user-accounts","ht_kb_tag-web-api"],"_links":{"self":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/8344","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/users\/13"}],"replies":[{"embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/comments?post=8344"}],"version-history":[{"count":11,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/8344\/revisions"}],"predecessor-version":[{"id":8438,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/8344\/revisions\/8438"}],"wp:attachment":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/media?parent=8344"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb-category?post=8344"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb-tag?post=8344"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}