npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gapps-directory

v1.1.0

Published

(Unofficial) Google Apps Directory Api client library.

Downloads

23

Readme

(Unofficial) Google Apps Directory Api client library.

Installation

npm install gapps-directory

Usage


var UsersClient = require('gapps-directory').Users;

var usersClient = new UsersClient({
  domain:       'a-gapps-domain.com',
  access_token: 'administrator access token for my application'
});

usersClient.getAll(function (err, users) {
  //..
});

Otherwise request the first access_token with the offline option and provide a refresh_token, client_id and client_secret as follows:


var UsersClient = require('gapps-directory').Users;

var usersClient = new UsersClient({
  domain:        'mydomain.com',
  refresh_token: 'x',
  client_id:     'my app client id',
  client_secret: 'my app client secret'
  /* optionally the first token 
  access_token:  'y',
  expires_in:    '3000'
   */
});

Users.getAll([ options, ] callback)

Fetch all the users from the directory API for an specific domain.

Options can have any of these maxResults, orderBy, sortOrder, query

Callback has the following arguments:

  • err: if a request return error it will be here
  • users: an array with all users

Users.getPage([options, ] callback)

Return a single page matching the query criteria (options).

Options can have any of these maxResults, orderBy, sortOrder, query and pageToken.

The callback returns a meta object wich has the nextPageToken.

For instance if you want to get only the two first pages:

users.getPage(function (err, users, meta) {

  users.getPage({pageToken: meta.nextPageToken}, function (err, usersSecondPage) {

  });
});

Todo

The Google Directory API is bigger than this, it has Groups, Nicknames and so on. You can also create, modify and delete users, groups and nicknames. All this is not supported yet, I will add new things as I need and I will kindly accept pull requests.

Develop

You will need a Google Apps account, credentials for some application and the admin of the Google Apps account to authorize your application. Then create a testing-keys.js file in the root of the folder with the following data:

module.exports = {
  "client_id":              "your client id",
  "client_secret":          "your client secret",
  "domain":                 "the-domain-of-the-gapps-account.com",
  "refresh_token":          "an-admin-refresh-token"
};

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Author

Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.