User Profile

User Profile - Get

HTTP Request

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

Interactive Demo

📋 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

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "userName": "string",
    "profileDisplayId": "string",
    "profileId": 0,
    "profileName": "string",
    "vendorSecurityProfileDisplayId": "string",
    "vendorSecurityProfileId": 0,
    "vendorSecurityProfileName": "string",
    "firstName": "string",
    "lastName": "string",
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

User Profile - Update

HTTP Request

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

Interactive Demo

📋 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

{
  "id": 0,
  "userName": "string",
  "profileDisplayId": "string",
  "profileId": 0,
  "profileName": "string",
  "vendorSecurityProfileDisplayId": "string",
  "vendorSecurityProfileId": 0,
  "vendorSecurityProfileName": "string",
  "firstName": "string",
  "lastName": "string",
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseUserProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "userName": "string",
    "profileDisplayId": "string",
    "profileId": 0,
    "profileName": "string",
    "vendorSecurityProfileDisplayId": "string",
    "vendorSecurityProfileId": 0,
    "vendorSecurityProfileName": "string",
    "firstName": "string",
    "lastName": "string",
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

User Profile - Delete

HTTP Request

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

Interactive Demo

📋 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

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

User Profile - Create Or Update Bulk

HTTP Request

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

Interactive Demo

📋 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

[
  {
    "id": 0,
    "userName": "string",
    "profileDisplayId": "string",
    "profileId": 0,
    "profileName": "string",
    "vendorSecurityProfileDisplayId": "string",
    "vendorSecurityProfileId": 0,
    "vendorSecurityProfileName": "string",
    "firstName": "string",
    "lastName": "string",
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListUserProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "userName": "string",
      "profileDisplayId": "string",
      "profileId": 0,
      "profileName": "string",
      "vendorSecurityProfileDisplayId": "string",
      "vendorSecurityProfileId": 0,
      "vendorSecurityProfileName": "string",
      "firstName": "string",
      "lastName": "string",
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

User Profile - Create Or Update

HTTP Request

PUT /api/v1/user-profiles/createOrUpdate

Interactive Demo

📋 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

{
  "id": 0,
  "userName": "string",
  "profileDisplayId": "string",
  "profileId": 0,
  "profileName": "string",
  "vendorSecurityProfileDisplayId": "string",
  "vendorSecurityProfileId": 0,
  "vendorSecurityProfileName": "string",
  "firstName": "string",
  "lastName": "string",
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseUserProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "userName": "string",
    "profileDisplayId": "string",
    "profileId": 0,
    "profileName": "string",
    "vendorSecurityProfileDisplayId": "string",
    "vendorSecurityProfileId": 0,
    "vendorSecurityProfileName": "string",
    "firstName": "string",
    "lastName": "string",
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

User Profile - Bulk Update

HTTP Request

PUT /api/v1/user-profiles/bulk

Interactive Demo

📋 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

[
  {
    "id": 0,
    "userName": "string",
    "profileDisplayId": "string",
    "profileId": 0,
    "profileName": "string",
    "vendorSecurityProfileDisplayId": "string",
    "vendorSecurityProfileId": 0,
    "vendorSecurityProfileName": "string",
    "firstName": "string",
    "lastName": "string",
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListUserProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "userName": "string",
      "profileDisplayId": "string",
      "profileId": 0,
      "profileName": "string",
      "vendorSecurityProfileDisplayId": "string",
      "vendorSecurityProfileId": 0,
      "vendorSecurityProfileName": "string",
      "firstName": "string",
      "lastName": "string",
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

User Profile - Bulk Delete

HTTP Request

DELETE /api/v1/user-profiles/bulk

Interactive Demo

📋 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

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

User Profile - Find By Usernames

HTTP Request

POST /api/v1/user-profiles/search/usernames

Interactive Demo

Parameters

Name	In	Type	Required	Description
body	body	array[string]	true	none

Body Parameters

[
  "string"
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "userName": "string",
    "profileDisplayId": "string",
    "profileId": 0,
    "profileName": "string",
    "vendorSecurityProfileDisplayId": "string",
    "vendorSecurityProfileId": 0,
    "vendorSecurityProfileName": "string",
    "firstName": "string",
    "lastName": "string",
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string"
  }
]

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	Unique identifier for the user profile within the financial organization structure, facilitating the management of organizational hierarchy and relationships.
» 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	Optional message to indicate reasons for bypassing standard processes within the financial organization structure.

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

User Profile - Search

HTTP Request

POST /api/v1/user-profiles/search

Interactive Demo

📋 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

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "profileLike": "string",
  "userNameLike": "string",
  "profileDisplayIdLike": "string",
  "profileNameLike": "string",
  "vendorSecurityProfileDisplayIdLike": "string",
  "vendorSecurityProfileNameLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageUserProfileDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "userName": "string",
      "profileDisplayId": "string",
      "profileId": 0,
      "profileName": "string",
      "vendorSecurityProfileDisplayId": "string",
      "vendorSecurityProfileId": 0,
      "vendorSecurityProfileName": "string",
      "firstName": "string",
      "lastName": "string",
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

User Profile - Get User Profile

HTTP Request

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

Interactive Demo

📋 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

{
  "id": 0,
  "userName": "string",
  "profileDisplayId": "string",
  "profileId": 0,
  "profileName": "string",
  "vendorSecurityProfileDisplayId": "string",
  "vendorSecurityProfileId": 0,
  "vendorSecurityProfileName": "string",
  "firstName": "string",
  "lastName": "string",
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string"
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

User Profile - Find All

HTTP Request

GET /api/v1/user-profiles

Interactive Demo

📋 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

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "userName": "string",
      "profileDisplayId": "string",
      "profileId": 0,
      "profileName": "string",
      "vendorSecurityProfileDisplayId": "string",
      "vendorSecurityProfileId": 0,
      "vendorSecurityProfileName": "string",
      "firstName": "string",
      "lastName": "string",
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---