G Users#

a. Create

#

Creates a new user

POST /users
import Fragment from '@fragment-dev/ts-node';

const client = new Fragment({
  clientId: process.env['FRAGMENT_CLIENT_ID'],
  clientSecret: process.env['FRAGMENT_CLIENT_SECRET'],
});

const response = await client.users.create({ external_id: 'user_ext_123', role: 'admin' });
Parameters
external_id
string, required
External ID for the user
role
string, required
Role of the user
Response
{
  "data": {
    "id": "user_abc123",
    "external_id": "user_ext_123",
    "role": "admin"
  }
}

b. List

#

Lists all users for the workspace

GET /users
import Fragment from '@fragment-dev/ts-node';

const client = new Fragment({
  clientId: process.env['FRAGMENT_CLIENT_ID'],
  clientSecret: process.env['FRAGMENT_CLIENT_SECRET'],
});

const response = await client.users.list();
Response
{
  "data": [
    {
      "id": "user_abc123",
      "external_id": "user_ext_123",
      "role": "admin"
    }
  ]
}