User Profile

Get A Resource By ID

HTTP Request

GET /api/v1/user-profiles/{id}

📋 Description: Retrieves detailed user profile information for a specified financial entity within the organization’s structure, enabling insights into the hierarchy and roles associated with the user.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseUserProfileDto

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    "userName": "string",
17    "profileDisplayId": "string",
18    "profileId": 0,
19    "profileName": "string",
20    "vendorSecurityProfileDisplayId": "string",
21    "vendorSecurityProfileId": 0,
22    "vendorSecurityProfileName": "string",
23    "firstName": "string",
24    "lastName": "string",
25    "rowNumber": 0,
26    "rowIdentifier": "string",
27    "errors": [
28      "string"
29    ],
30    "linkedErrors": [
31      "string"
32    ],
33    "warnings": [
34      "string"
35    ],
36    "remarks": [
37      "string"
38    ],
39    "skipMessage": "string"
40  }
41}

Update A Resource

HTTP Request

PUT /api/v1/user-profiles/{id}

📋 Description: Updates the user profile associated with the specified ID, allowing for modifications to user details within the financial organization structure, thereby ensuring accurate representation of roles and responsibilities within the hierarchy.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

UserProfileDto

true

Request body containing the updated user profile information, including organizational role, hierarchy details, and financial entity associations.

Body Parameters

 1{
 2  "id": 0,
 3  "userName": "string",
 4  "profileDisplayId": "string",
 5  "profileId": 0,
 6  "profileName": "string",
 7  "vendorSecurityProfileDisplayId": "string",
 8  "vendorSecurityProfileId": 0,
 9  "vendorSecurityProfileName": "string",
10  "firstName": "string",
11  "lastName": "string",
12  "rowNumber": 0,
13  "rowIdentifier": "string",
14  "errors": [
15    "string"
16  ],
17  "linkedErrors": [
18    "string"
19  ],
20  "warnings": [
21    "string"
22  ],
23  "remarks": [
24    "string"
25  ],
26  "skipMessage": "string"
27}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseUserProfileDto

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    "userName": "string",
17    "profileDisplayId": "string",
18    "profileId": 0,
19    "profileName": "string",
20    "vendorSecurityProfileDisplayId": "string",
21    "vendorSecurityProfileId": 0,
22    "vendorSecurityProfileName": "string",
23    "firstName": "string",
24    "lastName": "string",
25    "rowNumber": 0,
26    "rowIdentifier": "string",
27    "errors": [
28      "string"
29    ],
30    "linkedErrors": [
31      "string"
32    ],
33    "warnings": [
34      "string"
35    ],
36    "remarks": [
37      "string"
38    ],
39    "skipMessage": "string"
40  }
41}

Delete

HTTP Request

DELETE /api/v1/user-profiles/{id}

📋 Description: Deletes a specified user profile within the financial organization structure, ensuring the integrity of the hierarchy and maintaining accurate records of financial entities.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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}

Bulk Create-Or-Update Resources

HTTP Request

PUT /api/v1/user-profiles/createOrUpdate/bulk

📋 Description: Updates or creates multiple user profiles in bulk within the financial organization structure, ensuring accurate representation of the hierarchy and relationships among financial entities.

Parameters

Name

In

Type

Required

Description

body

body

UserProfileDto

true

Request body containing a bulk array of user profile data, including organizational roles and hierarchy details, essential for maintaining the financial entity’s structure.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "userName": "string",
 5    "profileDisplayId": "string",
 6    "profileId": 0,
 7    "profileName": "string",
 8    "vendorSecurityProfileDisplayId": "string",
 9    "vendorSecurityProfileId": 0,
10    "vendorSecurityProfileName": "string",
11    "firstName": "string",
12    "lastName": "string",
13    "rowNumber": 0,
14    "rowIdentifier": "string",
15    "errors": [
16      "string"
17    ],
18    "linkedErrors": [
19      "string"
20    ],
21    "warnings": [
22      "string"
23    ],
24    "remarks": [
25      "string"
26    ],
27    "skipMessage": "string"
28  }
29]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListUserProfileDto

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      "userName": "string",
18      "profileDisplayId": "string",
19      "profileId": 0,
20      "profileName": "string",
21      "vendorSecurityProfileDisplayId": "string",
22      "vendorSecurityProfileId": 0,
23      "vendorSecurityProfileName": "string",
24      "firstName": "string",
25      "lastName": "string",
26      "rowNumber": 0,
27      "rowIdentifier": "string",
28      "errors": [
29        "string"
30      ],
31      "linkedErrors": [
32        "string"
33      ],
34      "warnings": [
35        "string"
36      ],
37      "remarks": [
38        "string"
39      ],
40      "skipMessage": "string"
41    }
42  ]
43}

Create Or Update A Resource

HTTP Request

PUT /api/v1/user-profiles/createOrUpdate

📋 Description: Creates or updates user profile information within the financial organization structure, ensuring accurate representation of the hierarchy and relationships among financial entities.

Parameters

Name

In

Type

Required

Description

body

body

UserProfileDto

true

Request body containing user profile information, including organizational role, hierarchy details, and financial entity associations for creating or updating user profiles within the financial organization structure.

Body Parameters

 1{
 2  "id": 0,
 3  "userName": "string",
 4  "profileDisplayId": "string",
 5  "profileId": 0,
 6  "profileName": "string",
 7  "vendorSecurityProfileDisplayId": "string",
 8  "vendorSecurityProfileId": 0,
 9  "vendorSecurityProfileName": "string",
10  "firstName": "string",
11  "lastName": "string",
12  "rowNumber": 0,
13  "rowIdentifier": "string",
14  "errors": [
15    "string"
16  ],
17  "linkedErrors": [
18    "string"
19  ],
20  "warnings": [
21    "string"
22  ],
23  "remarks": [
24    "string"
25  ],
26  "skipMessage": "string"
27}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseUserProfileDto

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    "userName": "string",
17    "profileDisplayId": "string",
18    "profileId": 0,
19    "profileName": "string",
20    "vendorSecurityProfileDisplayId": "string",
21    "vendorSecurityProfileId": 0,
22    "vendorSecurityProfileName": "string",
23    "firstName": "string",
24    "lastName": "string",
25    "rowNumber": 0,
26    "rowIdentifier": "string",
27    "errors": [
28      "string"
29    ],
30    "linkedErrors": [
31      "string"
32    ],
33    "warnings": [
34      "string"
35    ],
36    "remarks": [
37      "string"
38    ],
39    "skipMessage": "string"
40  }
41}

Bulk-Update Resources

HTTP Request

PUT /api/v1/user-profiles/bulk

📋 Description: Updates multiple user profiles within the financial organization structure, allowing for efficient management of user data in alignment with the entity’s hierarchy and operational needs.

Parameters

Name

In

Type

Required

Description

body

body

UserProfileDto

true

Request body containing an array of user profile objects, each representing the hierarchical structure and organizational details of financial entities within the organization.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "userName": "string",
 5    "profileDisplayId": "string",
 6    "profileId": 0,
 7    "profileName": "string",
 8    "vendorSecurityProfileDisplayId": "string",
 9    "vendorSecurityProfileId": 0,
10    "vendorSecurityProfileName": "string",
11    "firstName": "string",
12    "lastName": "string",
13    "rowNumber": 0,
14    "rowIdentifier": "string",
15    "errors": [
16      "string"
17    ],
18    "linkedErrors": [
19      "string"
20    ],
21    "warnings": [
22      "string"
23    ],
24    "remarks": [
25      "string"
26    ],
27    "skipMessage": "string"
28  }
29]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListUserProfileDto

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      "userName": "string",
18      "profileDisplayId": "string",
19      "profileId": 0,
20      "profileName": "string",
21      "vendorSecurityProfileDisplayId": "string",
22      "vendorSecurityProfileId": 0,
23      "vendorSecurityProfileName": "string",
24      "firstName": "string",
25      "lastName": "string",
26      "rowNumber": 0,
27      "rowIdentifier": "string",
28      "errors": [
29        "string"
30      ],
31      "linkedErrors": [
32        "string"
33      ],
34      "warnings": [
35        "string"
36      ],
37      "remarks": [
38        "string"
39      ],
40      "skipMessage": "string"
41    }
42  ]
43}

Bulk Delete

HTTP Request

DELETE /api/v1/user-profiles/bulk

📋 Description: Deletes multiple user profiles within the financial organization structure, allowing for efficient management of user data in alignment with organizational hierarchy and compliance requirements.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing an array of user profile identifiers to facilitate the bulk deletion of user profiles within the financial organization structure.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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}

Find By Usernames

HTTP Request

POST /api/v1/user-profiles/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

OK

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "userName": "string",
 5    "profileDisplayId": "string",
 6    "profileId": 0,
 7    "profileName": "string",
 8    "vendorSecurityProfileDisplayId": "string",
 9    "vendorSecurityProfileId": 0,
10    "vendorSecurityProfileName": "string",
11    "firstName": "string",
12    "lastName": "string",
13    "rowNumber": 0,
14    "rowIdentifier": "string",
15    "errors": [
16      "string"
17    ],
18    "linkedErrors": [
19      "string"
20    ],
21    "warnings": [
22      "string"
23    ],
24    "remarks": [
25      "string"
26    ],
27    "skipMessage": "string"
28  }
29]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[UserProfileDto]

false

none

[Data transfer object representing a user’s profile within the financial organization structure, encapsulating essential details related to the user’s role, hierarchy, and associated financial entity.]

» id

integer(int64)

false

none

Unique identifier for the resource

» userName

string

false

none

Name of the user

» profileDisplayId

string

false

none

Unique identifier for the profile display

» profileId

integer(int64)

false

none

Unique identifier for the profile

» profileName

string

false

none

Name of the profile

» vendorSecurityProfileDisplayId

string

false

none

Unique identifier for the vendor security profile display

» vendorSecurityProfileId

integer(int64)

false

none

Unique identifier for the vendor security profile

» vendorSecurityProfileName

string

false

none

Name of the vendor security profile

» firstName

string

false

none

none

» lastName

string

false

none

none

» rowNumber

integer(int32)

true

none

Numeric value representing rowNumber

» rowIdentifier

string

false

none

Text value for rowIdentifier in UserProfileDto

» errors

[string]

false

none

List of errors items

» linkedErrors

[string]

false

none

List of linkedErrors items

» warnings

[string]

false

none

List of warnings items

» remarks

[string]

false

none

List of remarks items

» skipMessage

string

false

none

Text value for skipMessage in UserProfileDto

Search Resources

HTTP Request

POST /api/v1/user-profiles/search

📋 Description: Submits a search request for user profiles within the financial organization structure, enabling users to efficiently locate and analyze hierarchical relationships among financial entities.

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

UserProfileDtoFilter

false

Request body containing search criteria for user profiles within the financial organization structure, including parameters for organization hierarchy and entity classification.

Default Values

Parameter

Default

Type

page

0

query

size

100

query

sort

["createdAt,ASC"]

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  "profileLike": "string",
16  "userNameLike": "string",
17  "profileDisplayIdLike": "string",
18  "profileNameLike": "string",
19  "vendorSecurityProfileDisplayIdLike": "string",
20  "vendorSecurityProfileNameLike": "string"
21}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageUserProfileDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 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      "userName": "string",
22      "profileDisplayId": "string",
23      "profileId": 0,
24      "profileName": "string",
25      "vendorSecurityProfileDisplayId": "string",
26      "vendorSecurityProfileId": 0,
27      "vendorSecurityProfileName": "string",
28      "firstName": "string",
29      "lastName": "string",
30      "rowNumber": 0,
31      "rowIdentifier": "string",
32      "errors": [
33        "string"
34      ],
35      "linkedErrors": [
36        "string"
37      ],
38      "warnings": [
39        "string"
40      ],
41      "remarks": [
42        "string"
43      ],
44      "skipMessage": "string"
45    }
46  ],
47  "number": 0,
48  "sort": {
49    "unsorted": true,
50    "sorted": true,
51    "empty": true
52  },
53  "first": true,
54  "last": true,
55  "empty": true
56}

Get User Profile

HTTP Request

GET /api/v1/user-profiles/username/{userName}

📋 Description: Retrieves the user profile associated with the specified username within the financial organization structure, providing insights into the hierarchy and roles of the user within the entity.

Parameters

Name

In

Type

Required

Description

userName

path

string

true

Name of the user

Responses

Status

Meaning

Description

Schema

200

OK

OK

UserProfileDto

Example Responses

 1{
 2  "id": 0,
 3  "userName": "string",
 4  "profileDisplayId": "string",
 5  "profileId": 0,
 6  "profileName": "string",
 7  "vendorSecurityProfileDisplayId": "string",
 8  "vendorSecurityProfileId": 0,
 9  "vendorSecurityProfileName": "string",
10  "firstName": "string",
11  "lastName": "string",
12  "rowNumber": 0,
13  "rowIdentifier": "string",
14  "errors": [
15    "string"
16  ],
17  "linkedErrors": [
18    "string"
19  ],
20  "warnings": [
21    "string"
22  ],
23  "remarks": [
24    "string"
25  ],
26  "skipMessage": "string"
27}

List All Resources

HTTP Request

GET /api/v1/user-profiles

📋 Description: Retrieves user profiles within the financial organization structure, providing insights into the hierarchy and roles of individuals associated with the financial entity.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the response should be paginated, allowing users to retrieve user profile data in manageable segments within the financial organization structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageUserProfileDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 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      "userName": "string",
22      "profileDisplayId": "string",
23      "profileId": 0,
24      "profileName": "string",
25      "vendorSecurityProfileDisplayId": "string",
26      "vendorSecurityProfileId": 0,
27      "vendorSecurityProfileName": "string",
28      "firstName": "string",
29      "lastName": "string",
30      "rowNumber": 0,
31      "rowIdentifier": "string",
32      "errors": [
33        "string"
34      ],
35      "linkedErrors": [
36        "string"
37      ],
38      "warnings": [
39        "string"
40      ],
41      "remarks": [
42        "string"
43      ],
44      "skipMessage": "string"
45    }
46  ],
47  "number": 0,
48  "sort": {
49    "unsorted": true,
50    "sorted": true,
51    "empty": true
52  },
53  "first": true,
54  "last": true,
55  "empty": true
56}