Users
This section has operations to manage end users, groups, and user's investor access
Returns all registered users
POST
https://api.bws.ninja/v1/call
Use this operation to retrieve the registered end users of your account.
Request body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getUsers |
parameters | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
user_identifier | string | no | |
decryption_key | string | no |
Example code
Creates and updates the information of a user
POST
https://api.bws.ninja/v1/call
Use this operation to create users stored in ESG.Credits. Is also used to alter already existing user data.
Request body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | addUser |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
user_identifier | string | yes | |
user_first_name | string | no | |
user_last_name | string | no | |
user_email | string | no | |
user_role | string | no | user or admin |
encryption_key | string | no |
Example code
Removes a user
POST
https://api.bws.ninja/v1/call
Use this operation to remove users from the ESG.Credits data repository.
Request body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | removeUser |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
user_identifier | string | yes |
Example code
Returns all groups
POST
https://api.bws.ninja/v1/call
Use this operation to list available groups for when you are to connect users to groups to control access to certain functionality in your solution.
Request body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getGroups |
Example responses
Example code
Adds a group to a user
POST
https://api.bws.ninja/v1/call
Use this operation to connect users to groups to control access to certain functionality in your solution.
Request body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | addGroupToUser |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
user_identifier | string | yes | |
group | string | yes | Group that the user should belong to |
Example code
Removes a group from a user
POST
https://api.bws.ninja/v1/call
Use this operation to remove connections between groups and users.
Request body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | removeGroupFromUser |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
user_identifier | string | yes | |
group | string | yes | Group that the user no longer should belong to |
Example code
Returns all investors that a user has access to
POST
https://api.bws.ninja/v1/call
Use this operation to retrieve which investors' information a certain user has the right to access.
Request body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getInvestorsOfUser |
parameters | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
user_identifier | string | no | |
decryption_key | string | no |
Example code
Adds an investor to a user
POST
https://api.bws.ninja/v1/call
Use this operation to connect investors to users in order to control users´ access to investor specific information.
Request body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | addInvestorToUser |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
investor_identifier | string | yes | Investor the user should have access to |
user_identifier | string | yes |
Example code
Removes an investor from a user
POST
https://api.bws.ninja/v1/call
Use this operation to remove connections between investors and users.
Request body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | removeInvestorFromUser |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
investor_identifier | string | yes | Investor the user should no longer have acces to |
user_identifier | string | yes |
Example code
Last updated