Post

/service-users

Create a new Service User.

Security

HTTP

Type bearer

Body parameters

Service User object.

Expand All

id

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

labels

object

Labels of the service. Will be used as claim.

property*

string additionalProperties

password

string (password)

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

ExampletSW3!QBv(rj{UuLY

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.0

lockStart

string (date-time)

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

Responses

200

Created Service User.

Expand All

object

id

string (uuid)

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc

name

string

Name of the object.

Exampleobject

notes

string

Notes for the object. Used for documentation purposes.

ExampleThis object has been created for test purposes.

created

string (date-time)

Create date.

updated

string (date-time)

Last update date.

tags

Array of string

Array of tags.

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

string

labels

object

Labels of the service. Will be used as claim.

property*

string additionalProperties

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.0

lockStart

string (date-time)

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

400

JSON error. Check the JSON format.

object

Generic HTTP error.

id

string

Machine readable error code.

message

string

Human readable error details.

401

Token error. Login again.

object

Generic HTTP error.

id

string

Machine readable error code.

message

string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

id

string

Machine readable error code.

message

string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id

string

Machine readable error code.

message

string

Human readable error details.

409

The submitted resource conflicts with another.

object

Generic HTTP error.

id

string

Machine readable error code.

message

string

Human readable error details.

422

Request validation error. Check "errors" array for details.

Expand All

object

Http 422 error for object validation.

id

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

500

Unexpected server side error.

object

Generic HTTP error.

id

string

Machine readable error code.

message

string

Human readable error details.