fo

forge-oauth2

Asynchronous Node.js library for the Autodesk Forge oAuth2 implementation

Showing:

Popularity

Downloads/wk

4

GitHub Stars

2

Maintenance

Last Commit

5yrs ago

Contributors

1

Package

Dependencies

1

Size (min+gzip)

0.4KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

This package is now deprecated, please use the official SDK

build status Node.js npm Platforms License

Forge API: oAuth2 Data-Management OSS Model-Derivative Viewer

forge-oauth2

Asynchronous Node.js library for the Autodesk Forge oAuth2 implementation.

This SDK was generated from YAML using a modified version of the Swagger tools. Modified version located here.

Samples using this SDKs available here.

Installation

npm

npm install forge-oauth2 --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

This libray can either use callbacks ot Promises. Do not provide a callback parameter to use Promises.

callback version

var ForgeOauth2 =require ('forge-oauth2') ;

var defaultClient =ForgeOauth2.ApiClient.instance ;

// Configure OAuth2 access token for authorization: oauth2_access_code
var oauth2_access_code =defaultClient.authentications ['oauth2_access_code'] ;
oauth2_access_code.accessToken ="YOUR ACCESS TOKEN" ;

var api =new ForgeOauth2.InformationalApi()

var callback =function (error, data, response) {
  if ( error ) {
    console.error (error) ;
  } else {
    console.log ('API called successfully. Returned data: ' + data) ;
  }
};
api.aboutMe(callback) ;

Promise version

var ForgeOauth2 =require ('forge-oauth2') ;

var defaultClient =ForgeOauth2.ApiClient.instance ;

// Configure OAuth2 access token for authorization: oauth2_access_code
var oauth2_access_code =defaultClient.authentications ['oauth2_access_code'] ;
oauth2_access_code.accessToken ="YOUR ACCESS TOKEN" ;

var api =new ForgeOauth2.InformationalApi()

api.aboutMe().then (function (data) {
  console.log ('API called successfully. Returned data: ' + data) ;
}, function (error) {
  console.error (error) ;
}) ;

Documentation for API Endpoints

All URIs are relative to https://developer.api.autodesk.com/

ClassMethodHTTP requestDescription
ForgeOauth2.InformationalApiaboutMeGET /userprofile/v1/users/@meGET users/@me
ForgeOauth2.ThreeLeggedApiauthorizeGET /authentication/v1/authorizeGET authorize
ForgeOauth2.ThreeLeggedApigettokenPOST /authentication/v1/gettokenPOST gettoken
ForgeOauth2.ThreeLeggedApirefreshtokenPOST /authentication/v1/refreshtokenPOST refreshtoken
ForgeOauth2.TwoLeggedApiauthenticatePOST /authentication/v1/authenticatePOST authenticate

Documentation for Models

Documentation for Authorization

oauth2_access_code

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://developer.api.autodesk.com/authentication/v1/authorize
  • Scopes:
    • data:read: The application will be able to read the end user’s data within the Autodesk ecosystem.
    • data:write: The application will be able to create, update, and delete data on behalf of the end user within the Autodesk ecosystem.
    • data:create: The application will be able to create data on behalf of the end user within the Autodesk ecosystem.
    • data:search: The application will be able to search the end user’s data within the Autodesk ecosystem.
    • bucket:create: The application will be able to create an OSS bucket it will own.
    • bucket:read: The application will be able to read the metadata and list contents for OSS buckets that it has access to.
    • bucket:update: The application will be able to set permissions and entitlements for OSS buckets that it has permission to modify.
    • bucket:delete: The application will be able to delete a bucket that it has permission to delete.
    • code:all: The application will be able to author and execute code on behalf of the end user (e.g., scripts processed by the Design Automation API).
    • account:read: For Product APIs, the application will be able to read the account data the end user has entitlements to.
    • account:write: For Product APIs, the application will be able to update the account data the end user has entitlements to.
    • user-profile:read: The application will be able to read the end user’s profile data.

oauth2_application

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
    • data:read: The application will be able to read the end user’s data within the Autodesk ecosystem.
    • data:write: The application will be able to create, update, and delete data on behalf of the end user within the Autodesk ecosystem.
    • data:create: The application will be able to create data on behalf of the end user within the Autodesk ecosystem.
    • data:search: The application will be able to search the end user’s data within the Autodesk ecosystem.
    • bucket:create: The application will be able to create an OSS bucket it will own.
    • bucket:read: The application will be able to read the metadata and list contents for OSS buckets that it has access to.
    • bucket:update: The application will be able to set permissions and entitlements for OSS buckets that it has permission to modify.
    • bucket:delete: The application will be able to delete a bucket that it has permission to delete.
    • code:all: The application will be able to author and execute code on behalf of the end user (e.g., scripts processed by the Design Automation API).
    • account:read: For Product APIs, the application will be able to read the account data the end user has entitlements to.
    • account:write: For Product APIs, the application will be able to update the account data the end user has entitlements to.
    • user-profile:read: The application will be able to read the end user’s profile data.

Documentation & Support

For more information, please visit https://developer.autodesk.com/en/docs/oauth/v2/

For support, please use http://stackoverflow.com/questions/tagged/autodesk-forge+oauth


License

This SDK is licensed under the terms of the MIT License. Please see the LICENSE file for full details.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial