@hypto/hypto_iam1 v1.1.0

hypto_iam

HyptoIam - JavaScript client for hypto_iam APIs for Hypto IAM Service. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• 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 @hypto/iam --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 HyptoIam = require('@hypto/iam');
var defaultClient = HyptoIam.ApiClient.instance;

// Configure API key authorization: apiKeyAuth
var apiKeyAuth = defaultClient.authentications['apiKeyAuth'];
apiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token"

var api = new HyptoIam.OrganizationManagementApi()
var body = new HyptoIam.CreateOrganizationRequest(); // {CreateOrganizationRequest} Payload to create organization

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

Documentation for API Endpoints

All URIs are relative to https://{environment}.{region}.hypto.com/v1

Documentation for Models

• HyptoIam.Action
• HyptoIam.ActionPaginatedResponse
• HyptoIam.AdminUser
• HyptoIam.BaseSuccessResponse
• HyptoIam.CreateActionRequest
• HyptoIam.CreateCredentialRequest
• HyptoIam.CreateOrganizationRequest
• HyptoIam.CreateOrganizationResponse
• HyptoIam.CreatePolicyRequest
• HyptoIam.CreateResourceRequest
• HyptoIam.CreateUserRequest
• HyptoIam.Credential
• HyptoIam.CredentialWithoutSecret
• HyptoIam.ErrorResponse
• HyptoIam.GetUserPoliciesResponse
• HyptoIam.Organization
• HyptoIam.PaginationOptions
• HyptoIam.Policy
• HyptoIam.PolicyAssociationRequest
• HyptoIam.PolicyPaginatedResponse
• HyptoIam.PolicyStatement
• HyptoIam.Resource
• HyptoIam.ResourceAction
• HyptoIam.ResourceActionEffect
• HyptoIam.ResourcePaginatedResponse
• HyptoIam.TokenResponse
• HyptoIam.UpdateActionRequest
• HyptoIam.UpdateCredentialRequest
• HyptoIam.UpdateOrganizationRequest
• HyptoIam.UpdatePolicyRequest
• HyptoIam.UpdateResourceRequest
• HyptoIam.UpdateUserRequest
• HyptoIam.User
• HyptoIam.UserPaginatedResponse
• HyptoIam.UserPolicy
• HyptoIam.ValidationRequest
• HyptoIam.ValidationResponse

Documentation for Authorization

apiKeyAuth

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

bearerAuth