@webex/test-users

@webex/test-users

The Webex Test Users library allows developers to create test users for integration testing.

• Install
• Usage
• Implementation
• Contribute
• Maintainers
• License

Install

npm install --save @webex/test-users

Usage

Note: This package is NODE only, not for browser usage

With the test users library, you can create and remove Webex test users:

import {createTestUser, removeTestUser} from '@webex/test-users';

createTestUser({displayName: 'Test User'}).then((myTestUser) => {
  // Do something amazing with myTestUser

  // When done, remove the test user
  removeTestUser(myTestUser)
});

The test users library falls back to a few environment variables if they aren't passed as config options:

• WEBEX_CLIENT_ID - The Webex client ID that has access to create test users
• WEBEX_CLIENT_SECRET - The Webex client secret for the given client id
• WEBEX_TEST_USERS_CONVERSATION_SERVICE_URL - The Webex url for conversation service to create test users
• WEBEX_SCOPE - The Webex scope the test users should be created with
• IDBROKER_BASE_URL - The Webex auth endpoint to get a client based access token

Implementation

Test User creation follows a different flow than standard users due to the fact that they are created on the fly.

The creation steps are as follows:

• A client access token is generated from the client id and secret.
  • Uses the "idbroker" url defined in IDBROKER_BASE_URL or passed via options
• A test user is generated with the client access token
  • Uses the url defined in WEBEX_TEST_USERS_CONVERSATION_SERVICE_URL or passed via options

Maintainers

This package is maintained by Cisco Webex for Developers.

Contribute

Pull requests welcome. Please see CONTRIBUTING.md for more details.

License

© 2016-2019 Cisco and/or its affiliates. All Rights Reserved.