kibo-auth-sdk
v1.0.0
Published
Auth SDK
Downloads
3
Readme
kibo-auth-sdk
KiboAppDevService - JavaScript client for kibo_app_dev_service No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:
- Package version: 1.0.0
- Build package: org.openapitools.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 kibo-auth-sdk --save
Finally, you need to build the module:
npm run build
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your kibo_app_dev_service from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
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 Auth = require('kibo-sdk-auth');
var authApiClient = Auth.ApiClient.instance;
authApiClient.basePath = "[base path]";
var mozuAppDevContractsOauthAuthRequest = new Auth.MozuAppDevContractsOauthAuthRequest()
mozuAppDevContractsOauthAuthRequest.client_id = "[client_id]";
mozuAppDevContractsOauthAuthRequest.client_secret = "[client_secret]";
let apiInstance = new Auth.AppAuthTicketsApi(authApiClient);
let opts = {
'xVolTenant': null, // Number |
'xVolSite': null, // Number |
'appAuthInfo': mozuAppDevContractsOauthAuthRequest // MozuAppDevContractsOauthAuthRequest |
};
apiInstance.oauthAuthenticateApp(opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log(data);
}
});
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- KiboAppDevService.AppAuthTicketsApi | oauthAuthenticateApp | POST /platform/applications/authtickets/oauth |
Documentation for Models
- KiboAppDevService.HttpContent
- KiboAppDevService.HttpMethod
- KiboAppDevService.HttpRequestMessage
- KiboAppDevService.HttpResponseMessage
- KiboAppDevService.KeyValuePair2
- KiboAppDevService.MozuAdminUserContractsInvitation
- KiboAppDevService.MozuAdminUserContractsInvitationCollection
- KiboAppDevService.MozuAdminUserContractsInvitationRole
- KiboAppDevService.MozuAppDevContractsAccessTokenResponse
- KiboAppDevService.MozuAppDevContractsActionLoggingEvent
- KiboAppDevService.MozuAppDevContractsAddressCapabilityType
- KiboAppDevService.MozuAppDevContractsApiMajorMinorVersion
- KiboAppDevService.MozuAppDevContractsApiMajorMinorVersionCollection
- KiboAppDevService.MozuAppDevContractsApiVersion
- KiboAppDevService.MozuAppDevContractsApiVersionNumber
- KiboAppDevService.MozuAppDevContractsApiVersionRequest
- KiboAppDevService.MozuAppDevContractsAppAuthInfo
- KiboAppDevService.MozuAppDevContractsAppStoreCategoryNode
- KiboAppDevService.MozuAppDevContractsAppStoreLocalizedProfile
- KiboAppDevService.MozuAppDevContractsAppStoreProfile
- KiboAppDevService.MozuAppDevContractsAppStoreProfilePagedCollection
- KiboAppDevService.MozuAppDevContractsAppStoreSupportInfo
- KiboAppDevService.MozuAppDevContractsAppVersion
- KiboAppDevService.MozuAppDevContractsApplication
- KiboAppDevService.MozuAppDevContractsApplicationAttribute
- KiboAppDevService.MozuAppDevContractsApplicationAttributeCollection
- KiboAppDevService.MozuAppDevContractsApplicationBehavior
- KiboAppDevService.MozuAppDevContractsApplicationCapability
- KiboAppDevService.MozuAppDevContractsApplicationCapabilityDomain
- KiboAppDevService.MozuAppDevContractsApplicationCapabilityDomainValue
- KiboAppDevService.MozuAppDevContractsApplicationCapabilityItemRequest
- KiboAppDevService.MozuAppDevContractsApplicationCapabilityRequest
- KiboAppDevService.MozuAppDevContractsApplicationCapabilityType
- KiboAppDevService.MozuAppDevContractsApplicationCapabilityTypeView
- KiboAppDevService.MozuAppDevContractsApplicationCapabilityView
- KiboAppDevService.MozuAppDevContractsApplicationChangeNotePagedCollection
- KiboAppDevService.MozuAppDevContractsApplicationCollection
- KiboAppDevService.MozuAppDevContractsApplicationEntitlement
- KiboAppDevService.MozuAppDevContractsApplicationEntitlementCollection
- KiboAppDevService.MozuAppDevContractsApplicationLicense
- KiboAppDevService.MozuAppDevContractsApplicationLifecycleRequest
- KiboAppDevService.MozuAppDevContractsApplicationSubscription
- KiboAppDevService.MozuAppDevContractsApplicationSubscriptionPagedCollection
- KiboAppDevService.MozuAppDevContractsApplicationSummary
- KiboAppDevService.MozuAppDevContractsApplicationSummaryCollection
- KiboAppDevService.MozuAppDevContractsApplicationTemplate
- KiboAppDevService.MozuAppDevContractsApplicationTransaction
- KiboAppDevService.MozuAppDevContractsApplicationTypeLicense
- KiboAppDevService.MozuAppDevContractsAssetFileMetadata
- KiboAppDevService.MozuAppDevContractsAssetFileMetadataCollection
- KiboAppDevService.MozuAppDevContractsAssetFileMetadataNode
- KiboAppDevService.MozuAppDevContractsAttribute
- KiboAppDevService.MozuAppDevContractsAttributeDefinition
- KiboAppDevService.MozuAppDevContractsAttributeDefinitionCollection
- KiboAppDevService.MozuAppDevContractsAttributeDefinitionRequest
- KiboAppDevService.MozuAppDevContractsAttributeSubscription
- KiboAppDevService.MozuAppDevContractsAttributeVocabularyValue
- KiboAppDevService.MozuAppDevContractsAuthTicket
- KiboAppDevService.MozuAppDevContractsAuthTicketRequest
- KiboAppDevService.MozuAppDevContractsBehaviorCategoryBehavior
- KiboAppDevService.MozuAppDevContractsBehaviorCategoryBehaviorCollection
- KiboAppDevService.MozuAppDevContractsBehaviorItem
- KiboAppDevService.MozuAppDevContractsCapabilityType
- KiboAppDevService.MozuAppDevContractsCapabilityTypeContract
- KiboAppDevService.MozuAppDevContractsCarrier
- KiboAppDevService.MozuAppDevContractsCarrierCollection
- KiboAppDevService.MozuAppDevContractsCatalog
- KiboAppDevService.MozuAppDevContractsChangeNote
- KiboAppDevService.MozuAppDevContractsCreditType
- KiboAppDevService.MozuAppDevContractsCreditTypeCollection
- KiboAppDevService.MozuAppDevContractsDashboardContent
- KiboAppDevService.MozuAppDevContractsDevAccountMember
- KiboAppDevService.MozuAppDevContractsDevAccountMemberCollection
- KiboAppDevService.MozuAppDevContractsDevAccountProdTenant
- KiboAppDevService.MozuAppDevContractsDevStoreTemplate
- KiboAppDevService.MozuAppDevContractsDeveloper
- KiboAppDevService.MozuAppDevContractsDeveloperAccount
- KiboAppDevService.MozuAppDevContractsDeveloperAccountAppType
- KiboAppDevService.MozuAppDevContractsDeveloperAccountCollection
- KiboAppDevService.MozuAppDevContractsDeveloperAccountContact
- KiboAppDevService.MozuAppDevContractsDeveloperAccountUser
- KiboAppDevService.MozuAppDevContractsDeveloperAccountUserCollection
- KiboAppDevService.MozuAppDevContractsDeveloperAccountUserCreateRequest
- KiboAppDevService.MozuAppDevContractsDeveloperContact
- KiboAppDevService.MozuAppDevContractsEvent
- KiboAppDevService.MozuAppDevContractsEventCategory
- KiboAppDevService.MozuAppDevContractsEventCategoryPagedCollection
- KiboAppDevService.MozuAppDevContractsEventPagedCollection
- KiboAppDevService.MozuAppDevContractsFeature
- KiboAppDevService.MozuAppDevContractsLocalizedCategory
- KiboAppDevService.MozuAppDevContractsLocalizedImage
- KiboAppDevService.MozuAppDevContractsMasterCatalog
- KiboAppDevService.MozuAppDevContractsOAuthAccessTokenResponse
- KiboAppDevService.MozuAppDevContractsOauthAuthRequest
- KiboAppDevService.MozuAppDevContractsOauthAuthRequestInternal
- KiboAppDevService.MozuAppDevContractsOrderCapabilityType
- KiboAppDevService.MozuAppDevContractsPackage
- KiboAppDevService.MozuAppDevContractsPackageCollection
- KiboAppDevService.MozuAppDevContractsPackageRequest
- KiboAppDevService.MozuAppDevContractsPackageSummary
- KiboAppDevService.MozuAppDevContractsPackageSummaryCollection
- KiboAppDevService.MozuAppDevContractsPaymentCapabilityType
- KiboAppDevService.MozuAppDevContractsProductionTenant
- KiboAppDevService.MozuAppDevContractsProductionTenantCollection
- KiboAppDevService.MozuAppDevContractsProject
- KiboAppDevService.MozuAppDevContractsProjectApplication
- KiboAppDevService.MozuAppDevContractsProjectCollection
- KiboAppDevService.MozuAppDevContractsProjectStatus
- KiboAppDevService.MozuAppDevContractsProjectSummary
- KiboAppDevService.MozuAppDevContractsProjectSummaryCollection
- KiboAppDevService.MozuAppDevContractsProjectTenant
- KiboAppDevService.MozuAppDevContractsProjectUser
- KiboAppDevService.MozuAppDevContractsProvisionTenantRequest
- KiboAppDevService.MozuAppDevContractsPublicApplicationVersionsCollection
- KiboAppDevService.MozuAppDevContractsPublicFileMetadata
- KiboAppDevService.MozuAppDevContractsPublicFolderMetadata
- KiboAppDevService.MozuAppDevContractsPublicPackageNamesCollection
- KiboAppDevService.MozuAppDevContractsPublicRenameInfo
- KiboAppDevService.MozuAppDevContractsRenderedEmail
- KiboAppDevService.MozuAppDevContractsRoleInfo
- KiboAppDevService.MozuAppDevContractsSite
- KiboAppDevService.MozuAppDevContractsSocialContact
- KiboAppDevService.MozuAppDevContractsStorePrice
- KiboAppDevService.MozuAppDevContractsTaxCapabilityType
- KiboAppDevService.MozuAppDevContractsTenant
- KiboAppDevService.MozuAppDevContractsTenantApplication
- KiboAppDevService.MozuAppDevContractsTenantApplicationCollection
- KiboAppDevService.MozuAppDevContractsTenantCollection
- KiboAppDevService.MozuAppDevContractsTypeItem
- KiboAppDevService.MozuAppDevContractsTypeItems
- KiboAppDevService.MozuAppDevContractsValidationItem
- KiboAppDevService.MozuCoreApiContractsAddress
- KiboAppDevService.MozuCoreApiContractsAuditInfo
- KiboAppDevService.MozuCoreApiContractsContact
- KiboAppDevService.MozuCoreApiContractsPhone
- KiboAppDevService.MozuCoreApiContractsProvisioningCloneTenantCatalogPairing
- KiboAppDevService.MozuCoreApiContractsProvisioningCloneTenantDataRequest
- KiboAppDevService.MozuCoreApiContractsProvisioningCloneTenantMasterCatalogPairing
- KiboAppDevService.MozuCoreApiContractsProvisioningCloneTenantSitePairing
- KiboAppDevService.MozuCoreApiContractsProvisioningCreateCatalogRequest
- KiboAppDevService.MozuCoreApiContractsProvisioningCreateCustomDomainRequest
- KiboAppDevService.MozuCoreApiContractsProvisioningCreateMasterCatalogRequest
- KiboAppDevService.MozuCoreApiContractsProvisioningCreateSiteRequest
- KiboAppDevService.MozuCoreApiContractsProvisioningCreateTenantRequest
- KiboAppDevService.MozuCoreApiContractsProvisioningDeleteCatalogRequest
- KiboAppDevService.MozuCoreApiContractsProvisioningDeleteMasterCatalogRequest
- KiboAppDevService.MozuCoreApiContractsProvisioningDeleteSiteRequest
- KiboAppDevService.MozuCoreApiContractsProvisioningDeleteTenantRequest
- KiboAppDevService.MozuCoreApiContractsUser
- KiboAppDevService.MozuCoreApiContractsUserRole
- KiboAppDevService.MozuCoreApiContractsUserScope
- KiboAppDevService.MozuCoreApiContractsUserSystemData
- KiboAppDevService.MozuCoreMessagingContractsMessagePublishingContext
- KiboAppDevService.MozuCoreMessagingContractsNotificationEmailNotification
- KiboAppDevService.MozuProvisioningContractsCatalogProvisionRequest
- KiboAppDevService.MozuProvisioningContractsMasterCatalogProvisionRequest
- KiboAppDevService.MozuProvisioningContractsSiteProvisionRequest
- KiboAppDevService.MozuReferenceContractsCountry
- KiboAppDevService.MozuReferenceContractsCountryCollection
- KiboAppDevService.MozuReferenceContractsCurrency
- KiboAppDevService.MozuReferenceContractsCurrencyCollection
- KiboAppDevService.MozuTenantContractsCatalog
- KiboAppDevService.MozuTenantContractsDomain
- KiboAppDevService.MozuTenantContractsMasterCatalog
- KiboAppDevService.MozuTenantContractsSite
- KiboAppDevService.MozuTenantContractsTenant
- KiboAppDevService.MozuTenantContractsTenantAttribute
- KiboAppDevService.Version
Documentation for Authorization
x-vol-app-claims
- Type: API key
- API key parameter name: x-vol-app-claims
- Location: HTTP header
x-vol-user-claims
- Type: API key
- API key parameter name: x-vol-user-claims
- Location: HTTP header