User Management

User Management is used to control who can access the publicly available APIs of a project. On this page you invite users to access the APIs and apply access roles to these users. This page is not visible by default. API Publishing needs to be enabled to make it visible on the Home menu, This is done on the API Publishing page. where access roles are also defined.

Before you can invite users, you need to publish the project. See Publishing projects for details. An error will appear if the project is not published first.

Inviting users to a project

Once a project has been published, users can be invited to access the publicly available API endpoints in the project based.

For example, you can provide a URL to users for them to sign up to a Xapix account to access an API.

URL for users to sign up to a Xapix account

Alternately, you can invite users to access a project's API and assign them a specific access role.

Invite a user to access a project

To invite a user to a project, follow these steps.

  1. From the Home menu, select User Management.

  2. Click Invite API User, then on the Invite to <Project> page, enter the following:

    1. A valid email address of the user.

    2. User name

    3. Company name

    4. Select an access role from the available roles for the user.

  3. Click Invite API User.

  4. The <Project> Users page opens.

Invitation sent

Viewing client credentials

Xapix uses OAuth2 to authorize public API consumers to authenticate against the project's publicly available API.

When a user is invited to a published project, Xapix automatically generates client credentials for the new user of the project. A Client ID and a Client Secret is generated to obtain a short-lived access key to access the API.