Users

This section has operations to manage end users, groups, and user's investor access

getUsers

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

200: OK Successful operation (example)

[
    {
        "user_id": 25,
        "user_identifier": "iuwd7q8dbtqd",
        "user_first_name": "John",
        "user_last_name": "Smith",
        "user_role": "user",
        "user_email": "[e-mail]",
        "user_groups": [
            {
                "group_id": 1,
                "group": "bankers"
            },
            {
                "group_id": 2,
                "group": "investors"
            }
        ]
    },
    {
        "user_id": 26,
        "user_identifier": "76387bdt6qt",
        "user_first_name": "Mary",
        "user_last_name": "Smith",
        "user_role": "user",
        "user_email": "[e-mail]",
        "user_groups": [
            {
                "group_id": 1,
                "group": "bankers"
            }
        ]
    }
]

400: Bad Request Error message (example)

{
    "message": "No users are registered."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
user_identifier	string	no
decryption_key	string	no

Example code

curl

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "getUsers",
    "parameters": {
        "user_identifier": "9c809eb86ee6",
        "decryption_key": "64dh_WtAnyMK-f3dtb5-ESweLX80P__a3FjXsgg3Y="
        }
    }

addUser

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

200: OK Successful operation

{
    "message": "User successfully added."
}

400: Bad Request Error message (example)

{
    "message": "User identifier is missing."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

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

curl

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "addUser",
    "parameters": {
        "user_identifier": "9c809eb86ee6",
        "user_first_name": "John",
        "user_last_name": "Smith",
        "user_email": "[e-mail]",
        "user_role": "user",
        "encryption_key": "64dh_WtAnyMK-f3dtb5-ESweLX80P__a3FjXsgg3Y="
        }
    }

removeUser

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

200: OK Successful operation

{
    "message": "User was successfully removed."
}

400: Bad Request Error message (example)

{
    "message": "No such user."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
user_identifier	string	yes

Example code

curl

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "removeUser",
    "parameters": {
        "user_identifier": "9c809eb86ee6"
        }
    }

getGroups

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

200: OK Successful operation

[
    {
        "id": 1,
        "group": "bankers"
    },
    {
        "id": 2,
        "group": "investors"
    },
    {
        "id": 3,
        "group": "capitalists"
    },
    {
        "id": 4,
        "group": "issuers"
    },
    {
        "id": 5,
        "group": "agents"
    },
    {
        "id": 6,
        "group": "exchanges"
    },
    {
        "id": 7,
        "group": "regulators"
    }
]

400: Bad Request Error message (example)

{
    "message": "Please submit client identifier."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Example code

curl

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "getGroups",
    }

addGroupToUser

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

200: OK Successful operation

{
    "message": "Group was succesfully added."
}

400: Bad Request Error message (example)

{
    "message": "Group is already connected to user."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
user_identifier	string	yes
group	string	yes	Group that the user should belong to

Example code

curl

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "addGroupToUser",
    "parameters": {
        "user_identifier": "9c809eb86ee6",
        "group": "bankers"
        }
    }

removeGroupFromUser

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

200: OK Successful operation

{
    "message": "Group was succesfully removed."
}

400: Bad Request Error message (example)

{
    "message": "No such user."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

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

curl

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "removeGroupFromUser",
    "parameters": {
        "user_identifier": "9c809eb86ee6",
        "group": "bankers"
        }
    }

getInvestorsOfUser

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

200: OK Successful operation (example)

[
    {
        "user_id": 25,
        "user_identifier": "[e-mail]",
        "investors": [
            {
                "investor_id": 19,
                "investor_identifier": "3a65rvgwv856",
                "investor_name": "Ben Watson"
            },
            {
                "investor_id": 19,
                "investor_identifier": "3b6f3waf09886",
                "investor_name": "Bill Jones"
            }
        ]
    },
    {
        "user_id": 26,
        "user_identifier": "[e-mail]",
        "investors": [
            {
                "investor_id": 19,
                "investor_identifier": "3b6f3waf09886",
                "investor_name": "Bill Jones"
            }
        ]
    }
]

400: Bad Request Error message (example)

{
    "message": "No users are registered."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
user_identifier	string	no
decryption_key	string	no

Example code

curl

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "getInvestorsOfUser",
    "parameters": {
        "user_identifier": "9c809eb86ee6",
        "decryption_key": "64dh_WtAnyMK-f3dtb5-ESweLX80P__a3FjXsgg3Y="
        }
    }

addInvestorToUser

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

200: OK Successful operation

{
    "message": "Investor was succesfully added."
}

400: Bad Request Error message (example)

{
    "message": "Investor is already connected to user."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
investor_identifier	string	yes	Investor the user should have access to
user_identifier	string	yes

Example code

curl

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "addInvestorToUser",
    "parameters": {
        "investor_identifier": "650126-1234",
        "user_identifier": "9c809eb86ee6"
        }
    }

removeInvestorFromUser

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

200: OK Successful operation

{
    "message": "Investor was succesfully removed."
}

400: Bad Request Error message (example)

{
    "message": "No such investor."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

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

curl

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "removeInvestorFromUser",
    "parameters": {
        "investor_identifier": "650126-1234",
        "user_identifier": "9c809eb86ee6"
        }
    }