cst_identity_service_web_api

CstIdentityServiceWebApi - JavaScript client for cst_identity_service_web_api The identity service web API allows domains, users, and clients to be added, read, updated, and removed. All requests are authorized through OAuth 2.0. Fields may be defined with the following properties: * Read-only - Can never be set, always generated by the server * Immutable - Can be set when first created but can never change after that * Admin-only - Can only be set by an admin * Write-only - Can only be written and will never appear as output Unless otherwise specified, all date/time fields are represented as specified by RFC 3339. E.g. 2015-04-12T23:20:50.52Z This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build date: 2016-08-04T16:25:16.848Z
• Build package: class io.swagger.codegen.languages.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 cst_identity_service_web_api --save

git

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

    npm install YOUR_USERNAME/cst_identity_service_web_api --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:

var CstIdentityServiceWebApi = require('cst_identity_service_web_api');

var defaultClient = CstIdentityServiceWebApi.ApiClient.default;

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

var api = new CstIdentityServiceWebApi.DomainApi()

var domain = new CstIdentityServiceWebApi.DomainInfo(); // {DomainInfo} The domain to create. All required, non-read-only fields must be present. 


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

Documentation for API Endpoints

All URIs are relative to https://identity.cstkit.com

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CstIdentityServiceWebApi.DomainApi | addDomain | POST /domains | Add a domain. CstIdentityServiceWebApi.DomainApi | deleteDomain | DELETE /domains/{domain} | Delete a domain. CstIdentityServiceWebApi.DomainApi | getDomain | GET /domains/{domain} | Get a domain. CstIdentityServiceWebApi.DomainApi | getDomains | GET /domains | Get a list of domains. CstIdentityServiceWebApi.DomainApi | updateDomain | PUT /domains/{domain} | Update a domain. CstIdentityServiceWebApi.OauthApi | getAccessToken | POST /oauth2/token | Obtain an access token. CstIdentityServiceWebApi.OauthApi | getTokenInfo | GET /oauth2/tokeninfo | Get information about the given token. CstIdentityServiceWebApi.OauthApi | revoke | GET /oauth2/revoke | Revoke a token. CstIdentityServiceWebApi.RegisterApi | addClient | POST /register | Add a client. CstIdentityServiceWebApi.RegisterApi | deleteClient | DELETE /register/{clientID} | Delete a client. CstIdentityServiceWebApi.RegisterApi | getClient | GET /register/{clientID} | Get a client. CstIdentityServiceWebApi.RegisterApi | getClients | GET /register | Get a list of clients. CstIdentityServiceWebApi.RegisterApi | updateClient | PUT /register/{clientID} | Update a client. CstIdentityServiceWebApi.UserApi | addUser | POST /users | Add a user. CstIdentityServiceWebApi.UserApi | deleteUser | DELETE /users/{userID} | Delete the user identified by the userID. CstIdentityServiceWebApi.UserApi | getMe | GET /users/me | Get the currently authenticated user. CstIdentityServiceWebApi.UserApi | getUser | GET /users/{userID} | Get a user identified by the userID. CstIdentityServiceWebApi.UserApi | getUsers | GET /users | Get a list of users. CstIdentityServiceWebApi.UserApi | updateMe | PUT /users/me | Update the currently authenticated user. CstIdentityServiceWebApi.UserApi | updateUser | PUT /users/{userID} | Update the user identified by the userID.

Documentation for Models

• CstIdentityServiceWebApi.AccessTokenGrant
• CstIdentityServiceWebApi.Client
• CstIdentityServiceWebApi.ClientPage
• CstIdentityServiceWebApi.DomainInfo
• CstIdentityServiceWebApi.DomainPage
• CstIdentityServiceWebApi.Error
• CstIdentityServiceWebApi.OAuth2Error
• CstIdentityServiceWebApi.TokenInfo
• CstIdentityServiceWebApi.User
• CstIdentityServiceWebApi.UserPage

Documentation for Authorization

ClientAuth

• Type: HTTP basic authentication

AccessToken

• Type: OAuth
• Flow: implicit
• Authorization URL: https://cstkit.com/oauth2/authorize
• Scopes:

  • id: View the userID and domain associated with your account.

  • profile: View the name, gender, birthdate, time zone, and locale associated with your account.

  • email: View the email address associated with your account.

  • address: View the address associated with your account.

  • phone: View the phone number associated with your account.

  • update_user: Ability to update your user profile, including name, gender, birthdate, time zone, locale, email, address, phone, and password.

  • user_admin: Ability to add, remove, or update users within a domain.

  • register_admin: Ability to add, remove, or update clients within a domain.

  • root: Access to everything in all domains. Includes the ability to add, remove, or update domains.