Skip to content

既存のダッシュボードユーザーアカウントをメールで検索

get

/scim/v2/Users?filter=userName%20eq%20user%40test.com

このエンドポイントを使用して、フィルター クエリ パラメータで電子メールを指定して、既存のダッシュボード ユーザー アカウントを検索します。

クエリ パラメータが URL エンコードされている場合は、次のように表示されます。

/scim/v2/Users?filter=userName%20eq%20%22user@test.com%22

See me in Postman

前提条件

このエンドポイントを使用するには、SCIM トークンが必要です。詳細については、「自動ユーザープロビジョニング」を参照してください。

レート制限

This endpoint has a rate limit of 5000 requests per day, per company. This rate limit is shared with the /scim/v2/Users/ PUT, GET, DELETE, and POST endpoints as documented in API rate limits.

パスパラメータ

パラメータ 必須 データ型 説明
userName@example.com 必須 文字列 ユーザーのメール。

リクエストパラメータ

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%22user@test.com%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": "user@test.com",
            "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"]
                            }
                        ]
                    } 
                ]
            }
        }
    ]
}
  GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!