Add js Auth example with PAT

Author: Paulo Cabral

rest-api/javascript/authentication/client-credential-pat/.env.example

@@ -0,0 +1,5 @@
+# Base Url endpoint
+BASE_URL='https://api-sandbox.uphold.com'
+
+USERNAME ='my_registration_email@domain.com'
+PASSWORD = 'my_password_in_clear_text'

rest-api/javascript/authentication/client-credential-pat/README.md

@@ -0,0 +1,27 @@
+CLIENT CREDENTIAL PAT 
+=====================
+
+# Scenario
+**Ideal for scripts**, automated tools and command-line programs which remain under your control.
+
+This example works if your account has 2FA active. You need to make use of the TOTP code provide by your chosen authenticator app (Google Auth, etc). Please look at `line 20` of `index.js` file.
+
+- Creates a new PAT for API usage.
+- List all created PAT'S associated to this account
+
+
+## Stack
+- JS/ES6
+- `node` v13.14.0 +
+
+## Setup
+- see the `package.json`
+- type: `npm install` or `yarn install`
+- Create a  `.env` file based on the `.env.example` file  and populate with the required DATA
+
+
+## RUN
+- node index.js
+
+
+

rest-api/javascript/authentication/client-credential-pat/cc-pat.js

@@ -0,0 +1,111 @@
+/**
+ * Dependencies.
+ */
+
+import axios from "axios";
+import b64Pkg from "js-base64";
+import dotenv from "dotenv";
+import path from "path";
+
+const { encode } = b64Pkg;
+dotenv.config({ path: path.resolve() + "/.env" });
+
+/**
+ * Get auth methods.
+ */
+
+export async function getAuthenticationMethods() {
+  // auth encoded with client ID and Client Secret
+  // set get options for axios
+  const auth = encode(process.env.USERNAME + ":" + process.env.PASSWORD);
+  const url = `${process.env.BASE_URL}/v0/me/authentication_methods`;
+
+  const options = {
+    method: "GET",
+    headers: {
+      Authorization: "Basic " + auth,
+      "content-type": "application/json",
+    },
+    url,
+  };
+
+  const data = axios(options)
+    .then((response) => {
+      return response.data;
+    })
+    .catch((error) => {
+      error.response.data.errors
+        ? console.log(JSON.stringify(error.response.data.errors, null, 2))
+        : console.log(JSON.stringify(error, null, 2));
+      throw error;
+    });
+
+  return data;
+}
+
+/**
+ * Create Pat Tokens.
+ * The OTPToken is provided by your personal otp application (Google Authenticator, etc)
+ */
+
+export async function createNewPAT(totp) {
+  // auth encoded with username and password
+  // set otp headers if passed!
+  // set post options for axios
+  const auth = encode(process.env.USERNAME + ":" + process.env.PASSWORD);
+
+  let headers = {
+    "Authorization": "Basic " + auth,
+    "content-type": "application/json",
+  };
+
+  const otpHeaders = {
+    "OTP-Method-Id": totp.OTPMethodId,
+    "OTP-Token": totp.OTPToken,
+  };
+
+  if (totp.OTPMethodId) {
+    headers = { ...headers, ...otpHeaders };
+  }
+
+  const url = `${process.env.BASE_URL}/v0/me/tokens`;
+  const options = {
+    method: "POST",
+    headers,
+    data: {
+      description: "Put a Description Here",
+    },
+    url,
+  };
+
+  const data = axios(options)
+    .then((response) => {
+      return response.data;
+    })
+    .catch((error) => {
+      error.response.data.errors
+        ? console.log(JSON.stringify(error.response.data.errors, null, 2))
+        : console.log(JSON.stringify(error, null, 2));
+      throw error;
+    });
+
+  return data;
+}
+
+/**
+ * Get Pat Tokens using an access token.
+ */
+
+export async function getMyPATTokens(accessToken) {
+  try {
+    const r = await axios.get(`${process.env.BASE_URL}/v0/me/tokens`, {
+      headers: {
+        Authorization: `Bearer ${accessToken}`,
+      },
+    });
+    return r.data;
+  } catch (error) {
+    console.log(JSON.stringify(error, null, 2));
+    throw error;
+  }
+}

rest-api/javascript/authentication/client-credential-pat/index.js

@@ -0,0 +1,37 @@
+/**
+ * Dependencies.
+ */
+
+import {
+  createNewPAT,
+  getAuthenticationMethods,
+  getMyPATTokens,
+} from "./cc-pat.js";
+
+(async () => {
+  // Get Authentication tokens
+  const authMethods = await getAuthenticationMethods();
+
+  let totp = {
+    OTPMethodId: "",
+    OTPToken: "783631", // WARNING!!! IF YOUR ACCOUNT HAS 2FA ON, PLEASE INSERT HERE THE OTP TOKEN PROVIDED BY YOUR APP (google authenticator, etc)!
+  };
+
+  // Try to determine if we have 2FA active!
+  const totpCheck =
+    authMethods != null ? authMethods.find((x) => x.type === "totp") : null;
+  if (totpCheck) {
+    totp.OTPMethodId = totpCheck.id;
+  }
+
+  const newPAT = await createNewPAT(totp);
+
+  if (newPAT.accessToken) {
+    console.log("New Private Access Token Created with success");
+    console.debug(newPAT.accessToken);
+
+    // Use the access token to list all PAT Tokens Created!
+    console.log("List PAT Tokens");
+    console.log(await getMyPATTokens(newPAT.accessToken));
+  }
+})();