Create a batch of users

POST 
/users/batch

Creates a new user in your Embedded account. The user record acts like a "container" to store all the integrations, workflows, and credentials for any given user. Returns a user identifier.

Request

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Your Embedded API key for authorization

application/json

Body

users json

Default value: [{ username: 'user123', fullName: 'Joe Smoe' }, { username: 'user456' }, { username: 'janedoe', fullName: 'Jane Doe' }]

An array of username and fullName to be created. Note that username is mandatory but fullName is optional. Limited to 1000 users at a time.

Responses

200

200

application/json

Schema

Schema

message string

invalidUsers

object[]

Array [

fullName string

]

Example (from schema)

{
  "message": "success",
  "invalidUsers": [
    {
      "fullName": "Missing Username"
    }
  ]
}

Result

{
  "message":"success",
  "invalidUsers":[{"fullName":"Missing Username"},{"username": "alreadyexists123"}]
}

400

400

application/json

Schema

Schema

oneOf

MOD1

message string

MOD2

message string

Example (from schema)

{}

Result

{
  "message": "No valid users provided"
}

401

401

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...