quickbase-js 0.1.0-beta.9 → 1.0.0

package/specs/split/auth.json

@@ -1,191 +0,0 @@
-{
-  "swagger": "2.0",
-  "info": {
-    "title": "Quick Base API",
-    "version": "1.0.0"
-  },
-  "paths": {
-    "/auth/temporary/{dbid}": {
-      "get": {
-        "description": "Use this endpoint to get a temporary authorization token, scoped to either an app or a table. It can only be used inside of code pages for client-side authentication because it relies on the browser session. Learn more about [extending Quickbase](https://helpv2.quickbase.com/hc/en-us/articles/4570341709844-Extending-Quickbase). You can then use this token to make other API calls (see [authorization](../auth)).  This token expires in 5 minutes.",
-        "summary": "Get a temporary token for a dbid",
-        "operationId": "getTempTokenDBID",
-        "consumes": [
-          "application/json"
-        ],
-        "produces": [
-          "application/json"
-        ],
-        "parameters": [
-          {
-            "name": "dbid",
-            "in": "path",
-            "required": true,
-            "description": "The unique identifier of an app or table.",
-            "type": "string"
-          },
-          {
-            "name": "QB-Realm-Hostname",
-            "in": "header",
-            "required": true,
-            "description": "Your Quickbase domain, for example demo.quickbase.com",
-            "type": "string"
-          },
-          {
-            "name": "User-Agent",
-            "in": "header",
-            "required": false,
-            "description": "This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.",
-            "type": "string"
-          },
-          {
-            "name": "QB-App-Token",
-            "in": "header",
-            "required": false,
-            "description": "Your Quickbase app token",
-            "type": "string"
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "This token is used in the authorization header value (similar to the QB-USER-TOKEN), except it uses the QB-TEMP-TOKEN prefix header['Authorization'] = 'QB-TEMP-TOKEN {token}'",
-            "x-amf-mediaType": "application/json",
-            "schema": {
-              "example": {
-                "temporaryAuthorization": "token"
-              },
-              "type": "object",
-              "additionalProperties": true,
-              "properties": {
-                "temporaryAuthorization": {
-                  "description": "Temporary authorization token.",
-                  "type": "string"
-                }
-              }
-            }
-          }
-        },
-        "tags": [
-          "Auth"
-        ]
-      }
-    },
-    "/auth/oauth/token": {
-      "post": {
-        "description": "Use this endpoint to exchange a SAML assertion for a Quickbase token following [RFC 8693](https://www.rfc-editor.org/rfc/rfc8693.html). Callers can choose to return a token compatible with SCIM, XML, or RESTful APIs. The token duration is determined by the [SAML timeout session time](https://helpv2.quickbase.com/hc/en-us/articles/4570410646420-SAML-assertion-example#:~:text=Setting%20SAML%20timeout%20session%20time). You must be able to create a SAML assertion in your code to use this endpoint. The SAML assertion is verified against the configuration on the realm. Learn more about about [SAML assertions](https://helpv2.quickbase.com/hc/en-us/articles/4570410646420-SAML-assertion-example).",
-        "summary": "Exchange an SSO token",
-        "operationId": "exchangeSsoToken",
-        "consumes": [
-          "application/json"
-        ],
-        "produces": [
-          "application/json"
-        ],
-        "parameters": [
-          {
-            "name": "QB-Realm-Hostname",
-            "in": "header",
-            "required": true,
-            "description": "Your Quickbase domain, for example demo.quickbase.com",
-            "type": "string"
-          },
-          {
-            "name": "User-Agent",
-            "in": "header",
-            "required": false,
-            "description": "This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.",
-            "type": "string"
-          },
-          {
-            "name": "generated",
-            "in": "body",
-            "schema": {
-              "example": {
-                "grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",
-                "requested_token_type": "urn:quickbase:params:oauth:token-type:temp_ticket",
-                "subject_token": "PHNhbWxwOlJlc3BvbnNlDQogICAgeG1sbnM6c2FtbHA9bjp...",
-                "subject_token_type": "urn:ietf:params:oauth:token-type:saml2"
-              },
-              "type": "object",
-              "additionalProperties": false,
-              "required": [
-                "grant_type",
-                "subject_token",
-                "subject_token_type",
-                "requested_token_type"
-              ],
-              "properties": {
-                "grant_type": {
-                  "type": "string",
-                  "description": "The value `urn:ietf:params:oauth:grant-type:token-exchange` indicates that a token exchange is being performed.",
-                  "enum": [
-                    "urn:ietf:params:oauth:grant-type:token-exchange"
-                  ]
-                },
-                "requested_token_type": {
-                  "type": "string",
-                  "description": "An identifier for the type of the requested security token. For the RESTful API, use `urn:quickbase:params:oauth:token-type:temp_token`. For the XML or SCIM APIs use `urn:quickbase:params:oauth:token-type:temp_ticket`.",
-                  "enum": [
-                    "urn:quickbase:params:oauth:token-type:temp_ticket",
-                    "urn:quickbase:params:oauth:token-type:temp_token"
-                  ]
-                },
-                "subject_token": {
-                  "type": "string",
-                  "description": "A security token that represents the identity of the party on behalf of whom the request is being made. For SAML 2.0, the value should be a base64url-encoded SAML 2.0 assertion."
-                },
-                "subject_token_type": {
-                  "type": "string",
-                  "description": "An identifier that indicates the type of the security token in the `subject_token` parameter.",
-                  "enum": [
-                    "urn:ietf:params:oauth:token-type:saml2"
-                  ]
-                }
-              }
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "Success",
-            "x-amf-mediaType": "application/json",
-            "schema": {
-              "example": {
-                "access_token": "example_token_1NiIsImtpZCI6IjllciJ9w",
-                "issued_token_type": "urn:quickbase:params:oauth:token-type:temp_ticket",
-                "token_type": "N_A"
-              },
-              "type": "object",
-              "additionalProperties": true,
-              "properties": {
-                "access_token": {
-                  "type": "string",
-                  "description": "The security token issued by the authorization server in response to the token exchange request. The identifier `access_token` is used for historical reasons and the issued token need not be an OAuth access token."
-                },
-                "issued_token_type": {
-                  "type": "string",
-                  "description": "An identifier for the representation of the issued security token.",
-                  "enum": [
-                    "urn:quickbase:params:oauth:token-type:temp_ticket",
-                    "urn:quickbase:params:oauth:token-type:temp_token"
-                  ]
-                },
-                "token_type": {
-                  "type": "string",
-                  "description": "Will always return `N_A`",
-                  "enum": [
-                    "N_A"
-                  ]
-                }
-              }
-            }
-          }
-        },
-        "tags": [
-          "Auth"
-        ]
-      }
-    }
-  },
-  "definitions": {}
-}