User¶
User - Get¶
HTTP Request
GET /api/v1/users/{id}
📋 Description: Retrieves detailed information about a specific user identified by their unique ID, enabling effective user management and support within the organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "accountId": 0,
17 "fullName": "string",
18 "firstName": "string",
19 "lastName": "string",
20 "username": "string",
21 "email": "string",
22 "accountName": "string",
23 "profile": "string"
24 }
25}
User - Update¶
HTTP Request
PUT /api/v1/users/{id}
📋 Description: Updates the details of a specified user, allowing for modifications to user information such as name, email, and role, ensuring that user data remains current and accurate within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated user information, including personal details and role assignments, to ensure accurate user management within the organization. |
Body Parameters
1{
2 "id": 0,
3 "accountId": 0,
4 "fullName": "string",
5 "firstName": "string",
6 "lastName": "string",
7 "username": "string",
8 "email": "string",
9 "accountName": "string",
10 "profile": "string"
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "accountId": 0,
17 "fullName": "string",
18 "firstName": "string",
19 "lastName": "string",
20 "username": "string",
21 "email": "string",
22 "accountName": "string",
23 "profile": "string"
24 }
25}
User - Patch¶
HTTP Request
PATCH /api/v1/users/{id}
📋 Description: Updates the user information for the specified user ID, allowing for modifications to attributes such as name, email, and role to ensure accurate and current user data management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the user profile information, including updated attributes such as name, email, and role, to ensure accurate user management. |
Body Parameters
1{}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "accountId": 0,
18 "fullName": "string",
19 "firstName": "string",
20 "lastName": "string",
21 "username": "string",
22 "email": "string",
23 "accountName": "string",
24 "profile": "string"
25 }
26 ]
27}
User - Bulk Update¶
HTTP Request
PUT /api/v1/users/bulk
📋 Description: Updates multiple user records in a single request, allowing for efficient management of user data within the organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of user objects with details such as user IDs, roles, and attributes for bulk updates to user profiles. |
Body Parameters
1[
2 {
3 "id": 0,
4 "accountId": 0,
5 "fullName": "string",
6 "firstName": "string",
7 "lastName": "string",
8 "username": "string",
9 "email": "string",
10 "accountName": "string",
11 "profile": "string"
12 }
13]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "accountId": 0,
18 "fullName": "string",
19 "firstName": "string",
20 "lastName": "string",
21 "username": "string",
22 "email": "string",
23 "accountName": "string",
24 "profile": "string"
25 }
26 ]
27}
User - Find By Usernames¶
HTTP Request
POST /api/v1/users/search/usernames
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[string] |
true |
none |
Body Parameters
1[
2 "string"
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "accountId": 0,
5 "fullName": "string",
6 "firstName": "string",
7 "lastName": "string",
8 "username": "string",
9 "email": "string",
10 "accountName": "string",
11 "profile": "string"
12 }
13]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a user profile, encapsulating essential attributes such as user identification, contact information, and role within the organization to facilitate user management and access control.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» accountId |
integer(int64) |
false |
none |
Unique identifier for the account |
» fullName |
string |
false |
none |
Full name of the resource |
» firstName |
string |
false |
none |
Name of the first |
» lastName |
string |
false |
none |
Name of the last |
» username |
string |
true |
none |
Represents the unique username associated with a user account, essential for authentication and user identification within the system. |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
» accountName |
string |
false |
none |
Name of the account |
» profile |
string |
false |
none |
Represents the user’s profile information, providing essential details for personalized interactions within the application. |
User - Search¶
HTTP Request
POST /api/v1/users/search
📋 Description: Submits a search request to locate users within the system based on specified criteria, enabling efficient user management and streamlined operations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing user search criteria, including filters and sorting options, to facilitate targeted user retrieval within the system. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "uiSelector": "string",
16 "accountIdEqual": 0,
17 "fullNameLike": "string",
18 "firstNameLike": "string",
19 "lastNameLike": "string",
20 "usernameLike": "string",
21 "usernameEqual": "string",
22 "emailLike": "string",
23 "accountNameLike": "string",
24 "profileLike": "string"
25}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "paged": true,
6 "unpaged": true,
7 "pageNumber": 0,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "accountId": 0,
22 "fullName": "string",
23 "firstName": "string",
24 "lastName": "string",
25 "username": "string",
26 "email": "string",
27 "accountName": "string",
28 "profile": "string"
29 }
30 ],
31 "number": 0,
32 "sort": {
33 "unsorted": true,
34 "sorted": true,
35 "empty": true
36 },
37 "first": true,
38 "last": true,
39 "empty": true
40}
User - Register Current User¶
HTTP Request
POST /api/v1/users/register/current
📋 Description: Creates a new user account for the current session, facilitating seamless onboarding and access to platform features.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "accountId": 0,
4 "fullName": "string",
5 "firstName": "string",
6 "lastName": "string",
7 "username": "string",
8 "email": "string",
9 "accountName": "string",
10 "profile": "string"
11}
User - Register User¶
HTTP Request
POST /api/v1/users/register
📋 Description: Registers a new user by submitting their details, facilitating account creation and access to platform features.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the user registration information, including essential details such as username, password, email, and any relevant profile data. |
Body Parameters
1{
2 "id": 0,
3 "accountId": 0,
4 "fullName": "string",
5 "firstName": "string",
6 "lastName": "string",
7 "username": "string",
8 "email": "string",
9 "accountName": "string",
10 "profile": "string"
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "accountId": 0,
4 "fullName": "string",
5 "firstName": "string",
6 "lastName": "string",
7 "username": "string",
8 "email": "string",
9 "accountName": "string",
10 "profile": "string"
11}
User - Get User Details¶
HTTP Request
GET /api/v1/users/details
📋 Description: Fetches detailed information about users within the system, enabling businesses to access essential user data for management and analysis.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "password": "string",
3 "username": "string",
4 "authorities": [
5 {
6 "authority": "string"
7 }
8 ],
9 "accountNonExpired": true,
10 "accountNonLocked": true,
11 "credentialsNonExpired": true,
12 "enabled": true,
13 "id": 0,
14 "accountId": 0,
15 "fullName": "string",
16 "firstName": "string",
17 "lastName": "string",
18 "email": "string",
19 "audience": [
20 "string"
21 ],
22 "realm": "string",
23 "client": "string",
24 "accessTokenExpiry": 0,
25 "accountName": "string",
26 "environmentName": "string",
27 "serviceAccount": true,
28 "tokenIssuer": "string",
29 "profile": "string",
30 "ncpRoles": [
31 "string"
32 ],
33 "coreServiceRoles": [
34 "string"
35 ]
36}
User - Get Current User¶
HTTP Request
GET /api/v1/users/current
📋 Description: Fetches the details of the currently authenticated user, providing essential information for personalized user experiences and account management.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "accountId": 0,
4 "fullName": "string",
5 "firstName": "string",
6 "lastName": "string",
7 "username": "string",
8 "email": "string",
9 "accountName": "string",
10 "profile": "string"
11}
User - Find All¶
HTTP Request
GET /api/v1/users
📋 Description: Retrieves a list of users within the system, enabling organizations to manage user access and roles effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the response should be paginated, allowing users to retrieve user data in manageable segments for improved performance and usability. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "paged": true,
6 "unpaged": true,
7 "pageNumber": 0,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "accountId": 0,
22 "fullName": "string",
23 "firstName": "string",
24 "lastName": "string",
25 "username": "string",
26 "email": "string",
27 "accountName": "string",
28 "profile": "string"
29 }
30 ],
31 "number": 0,
32 "sort": {
33 "unsorted": true,
34 "sorted": true,
35 "empty": true
36 },
37 "first": true,
38 "last": true,
39 "empty": true
40}