Bulk upsert Local Users

Prev Next

Post

/local-users/bulk-upsert

Create or update multiple local users in a single request.

Security

HTTP

Type bearer

Body parameters

Bulk upsert request.

Expand All

object

data

Array of object (LocalUser) Required

object

string (uuid)

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc

name

string Required

Name of the object.

Exampleobject

notes

string

Notes for the object. Used for documentation purposes.

ExampleThis object has been created for test purposes.

tags

Array of string

Array of tags.

Example[ "developer", "api-created" ]

string

firstName

string Required

First name of the user. May be used as claim.

ExampleBobby

lastName

string Required

Last name of the user. May be used as claim.

ExampleTables

password

string (password)

Password for the user. Omit the field to keep the old password when updating a user.

ExampletSW3!QBv(rj{UuLY

string

E-mail address for the user. May be used as claim.

Examplebobby@tables.com

phone

string

Phone number for the user. May be used as claim.

Example+1-202-555-0172

disabled

boolean

If true, the user will not be able to login.

failedLoginAttempts

number

Number of wrong password login attempts since last successiful login.

Example0

lockStart

string (date-time)

The date time when the user got locked out. A local user is locked out of the system after X amount of consecutive failed login attempts, where X is configurable in the local Identity Provider. The lock is in effect for Y minute(s), where Y is configurable in the local Identity Provider. When the user logs in successfully, this field becomes null.

Responses

200

Bulk upsert report.

Expand All

object

created

Array of object (BulkUpsertEntityRef)

object

string (uuid)

ID of the entity.

name

string

Name of the entity.

updated

Array of object (BulkUpsertEntityRef)

object

string (uuid)

ID of the entity.

name

string

Name of the entity.

unchanged

Array of object (BulkUpsertEntityRef)

object

string (uuid)

ID of the entity.

name

string

Name of the entity.

failures

Array of object (BulkUpsertFailure)

object

string (uuid) | null

ID from the request item, if available.

name

string | null

Name from the request item, if available.

error

object (ValidationError)

Http 422 error for object validation.

string

Machine readable error code.

message

string

Human readable error details.

errors

Array of object

List of fields with validation errors.

object

field

string

Name of the field that failed validation.

Examplename

message

string

Failure reason.

Examplemay not be null

displayField

string

Name of the field that should be displayed in the UI. It's an internal field to be used by the local replication service.

ExampleName

replicationMessage

string

Message to be displayed in the replication UI. It's an internal field to be used by the local replication service.

ExampleName is required.

deleted

Array of object (BulkUpsertEntityRef)

List of deleted entities. It's an internal field to be used by the local replication service.

object

string (uuid)

ID of the entity.

name

string

Name of the entity.

400

JSON error. Check the JSON format.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

401

Token error. Login again.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

500

Unexpected server side error.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

Was this article helpful?