Support Users
Support Users represent your employees, with specific access to your back office and/or the Dashboard to manage your end users.
Contrary to end users, Support Users can't have Wallets, Cards, and cannot initiate of funds related operations.
Creation
Parameters
Below the attributes to create a Support User.
Attribute | Type | Description |
---|---|---|
username | string | The identifier the user will use for logging in to the Dashboard or your own back office. We strongly recommend not to change the username once set (you won't be able to do it from the Dashboard). |
password | string | The password the user will use for logging in to the Dashboard or your own back office. Expected in cleartext. |
scope | array | Set of permissions for your Support User. Learn more in the Scope & Permissions article. |
samlKey | string | Optional key to link automatically a Support User to a Dashboard OAuth2 client. |
Request
Use the following request to create a Support User.
bash
curl -X POST {baseUrl}/core-connect/support-user \
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json' \
-d '{payload}'
Here is an example of {payload}
:
json
{
"username":"im-a-support-user@company.tld",
"password":"verystrongpasswordhere"
}
Retrieval
bash
curl -X GET {baseUrl}/core-connect/support-user/{supportUserId} \
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json'
Returns the Support User object.
json
{
"id":"02c8d955-287b-4052-e278-6f1218dcdd26",
"username":"im-a-support-user@company.tld",
"samlKey":"",
"keyPairId":"",
"clients":[
{
"clientId":"e1cbb34c-ce92-4b3f-92f2-514b7365643d",
"scopes":["read_all","read_write","read_only","admin","support_user_management","legal"],
"resourceSet":[],
"lastLoginAt":"2022-01-19T13:11:26+00:00",
"acceptedAt":"2021-12-01T17:26:26+00:00"
}
],
"wrongPwdAttempts": 0,
"metadata": null
}
Update
bash
curl -X PUT {baseUrl}/core-connect/support-user/{supportUserId} \
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json' \
-d '{payload}'
Here is an example of {payload}
:
json
{
"scopes":[],
"password":"{newPassword}"
}
Returns the updated Support User object.
json
{
"id":"02c8d955-287b-4052-e278-6f1218dcdd26",
"username":"im-a-support-user@company.tld",
"samlKey":"",
"keyPairId":"",
"clients":[
{
"clientId":"e1cbb34c-ce92-4b3f-92f2-514b7365643d",
"scopes":["read_all","read_write","read_only","admin","support_user_management","legal"],
"resourceSet":[],
"lastLoginAt":"2022-01-19T13:11:26+00:00",
"acceptedAt":"2021-12-01T17:26:26+00:00"
}
],
"wrongPwdAttempts": 0,
"metadata": null
}
Unblocking
A Support User may be blocked if they made 3 wrong password attempts. They may be unblocked using the following request.
bash
curl -X DELETE {baseUrl}/core-connect/support-user/{supportUserId}/unblock \
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json'
The API returns an HTTP 204 response, without content. The wrongPwdAttempts
value is also reset to 0
for the unblocked user.
Deletion
bash
curl -X DELETE {baseUrl}/core-connect/support-user/{supportUserId} \
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json'
Answers with a 204
HTTP Status Code without any content.
Note – At least one Support User must exist
You can't delete a Support User if they are the last one with the support_user_management
scope. This ensures that at least one Support User remains able to create new ones.
Endpoints
Endpoint | Scope |
---|---|
/core-connect/support-user/{supportUserId} Retrieve a Support User | support_user_management |
/core-connect/support-user Retrieve all Support Users | support_user_management |
/core-connect/support-user Create a Support User | support_user_management |
/core-connect/support-user/{supportUserId} Update a Support User | support_user_management |
/core-connect/support-user/{supportUserId}/unblock Unblock a Support User | support_user_management |
/core-connect/support-user/{supportUserId} Delete a Support User | support_user_management |