Swagger UI

User Management

 4.2.0-RC.1.RELEASE

OAS 2.0

[ Base URL: localhost:2002/users ]

IMPORTANT - The Try it Out button will generate curl requests for examples, but executing them through the UI will not work as authentication has not been set up. This page is for documentation only.

the developer - Website

Send email to the developer

Mozilla Public License V2.0

Schemes

users
Everything concerning users

Fetch a list of all existing users, with pagination and filter options

Parameters

No parameters

Responses

Response content type

Code	Description
200	OK `[ { "login": "jcleese", "firstName": "John", "lastName": "Cleese", "groups": [ "MONTY", "WANDA" ], "entities": [ "ENITY1", "ENTITY2" ] }, { "login": "gchapman", "firstName": "Graham", "lastName": "Chapman", "groups": [ "MONTY" ], "entities": [ "ENITY1" ] } ]`
401	Authentication required
403	Authenticated users who are not admins can only access their own data

Create a new user. If the user already exists, then an update of the user will be made. Be careful, login must be minimum 2 characters and must only contain lowercase letters, _, -, . or digits.

Parameters

Name	Description
user object (body)	User to be created `{ "login": "jcleese", "firstName": "John", "lastName": "Cleese", "groups": [ "MONTY", "WANDA" ], "entities": [ "ENTITY1", "ENTITY2" ] }` Parameter content type

Responses

Response content type

Code	Description
200	OK (user already existed so it was updated) `{ "login": "jcleese", "firstName": "John", "lastName": "Cleese", "groups": [ "MONTY", "WANDA" ], "entities": [ "ENTITY1", "ENTITY2" ] }`
201	Created `{ "login": "jcleese", "firstName": "John", "lastName": "Cleese", "groups": [ "MONTY", "WANDA" ], "entities": [ "ENTITY1", "ENTITY2" ] }`
400	Bad request
401	Authentication required
403	Authenticated users who are not admins can only create their own data

Fetch an existing user from their login

Parameters

Name	Description
login * string (path)	user login

Responses

Response content type

Code	Description
200	OK `{ "login": "jcleese", "firstName": "John", "lastName": "Cleese", "groups": [ "MONTY", "WANDA" ], "entities": [ "ENTITY1", "ENTITY2" ] }`
401	Authentication required
403	Authenticated users who are not admins can only access their own data
404	Required user not found

Update existing user

Parameters

Name	Description
login * string (path)	user login (should match login in request body)
user object (body)	User to be updated (login should match path parameter) `{ "login": "jcleese", "firstName": "John", "lastName": "Cleese", "groups": [ "MONTY", "WANDA" ], "entities": [ "ENTITY1", "ENTITY2" ] }` Parameter content type

Responses

Response content type

Code	Description
200	OK `{ "login": "jcleese", "firstName": "John", "lastName": "Cleese", "groups": [ "MONTY", "WANDA" ], "entities": [ "ENTITY1", "ENTITY2" ] }`
201	Created `{ "login": "jcleese", "firstName": "John", "lastName": "Cleese", "groups": [ "MONTY", "WANDA" ], "entities": [ "ENTITY1", "ENTITY2" ] }`
400	Bad request (body doesn't match login path parameter)
401	Authentication required
403	Authenticated users who are not admins can only update their own data

Remove a user

Parameters

Name	Description
login * string (path)	User login

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required user not found

Fetch existing user's settings from their login

Parameters

Name	Description
login * string (path)	user login

Responses

Response content type

Code	Description
200	OK `{ "login": "jcleese", "description": "once played Sir Lancelot", "locale": "en-GB" }`
401	Authentication required
403	Authenticated users who are not admins can only access their own data
404	Required user not found

Update existing user settiogs

Parameters

Name	Description
login * string (path)	user login (should match login in request body)
userSettings object (body)	User settings to be updated (login should match path parameter) `{ "login": "jcleese", "description": "once played Sir Lancelot", "locale": "en-GB" }` Parameter content type

Responses

Response content type

Code	Description
200	OK `{ "login": "jcleese", "description": "once played Sir Lancelot", "locale": "en-GB" }`
201	Created `{ "login": "jcleese", "description": "once played Sir Lancelot", "locale": "en-GB" }`
400	Bad request (body doesn't match login path parameter)
401	Authentication required
403	Authenticated users who are not admins can only update their own data
404	User not found

Patch existing user settions

Parameters

Name	Description
login * string (path)	user login
userSettings object (body)	User settings to be updated `{ "login": "jcleese", "description": "once played Sir Lancelot", "locale": "en-GB" }` Parameter content type

Responses

Response content type

Code	Description
200	OK `{ "login": "jcleese", "description": "once played Sir Lancelot", "locale": "en-GB" }`
401	Authentication required
403	Authenticated users who are not admins can only update their own data
404	User not found

synchronize user data with JWT token

Parameters

No parameters

Responses

Response content type

Code	Description
200	OK `{ "login": "jcleese", "firstName": "John", "lastName": "Cleese", "groups": [ "MONTY", "WANDA" ], "entities": [ "ENTITY1", "ENTITY2" ] }`
201	Created `{ "login": "jcleese", "firstName": "John", "lastName": "Cleese", "groups": [ "MONTY", "WANDA" ], "entities": [ "ENTITY1", "ENTITY2" ] }`
401	Authentication required

Update list of group users, users not included in given list are removed from group

Parameters

Name	Description
id * string (path)	Group id
users array[string] (body)	Array of user ids representing exactly the intended list of group users after update `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

ONLY add users to group (no deletion)

Parameters

Name	Description
id * string (path)	Group id
users array[string] (body)	Array of user ids to be added to group `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

remove all users from group

Parameters

Name	Description
id * string (path)	Group id

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

ONLY remove user from group (no addition)

Parameters

Name	Description
id * string (path)	Group id
login * string (path)	User login

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

Update list of entity users, users not included in given list are removed from entity.

Parameters

Name	Description
id * string (path)	Entity id
users array[string] (body)	Array of user logins representing exactly the intended list of entity users after update `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required entity not found

ONLY add users to entity (no deletion).

Parameters

Name	Description
id * string (path)	Entity id
users array[string] (body)	Array of user logins to be added to entity `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required entity not found

remove all users from entity.

Parameters

Name	Description
id * string (path)	Entity id

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required entity not found

ONLY remove user from entity (no addition).

Parameters

Name	Description
id * string (path)	Entity id
login * string (path)	User login

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required entity not found

Fetch existing user's perimeters from their login.

Parameters

Name	Description
login * string (path)	user login

Responses

Response content type

Code	Description
200	OK `[ { "id": "Process1", "process": "Process1", "stateRights": [ { "state": "State1", "right": "Receive" }, { "state": "State2", "rights": "ReceiveAndWrite" } ] }, { "id": "Process2", "process": "Process2", "stateRights": [ { "state": "State1", "right": "ReceiveAndWrite" }, { "state": "State2", "rights": "Write" } ] } ]`
401	Authentication required
403	Authenticated users who are not admins can only access their own data
404	Required user not found

Get information about the user connected and his perimeters.

Parameters

No parameters

Responses

Response content type

Code Description

200

Code	Description
200	OK `{ "userData": { "login": "jcleese", "firstName": "John", "lastName": "Cleese", "groups": [ "MONTY", "WANDA" ], "entities": [ "ENITY1", "ENTITY2" ] }, "computedPerimeters": [ { "process": "Process1", "state": "State1", "rights": "Receive" }, { "process": "Process1", "state": "State2", "rights": "ReceiveAndWrite" } ] }`
401	Authentication required

{
  "userData": {
    "login": "jcleese",
    "firstName": "John",
    "lastName": "Cleese",
    "groups": [
      "MONTY",
      "WANDA"
    ],
    "entities": [
      "ENITY1",
      "ENTITY2"
    ]
  },
  "computedPerimeters": [
    {
      "process": "Process1",
      "state": "State1",
      "rights": "Receive"
    },
    {
      "process": "Process1",
      "state": "State2",
      "rights": "ReceiveAndWrite"
    }
  ]
}

401

Authentication required

Get information about a user and his perimeters.

Parameters

Name	Description
login * string (path)	user login

Responses

Response content type

Code Description

200

Code	Description
200	OK `{ "userData": { "login": "jcleese", "firstName": "John", "lastName": "Cleese", "groups": [ "MONTY", "WANDA" ], "entities": [ "ENITY1", "ENTITY2" ] }, "computedPerimeters": [ { "process": "Process1", "state": "State1", "rights": "Receive" }, { "process": "Process1", "state": "State2", "rights": "ReceiveAndWrite" } ] }`
401	Authentication required

{
  "userData": {
    "login": "jcleese",
    "firstName": "John",
    "lastName": "Cleese",
    "groups": [
      "MONTY",
      "WANDA"
    ],
    "entities": [
      "ENITY1",
      "ENTITY2"
    ]
  },
  "computedPerimeters": [
    {
      "process": "Process1",
      "state": "State1",
      "rights": "Receive"
    },
    {
      "process": "Process1",
      "state": "State2",
      "rights": "ReceiveAndWrite"
    }
  ]
}

401

Authentication required

groups
Everything concerning groups

Fetch a list of all existing groups, with pagination and filter options

Parameters

No parameters

Responses

Response content type

Code	Description
200	OK `[ { "id": "WANDA", "name": "Wanda", "description": "They were not as successful in Fierce Creatures" }, { "id": "MARXB", "name": "Marx Brothers", "description": "Chico, Groucho and Harpo, forget about Zeppo and Gummo" } ]`
401	Authentication required
403	Forbidden - ADMIN role necessary

Create a new group of users

Parameters

Name	Description
group object (body)	Group to be created `{ "id": "WANDA", "name": "Wanda", "description": "They were not as successful in Fierce Creatures." }` Parameter content type

Responses

Response content type

Code	Description
200	Updated `{ "id": "WANDA", "name": "Wanda", "description": "They were not as successful in Fierce Creatures." }`
201	Created `{ "id": "WANDA", "name": "Wanda", "description": "They were not as successful in Fierce Creatures." }`
400	Bad request (duplicate key)
401	Authentication required
403	Forbidden - ADMIN role necessary

Update existing group

Parameters

Name	Description
id * string (path)	Id of group to be updated (should match "id group" in request body)
group object (body)	Updated group data (should match "id group" path parameter) `{ "id": "WANDA", "name": "Wanda", "description": "They were not as successful in Fierce Creatures." }` Parameter content type

Responses

Response content type

Code	Description
200	Updated `{ "id": "WANDA", "name": "Wanda", "description": "They were not as successful in Fierce Creatures." }`
201	Created `{ "id": "WANDA", "name": "Wanda", "description": "They were not as successful in Fierce Creatures." }`
400	Bad request (body doesn't match "id group" path parameter)
401	Authentication required
403	Forbidden - ADMIN role necessary

Fetch an existing group of users

Parameters

Name	Description
id * string (path)	Group id

Responses

Response content type

Code	Description
200	OK `{ "id": "WANDA", "name": "Wanda", "description": "They were not as successful in Fierce Creatures." }`
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

Remove a group

Parameters

Name	Description
id * string (path)	Group id

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

Update list of group users, users not included in given list are removed from group

Parameters

Name	Description
id * string (path)	Group id
users array[string] (body)	Array of user ids representing exactly the intended list of group users after update `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

ONLY add users to group (no deletion)

Parameters

Name	Description
id * string (path)	Group id
users array[string] (body)	Array of user ids to be added to group `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

remove all users from group

Parameters

Name	Description
id * string (path)	Group id

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

ONLY remove user from group (no addition)

Parameters

Name	Description
id * string (path)	Group id
login * string (path)	User login

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

Update list of groups that have this perimeter, groups not included in given list lose this perimeter.

Parameters

Name	Description
id * string (path)	Perimeter id
groups array[string] (body)	Array of group id representing exactly the intended list of groups that must have this perimeter after update `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required perimeter not found

ONLY add groups to perimeter (no deletion).

Parameters

Name	Description
id * string (path)	Perimeter id
groups array[string] (body)	Array of group id to be added to perimeter `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required perimeter not found

remove all groups from perimeter.

Parameters

Name	Description
id * string (path)	Perimeter id

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required perimeter not found

ONLY remove group from perimeter (no addition).

Parameters

Name	Description
idPerimeter * string (path)	Perimeter id
idGroup * string (path)	Group id

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required perimeter not found

Fetch existing group's perimeters from their id.

Parameters

Name	Description
id * string (path)	group id

Responses

Response content type

Code	Description
200	OK `[ { "id": "Process1", "process": "Process1", "stateRights": [ { "state": "State1", "right": "Receive" }, { "state": "State2", "rights": "ReceiveAndWrite" } ] }, { "id": "Process2", "process": "Process2", "stateRights": [ { "state": "State1", "right": "ReceiveAndWrite" }, { "state": "State2", "rights": "Write" } ] } ]`
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

Update list of perimeters for group, perimeters not included in given list are no longer linked to the group.

Parameters

Name	Description
id * string (path)	Group id
perimeters array[string] (body)	Array of perimeter id representing exactly the intended list of perimeters that must be linked to the group after update `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

ONLY add perimeters to group (no deletion).

Parameters

Name	Description
id * string (path)	Group id
perimeters array[string] (body)	Array of perimeter id to be added to group `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

entities
Everything concerning entities

Fetch a list of all existing entities, with pagination and filter options.

Parameters

No parameters

Responses

Response content type

Code	Description
200	OK `[ { "id": "ENTITY1", "name": "Control Room 1", "description": "Control Room 1" }, { "id": "ENTITY2", "name": "Control Room 2", "description": "Control Room 2" } ]`
401	Authentication required

Create a new entity of users.

Parameters

Name	Description
entity object (body)	Entity to be created `{ "id": "ENTITY1", "name": "Control Room 1", "description": "Control Room 1" }` Parameter content type

Responses

Response content type

Code	Description
200	Updated `{ "id": "ENTITY1", "name": "Control Room 1", "description": "Control Room 1" }`
201	Created `{ "id": "ENTITY1", "name": "Control Room 1", "description": "Control Room 1" }`
400	Bad request (duplicate key)
401	Authentication required
403	Forbidden - ADMIN role necessary

Update existing entity.

Parameters

Name	Description
id * string (path)	Id of entity to be updated (should match id in request body)
entity object (body)	Updated entity data (should match id path parameter) `{ "id": "ENTITY1", "name": "Control Room 1", "description": "Control Room 1" }` Parameter content type

Responses

Response content type

Code	Description
200	Updated `{ "id": "ENTITY1", "name": "Control Room 1", "description": "Control Room 1" }`
201	Created `{ "id": "ENTITY1", "name": "Control Room 1", "description": "Control Room 1" }`
400	Bad request (body doesn't match id path parameter)
401	Authentication required
403	Forbidden - ADMIN role necessary

Fetch an existing entity of users.

Parameters

Name	Description
id * string (path)	Entity id

Responses

Response content type

Code	Description
200	OK `{ "id": "ENTITY1", "name": "Control Room 1", "description": "Control Room 1" }`
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required entity not found

Remove an entity

Parameters

Name	Description
id * string (path)	Entity id

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required entity not found

Update list of entity users, users not included in given list are removed from entity.

Parameters

Name	Description
id * string (path)	Entity id
users array[string] (body)	Array of user logins representing exactly the intended list of entity users after update `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required entity not found

ONLY add users to entity (no deletion).

Parameters

Name	Description
id * string (path)	Entity id
users array[string] (body)	Array of user logins to be added to entity `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required entity not found

remove all users from entity.

Parameters

Name	Description
id * string (path)	Entity id

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required entity not found

ONLY remove user from entity (no addition).

Parameters

Name	Description
id * string (path)	Entity id
login * string (path)	User login

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required entity not found

perimeters
Everything concerning perimeters

Fetch a list of all existing perimeters.

Parameters

No parameters

Responses

Response content type

Code	Description
200	OK `[ { "id": "Process1", "process": "Process1", "stateRights": [ { "state": "State1", "right": "Receive" }, { "state": "State2", "rights": "ReceiveAndWrite" } ] }, { "id": "Process2", "process": "Process2", "stateRights": [ { "state": "State1", "right": "ReceiveAndWrite" }, { "state": "State2", "rights": "Write" } ] } ]`
401	Authentication required
403	Forbidden - ADMIN role necessary

Create a new perimeter.

Parameters

Name	Description
perimeter object (body)	Perimeter to be created `{ "id": "Process1Perimeter1", "process": "Process1", "stateRights": [ { "state": "state1", "right": "Receive" }, { "state": "state2", "right": "ReceiveAndWrite" } ] }` Parameter content type

Responses

Response content type

Code	Description
201	Created `{ "id": "Process1Perimeter1", "process": "Process1", "stateRights": [ { "state": "state1", "right": "Receive" }, { "state": "state2", "right": "ReceiveAndWrite" } ] }`
400	Bad request (duplicate key)
401	Authentication required
403	Forbidden - ADMIN role necessary

Update existing perimeter.

Parameters

Name	Description
id * string (path)	Id of perimeter to be updated (should match id in request body)
perimeter object (body)	Updated perimeter data (should match id path parameter) `{ "id": "Process1Perimeter1", "process": "Process1", "stateRights": [ { "state": "state1", "right": "Receive" }, { "state": "state2", "right": "ReceiveAndWrite" } ] }` Parameter content type

Responses

Response content type

Code	Description
200	Updated `{ "id": "Process1Perimeter1", "process": "Process1", "stateRights": [ { "state": "state1", "right": "Receive" }, { "state": "state2", "right": "ReceiveAndWrite" } ] }`
201	Created `{ "id": "Process1Perimeter1", "process": "Process1", "stateRights": [ { "state": "state1", "right": "Receive" }, { "state": "state2", "right": "ReceiveAndWrite" } ] }`
400	Bad request (body doesn't match id path parameter)
401	Authentication required
403	Forbidden - ADMIN role necessary

Fetch an existing perimeter.

Parameters

Name	Description
id * string (path)	Perimeter id

Responses

Response content type

Code	Description
200	OK `{ "id": "Process1Perimeter1", "process": "Process1", "stateRights": [ { "state": "state1", "right": "Receive" }, { "state": "state2", "right": "ReceiveAndWrite" } ] }`
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required perimeter not found

Remove a perimeter

Parameters

Name	Description
id * string (path)	Perimeter id

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required perimeter not found

Update list of groups that have this perimeter, groups not included in given list lose this perimeter.

Parameters

Name	Description
id * string (path)	Perimeter id
groups array[string] (body)	Array of group id representing exactly the intended list of groups that must have this perimeter after update `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required perimeter not found

ONLY add groups to perimeter (no deletion).

Parameters

Name	Description
id * string (path)	Perimeter id
groups array[string] (body)	Array of group id to be added to perimeter `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required perimeter not found

remove all groups from perimeter.

Parameters

Name	Description
id * string (path)	Perimeter id

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required perimeter not found

ONLY remove group from perimeter (no addition).

Parameters

Name	Description
idPerimeter * string (path)	Perimeter id
idGroup * string (path)	Group id

Responses

Response content type

Code	Description
200	Deleted
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required perimeter not found

Fetch existing group's perimeters from their id.

Parameters

Name	Description
id * string (path)	group id

Responses

Response content type

Code	Description
200	OK `[ { "id": "Process1", "process": "Process1", "stateRights": [ { "state": "State1", "right": "Receive" }, { "state": "State2", "rights": "ReceiveAndWrite" } ] }, { "id": "Process2", "process": "Process2", "stateRights": [ { "state": "State1", "right": "ReceiveAndWrite" }, { "state": "State2", "rights": "Write" } ] } ]`
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

Update list of perimeters for group, perimeters not included in given list are no longer linked to the group.

Parameters

Name	Description
id * string (path)	Group id
perimeters array[string] (body)	Array of perimeter id representing exactly the intended list of perimeters that must be linked to the group after update `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

ONLY add perimeters to group (no deletion).

Parameters

Name	Description
id * string (path)	Group id
perimeters array[string] (body)	Array of perimeter id to be added to group `[ "string" ]` Parameter content type

Responses

Response content type

Code	Description
200	Updated
400	Bad request
401	Authentication required
403	Forbidden - ADMIN role necessary
404	Required group not found

Fetch existing user's perimeters from their login.

Parameters

Name	Description
login * string (path)	user login

Responses

Response content type

Code	Description
200	OK `[ { "id": "Process1", "process": "Process1", "stateRights": [ { "state": "State1", "right": "Receive" }, { "state": "State2", "rights": "ReceiveAndWrite" } ] }, { "id": "Process2", "process": "Process2", "stateRights": [ { "state": "State1", "right": "ReceiveAndWrite" }, { "state": "State2", "rights": "Write" } ] } ]`
401	Authentication required
403	Authenticated users who are not admins can only access their own data
404	Required user not found

user actions logs

Get the list the user actions.

Parameters

Name	Description
login array[string] (query)	usernames of the users who performed the actions
action array[string] (query)	types of actions performed
dateFrom number (query)	Date as number of milliseconds since epoch. If this query parameter is set, only cards with a publishDate that is after this date will be returned. This parameter should be unique or a BAD REQUEST will be returned.
dateTo number (query)	Date as number of milliseconds since epoch. If this query parameter is set, only cards with a publishDate that is before this date will be returned. This parameter should be unique or a BAD REQUEST will be returned.
page number (query)	Page number of the page to retrieve. If "size" is set but "page" isn't, the default page returned will be the first (number 0). If "page" is set but "size" isn't, the default size will be 10 items. If neither "page" nor "size" is set, the response will contain a single page containing all matching cards. This parameter should be unique or a BAD REQUEST will be returned.
size number (query)	Size of the results pages. If "size" is set but "page" isn't, the default page returned will be the first (number 0). If "page" is set but "size" isn't, the default size will be 10 items. If neither "page" nor "size" is set, the response will contain a single page containing all matching cards. This parameter should be unique or a BAD REQUEST will be returned.

Responses

Response content type

Code Description

200

{
  "content": [
    {
      "login": "string",
      "entities": [
        "string"
      ],
      "action": "string",
      "cardUid": "string",
      "comment": "string"
    }
  ],
  "first": true,
  "last": true,
  "totalPages": 0,
  "totalElements": 0,
  "numberOfElements": 0,
  "size": 0,
  "number": 0
}

User Management 4.2.0-RC.1.RELEASE OAS 2.0

usersEverything concerning users

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

groupsEverything concerning groups

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

entitiesEverything concerning entities

Parameters

Responses

Parameters

Responses

User Management
4.2.0-RC.1.RELEASE
OAS 2.0

users
Everything concerning users

groups
Everything concerning groups

entities
Everything concerning entities

perimeters
Everything concerning perimeters