NextGen APIs
NextGen APIs
Breadcrumbs

POST /integration/configurations/identity/r1/users

Http Verb

POST

Url

/integration/configurations/identity/r1/users

Permissions required

View user’s type (foundation.base.userType.view)

Edit user’s type (foundation.base.userType.edit)

View users (foundation.base.user.view)

Edit user (foundation.base.user.edit)

Last Modified Version

r1

Tech Tags

MULTILANGUAGE-FIELDS

Available Async

No

BPMN Diagram (TBD)


Business Logic

This Integration API creates or updates a User.

System verifies Permission Required and starts the elaboration that is organized in steps.

STEP 1 - External System Validation

System takes Input fields and checks their existence in internal configuration.

API Verb: GET

Resource: External Systems

Input: externalSystemCode, active=true

Output: externalSystemId

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

Error Type:

STEP 2 - User Type Validation

System takes Input fields and checks their existence.

API Verb: GET

Resource: User Types

Input: list of [code, isActive=true]

Output: userTypeId

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

Error Type:

STEP 3 - User Validation

System takes Input fields and checks their existence.

API Verb: GET

Resource: Users

Input: username

Output: userId

If System can obtain the Output fields → Update → continue to next step User Update.

If System can’t obtain the Output fields → Creation → continue to step User Creation.

Error Type:

  • Others - see link in Resource

STEP 4 -User Update

System takes Input fields and updates the user.

API Verb: PATCH

Resource: Users

Input: userId, name, surname, type, additionalRoles, theme, language

Output: Response State, userId

If Response State is SUCCESS → elaboration is stopped. See Response payload fields.

If Response State is ERROR → elaboration is stopped. See Response payload fields.

Error Type:

  • Others - see link in Resource

STEP 5 -User Creation

System takes Input fields and creats the user.

API Verb: POST

Resource: Users

Input: username, name, surname, type, additionalRoles, theme, language

Output: Response State, userId

If Response State is SUCCESS → elaboration is stopped. See Response payload fields.

If Response State is ERROR → elaboration is stopped. See Response payload fields.

Error Type:

  • Others - see link in Resource

Path Parameters

As their name suggests, they are included in the URL path of the endpoint.

Not applicable.

Query String Parameters

Start with a ? and includes parameters listed one after the another separated by &.

Not applicable.

Header Parameters

Parameters included in the request headers. Generally, request headers are used to keep authorization parameters.

Default.

Request Body Parameters

Request body parameters are used when clients send data to the API. They are shipped in a JSON Object only in POST, PUT, or PATCH requests.

Field


Description

Mandatory

Constraint

1

externalSystemCode


External System Code

Y

Not Blank

2

username


Username

Y

Not Blank

3

name


Name

N


4

surname


Surname

N


5

email


Email

N


6

typeCode


User type code

Y


7

additionalRoles

(minOccurs=0,

maxOccurs=N)

typeCode

User Additional Type Codes

N


8

language


Language

N


The objects in input could have also the extension object that allows to add additional, customized data to this API. More info here How to use APIs: Custom data via Extension.

Request example

JSON
{
  "extension": {},
  "externalSystemCode": "PGE",
  "username": "john.smith",
  "name": "John",
  "surname": "Smith",
  "email": "john.smith@example.com",
  "typeCode": "TECH",
  "additionalRoles": [
    {
      "typeCode": "DISP"
    }
  ],
  "language": "en"
}

 

Response documentation

Response payload fields

Compliant with RFC Standard https://www.rfc-editor.org/rfc/rfc9457.html

Extension fields:

Field

Description

Note

id

Id of the resource created

Only for SUCCESS

code

Extension member of a Problem Details Object that contains the error code

Only for ERROR

Response example

JSON
{
  "id": 123456
}
JSON
{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "External system string does not exist",
  "instance": "/integration/configurations/r1/characteristics",
  "code": "IA001_001"
}

 

Response error codes