@redbrick-sdk/authenticator

redbrick_authenticator

RedbrickAuthenticator - JavaScript client for redbrick_authenticator The OAuth 2.0 authorization framework enables a third-party application to obtain limited access to an HTTP service, either on behalf of a resource owner by orchestrating an approval interaction between the resource owner and the HTTP service, or by allowing the third-party application to obtain access on its own behalf. This specification replaces and obsoletes the OAuth 1.0 protocol described in RFC 5849. This SDK is automatically generated by the Swagger Codegen project:

• API version: 2.0.0-rc230214100516
• Package version: 2.0.0-rc230214100516
• Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install redbrick_authenticator --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false,
      },
    },
  ];
}

Getting Started

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

var RedbrickAuthenticator = require("redbrick_authenticator");

var api = new RedbrickAuthenticator.AuthorizeApi();
var opts = {
  body: new RedbrickAuthenticator.AccessAdminTokenRequest(), // {AccessAdminTokenRequest}
};
var callback = function (error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
};
api.adminToken(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8082/{version}

Class	Method	HTTP request	Description
RedbrickAuthenticator.AuthorizeApi	adminToken	POST /auth/token/admin
RedbrickAuthenticator.AuthorizeApi	getAuthorize	GET /auth/authorize
RedbrickAuthenticator.AuthorizeApi	postAuthorize	POST /auth/authorize
RedbrickAuthenticator.AuthorizeApi	token	POST /auth/token
RedbrickAuthenticator.AuthorizeApi	tokenGen	POST /auth/token/gen
RedbrickAuthenticator.AuthorizeApi	validate	POST /auth/validate
RedbrickAuthenticator.ClientApi	getIpxToken	POST /auth/token/ipx
RedbrickAuthenticator.ClientApi	getKbToken	POST /auth/token/kb
RedbrickAuthenticator.ServiceApi	liveness	GET /liveness
RedbrickAuthenticator.ServiceApi	ready	GET /ready
RedbrickAuthenticator.WalletApi	createWalletToken	POST /auth/wallet/token
RedbrickAuthenticator.WalletApi	getNonce	POST /auth/nonce
RedbrickAuthenticator.WalletApi	linkWallet	POST /auth/wallet/link

Documentation for Models

• RedbrickAuthenticator.AccessAdminTokenRequest
• RedbrickAuthenticator.AccessAdminTokenResponse
• RedbrickAuthenticator.AccessTokenGenRequest
• RedbrickAuthenticator.AccessTokenGenResponse
• RedbrickAuthenticator.AccessTokenRequest
• RedbrickAuthenticator.AccessTokenResponse
• RedbrickAuthenticator.AuthorizationClientResponse
• RedbrickAuthenticator.AuthorizationCode
• RedbrickAuthenticator.AuthorizationCodeResponse
• RedbrickAuthenticator.AuthorizationRequest
• RedbrickAuthenticator.AuthorizationResponse
• RedbrickAuthenticator.ClientCredentials
• RedbrickAuthenticator.ClientUserToken
• RedbrickAuthenticator.CombinedCredentials
• RedbrickAuthenticator.CreateWalletTokenRequest
• RedbrickAuthenticator.CreateWalletTokenResponse
• RedbrickAuthenticator.DeviceCode
• RedbrickAuthenticator.GetIpxTokenRequest
• RedbrickAuthenticator.GetKbTokenRequest
• RedbrickAuthenticator.GetKbTokenResponse
• RedbrickAuthenticator.GetNonceRequest
• RedbrickAuthenticator.GetSocialTokenResponse
• RedbrickAuthenticator.LinkWalletRequest
• RedbrickAuthenticator.NonceResponse
• RedbrickAuthenticator.OneOfaccessTokenRequestRequest
• RedbrickAuthenticator.OneOfauthorizationResponseResponse
• RedbrickAuthenticator.RefreshToken
• RedbrickAuthenticator.ResponseMessage
• RedbrickAuthenticator.UserToken
• RedbrickAuthenticator.ValidateRequest
• RedbrickAuthenticator.ValidateResponse
• RedbrickAuthenticator.WalletResponse
• RedbrickAuthenticator.WorldInfo

Documentation for Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header

BasicAuth

• Type: HTTP basic authentication

BearerAuth

OAuth2AuthorizationCode

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://auth.redbrick.land/v2/authorize
• Scopes:
  • :

OAuth2Client

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
  • :

OAuth2Password

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes:
  • :