Skip to content

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

get

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

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

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

/scim/v2/Users?filter=userName%20eq%20%[email protected]%22

See me in Postman

前提条件

このエンドポイントを使用するには、SCIMトークンが必要です。X-Request-OriginヘッダーとしてサービスOriginを使用します。詳細については、自動ユーザープロビジョニングを参照してください。

レート制限

このエンドポイントには、1日あたり1会社あたり5,000リクエストのレート制限があります。このレート制限は、APIレート制限に記載されているように、/scim/v2/Users/ PUT、GET、DELETE、およびPOSTエンドポイントと共有されます。

クエリパラメーター

パラメーター 必須 データタイプ 説明
filter 必須 文字列 メールアドレスで検索するためのSCIMフィルター式。Brazeは userName eq "[email protected]" のみをサポートしています。メールの値はダブルクォーテーションで囲む必要があります。

リクエストパラメーター

1
2
3

Content-Type: application/json
X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
Authorization: Bearer YOUR-SCIM-TOKEN-HERE

リクエスト例

1
2
3
4

curl --location --request GET \ 'https://rest.iad-01.braze.com/scim/v2/Users?filter=userName%20eq%20%[email protected]%22' \
--header 'Content-Type: application/json' \
--header 'X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE' \
--header 'Authorization: Bearer YOUR-SCIM-TOKEN-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
34

{
    "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",
            "createdAt": "2024 Nov 11, 4:20 PM",
            "lastSignInAt": "N/A",
            "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"]
                            }
                        ]
                    }
                ]
            }
        }
    ]
}

レスポンスパラメーター

パラメーター データタイプ 説明
schemas 文字列の配列 SCIMリストレスポンススキーマ。
totalResults 整数 一致するダッシュボードユーザーの数（一致しない場合は0）。
Resources 配列 ユーザーオブジェクトの配列。各オブジェクトはGET: 既存のダッシュボードユーザーアカウントの検索と同じフィールドを使用します。

ユーザーオブジェクトフィールド

パラメーター データタイプ 説明
id 文字列 ユーザーのリソースID。
userName 文字列 ユーザーのメールアドレス。
name オブジェクト givenName と familyName を含みます。
department 文字列 ユーザーの部署（設定されている場合）。
createdAt 文字列 ユーザーアカウントが作成された日時。未設定の場合は N/A を返します。それ以外は YYYY Mon DD, H:MM AM/PM の形式です。
lastSignInAt 文字列 ユーザーが最後にサインインした日時。ユーザーがサインインしたことがない場合は N/A を返します。それ以外は YYYY Mon DD, H:MM AM/PM の形式です。
permissions オブジェクト 会社、ワークスペース、チーム、およびロールの権限。権限オブジェクトを参照してください。

エラーステータス

filter パラメーターが欠落しているか不正な形式の場合、エンドポイントは以下を返します。

1
2
3
4
5
6
7
8

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
  "status": 400,
  "detail": "Request is unparsable, syntactically incorrect, or violates schema."
}
New Stuff!