public class JSApiKeyManager extends JSBaseScriptableObject
myLogger
Constructor and Description |
---|
JSApiKeyManager() |
Modifier and Type | Method and Description |
---|---|
boolean |
jsFunction_deleteApiKey(java.lang.String theApiKey)
Deletes a specific API key
|
java.lang.String |
jsFunction_getKey(java.lang.String theUserName,
java.lang.String theName)
Gets a key from the apikey table with theName for theUser
|
java.lang.String[] |
jsFunction_getKeysByName(java.lang.String theName)
Returns an array of api key that have the given api key name
|
java.lang.String |
jsFunction_getOrCreateApiKey(java.lang.String theName,
java.lang.String theUserName)
This method gets or creates a permanent API key for the calling user
|
java.lang.String |
jsFunction_getOrCreateExpiringApiKey(java.lang.String theUserName,
java.lang.String theExpirationTimeInMs,
java.lang.String theKeyName)
This method gets or creates an expiring API key for the calling user
|
java.lang.String |
jsFunction_getOrCreateWorkflowApiKey(java.lang.String theWorkflowName,
java.lang.String theUserName)
This gets or creates an API key that can only be used to run the specified workflow
|
boolean |
jsFunction_isKeyOwner(java.lang.String theAPIKey,
java.lang.String theUsername) |
java.lang.String |
jsFunction_setKey(java.lang.String theUserName,
java.lang.String theName,
java.lang.String theKey)
Sets a key in the apikey table for the user with the name
|
applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, equivalentValues, get, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, has, hasInstance, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size
public java.lang.String jsFunction_getOrCreateWorkflowApiKey(java.lang.String theWorkflowName, java.lang.String theUserName)
theWorkflowName
- The name of the workflow this API key runstheUserName
- Optional username (current user if omitted)public java.lang.String jsFunction_getOrCreateApiKey(java.lang.String theName, java.lang.String theUserName)
theName
- optional key name, may be emptytheUserName
- Optional username (current user if omitted)public java.lang.String jsFunction_getOrCreateExpiringApiKey(java.lang.String theUserName, java.lang.String theExpirationTimeInMs, java.lang.String theKeyName)
theUserName
- (optional) username (current user if omitted)theExpirationTimeInMs
- (optional) time in milliseconds since the UNIX epoch (January 1, 1970 00:00:00 UTC)theKeyName
- (optional) name given given to the apikey. ex. REST APIpublic boolean jsFunction_deleteApiKey(java.lang.String theApiKey)
theApiKey
- the key to deletepublic java.lang.String jsFunction_getKey(java.lang.String theUserName, java.lang.String theName)
theName
- the name of the keytheUserName
- the user to get the key forpublic java.lang.String jsFunction_setKey(java.lang.String theUserName, java.lang.String theName, java.lang.String theKey)
theName
- name of the keytheUserName
- the user nametheKey
- the apikey valuepublic java.lang.String[] jsFunction_getKeysByName(java.lang.String theName)
theName
- public boolean jsFunction_isKeyOwner(java.lang.String theAPIKey, java.lang.String theUsername)
Copyright © 2023 MediaBeacon, Inc. All Rights Reserved.