既存のダッシュボードのユーザーアカウントをEメールで検索する
get
scim/v2/Users?filter=userName%20eq%20”user%40test.com”
このエンドポイントを使用して、フィルタークエリーパラメーターにメールを指定して、既存のダッシュボードユーザーアカウントを検索します。
クエリーパラメーターがURLエンコードされている場合、次のようになることに注意:
/scim/v2/Users?filter=userName%20eq%20%[email protected]%22
前提条件
このエンドポイントを使うには、SCIMトークンが必要だ。詳細については、「自動ユーザープロビジョニング」を参照してください。
レート制限
パスパラメーター
パラメータ | 必須 | データ型 | 説明 |
---|---|---|---|
[email protected] |
必須 | 文字列 | ユーザーのEメール。 |
リクエストパラメーター
1
2
3
Content-Type: application/json
X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
Authorization: Bearer YOUR-REST-API-KEY
例のリクエスト
1
2
3
4
curl --location --request GET \ 'https://rest.iad-01.braze.com/scim/v2/Users?filter=userName%20eq%20%22[email protected]%22' \
--header 'Content-Type: application/json' \
--header 'X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE' \
応答
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 1,
"Resources": [
{
"userName": "[email protected]",
"id": "dfa245b7-24195aec-887bb3ad-602b3340",
"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"]
}
]
}
]
}
}
]
}
New Stuff!