nav_title | article_title | alias | search_tag | page_order | layout | page_type | description |
---|---|---|---|---|---|---|---|
GET: Look Up an Existing Dashboard User Account |
GET: Look Up an Existing Dashboard User Account |
/get_see_user_account_information/ |
Endpoint |
4 |
api_page |
reference |
This article outlines details about the Look up an existing dashboard user account Braze endpoint. |
{% api %}
{% apimethod get %} /scim/v2/Users/{id} {% endapimethod %}
Use this endpoint to look up an existing dashboard user account by specifying the resource
id
returned by the SCIMPOST
method.
{% apiref postman %}https://documenter.getpostman.com/view/4689407/SVYrsdsG?version=latest#3df40764-8f74-4532-aed3-ab8a6cb92122 {% endapiref %}
To use this endpoint, you'll need a SCIM token. For more information, refer to Automated user provisioning.
{% multi_lang_include rate_limits.md endpoint='look up dashboard user' %}
Parameter | Required | Data Type | Description |
---|---|---|---|
id |
Required | String | The user's resource ID. This parameter is returned by the POST /scim/v2/Users/ or GET /scim/v2/Users?filter=userName eq "user@test.com" methods. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4} |
Content-Type: application/json
X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
Authorization: Bearer YOUR-REST-API-KEY
curl --location --request GET 'https://rest.iad-01.braze.com/scim/v2/Users/dfa245b7-24195aec-887bb3ad-602b3340' \
--header 'Content-Type: application/json' \
--header 'X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE' \
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"id": "dfa245b7-24195aec-887bb3ad-602b3340",
"userName": "user@test.com",
"name": {
"givenName": "Test",
"familyName": "User"
},
"department": "finance",
"lastSignInAt": "Thursday, January 1, 1970 12:00:00 AM",
"permissions": {
"companyPermissions": ["manage_company_settings"],
"appGroup": [
{
"appGroupId": "241adcd25789fabcded",
"appGroupName": "Test Workspace",
"appGroupPermissions": ["basic_access","send_campaigns_canvases"],
"team": [
{
"teamId": "241adcd25789fabcded",
"teamName": "Test Team",
"teamPermissions": ["admin"]
}
]
}
]
}
}
{% endapi %}