Creates a user.
const response = await client.users.create(
{ external_id: 'user_ext_123', role: 'admin' }
);| Name | Description |
|---|---|
external_idstring, required | User-provided unique ID. |
rolestring, required | Name of the role to assign. Must match an existing role. |
tagsobject[] | Tags for the user. Set at creation; mutation is not yet supported. |
| Name | Description |
|---|---|
dataobject | User object. |
{
"data": {
"id": "user_abc123",
"external_id": "user_ext_123",
"role": "admin",
"tags": [
{
"key": "department",
"value": "engineering"
}
]
}
}Lists all users.
const response = await client.users.list();| Name | Description |
|---|---|
dataobject[] | List of users. |
{
"data": [
{
"id": "user_abc123",
"external_id": "user_ext_123",
"role": "admin",
"tags": [
{
"key": "department",
"value": "engineering"
}
]
}
]
}