Dashboard User Audit API
API reference for viewing Dashboard users for Monitor and Beacon
These endpoints are used to look up a Dashboard user, as referenced in an audit_trail
object from the Monitor or Beacon APIs.
Endpoints | |
---|---|
/dashboard_user/get | Retrieve information about Dashboard user |
/dashboard_user/list | List Dashboard users |
/dashboard_user/get
Retrieve a dashboard user
The /dashboard_user/get
endpoint provides details (such as email address) about a specific Dashboard user based on the dashboard_user_id
field, which is returned in the audit_trail
object of certain Monitor and Beacon endpoints. This can be used to identify the specific reviewer who performed a Dashboard action.
Request fields
dashboard_user_id
/dashboard_user/get
.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
client_id
. The client_id
is required and may be provided either in the PLAID-CLIENT-ID
header or as part of a request body.1const request: DashboardUserGetRequest = {2 dashboard_user_id: 'usr_1SUuwqBdK75GKi',3};4
5try {6 const response = await client.dashboardUserGet(request);7} catch (error) {8 // handle error9}
Response fields and example
id
/dashboard_user/get
.created_at
date-time
email_address
email
status
invited
, active
, deactivated
request_id
1{2 "id": "54350110fedcbaf01234ffee",3 "created_at": "2020-07-24T03:26:02Z",4 "email_address": "user@example.com",5 "status": "active",6 "request_id": "saKrIBuEB9qJZng"7}
/dashboard_user/list
List dashboard users
The /dashboard_user/list
endpoint provides details (such as email address) all Dashboard users associated with your account. This can use used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products.
Request fields
secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
client_id
. The client_id
is required and may be provided either in the PLAID-CLIENT-ID
header or as part of a request body.cursor
1try {2 const response = await client.dashboardUserList({});3} catch (error) {4 // handle error5}
Response fields and example
dashboard_users
id
/dashboard_user/get
.created_at
date-time
email_address
email
status
invited
, active
, deactivated
next_cursor
request_id
1{2 "dashboard_users": [3 {4 "id": "54350110fedcbaf01234ffee",5 "created_at": "2020-07-24T03:26:02Z",6 "email_address": "user@example.com",7 "status": "active"8 }9 ],10 "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM",11 "request_id": "saKrIBuEB9qJZng"12}