nitrogen-core/lib/models/apiKey.js

Core services used across ingestion, registry, and consumption servers.

var BaseSchema = require('./baseSchema')
  , mongoose = require('mongoose')
  , Schema = mongoose.Schema;

var apiKeySchema = new BaseSchema();
apiKeySchema.add({
//  From BaseSchema:
//  created_at:         { type: Date, default: Date.now },

    enabled:            { type: Boolean, default: true },
    key:                { type: String },
    name:               { type: String },
    type:               { type: String },
    owner:              { type: Schema.Types.ObjectId, ref: 'Principal' },

    capabilities:       [{ type: String }],

    redirect_uri:       { type: String }
});

apiKeySchema.index({ key: 1 });
apiKeySchema.index({ owner: 1 });

apiKeySchema.set('toObject', { transform: BaseSchema.baseObjectTransform });
apiKeySchema.set('toJSON', { transform: BaseSchema.baseJsonTransform });

var ApiKey = mongoose.model('ApiKey', apiKeySchema);

ApiKey.prototype.can = function(capability) {
    return this.capabilities && this.capabilities.indexOf(capability) !== -1;
};

ApiKey.APIKEY_TYPES = ['app', 'user'];

module.exports = ApiKey;