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 토큰이 필요합니다. 서비스 Origin을 X-Request-Origin 헤더로 사용합니다. 자세한 내용은 자동화된 사용자 프로비저닝을 참조하세요.

사용량 제한

이 엔드포인트는 회사당 일일 20,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!