Skip to content

새 대시보드 사용자 계정 생성

post

/scim/v2/Users

이 엔드포인트를 사용하여 이메일, 이름과 성, 권한(회사, 워크스페이스, 팀 수준에서 권한 설정)을 지정하여 새 대시보드 사용자 계정을 생성합니다.

See me in Postman

필수 조건

이 엔드포인트를 사용하려면 SCIM 토큰이 필요합니다. 서비스 Origin을 X-Request-Origin 헤더로 사용합니다. 자세한 내용은 자동화된 사용자 프로비저닝을 참조하세요.

사용량 제한

이 엔드포인트는 회사당 일일 20,000건의 요청 제한이 적용됩니다. 이 사용량 제한은 API 사용량 제한에 설명된 대로 /scim/v2/Users/ PUT, GET 및 DELETE 엔드포인트와 공유됩니다.

요청 본문

1
2
3

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

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
35
36
37
38
39
40

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "userName": "[email protected]",
    "name": {
        "givenName": "Test",
        "familyName": "User"
    },
    "department": "finance",
    "permissions": {
        "companyPermissions": ["manage_company_settings"],
        "roles": [
            {
                "roleName": "Test Role"
            },
            {
                "roleId": "2519dafcdba238ae7"
            }
        ],
        "appGroup": [
            {
                "appGroupName": "Test Workspace",
                "appGroupPermissions": ["basic_access","send_campaigns_canvases"],
                "team": [
                    {
                         "teamName": "Test Team",
                         "teamPermissions": ["basic_access","export_user_data"]
                    }
                ]
            },
            {
                "appGroupName": "Other Test Workspace",
                "appGroupPermissionSets": [
                    {
                        "appGroupPermissionSetName":  "Test Permission Set"
                    }
                ]
            }
        ]
    }
}

요청 매개변수

매개변수 필수 데이터 유형 설명
schemas 필수 문자열 배열 사용자 오브젝트에 대한 예상 SCIM 2.0 스키마 이름입니다.
userName 필수 문자열 사용자의 이메일 주소입니다.
name 필수 JSON 오브젝트 이 오브젝트에는 사용자의 이름과 성이 포함되어 있습니다.
department 선택 사항 문자열 부서 문자열 설명서에 있는 유효한 부서 문자열입니다. 알 수 없는 경우 생략하거나 빈 문자열을 전달합니다.
permissions 선택 사항 JSON 오브젝트 권한 오브젝트 설명서에 설명된 권한 오브젝트입니다. 생략하거나 비어 있으면 Braze는 SCIM Provisioning에 구성된 기본 워크스페이스에 기본 읽기 전용 워크스페이스 권한을 할당합니다. 세분화된 권한 마이그레이션 후에는 보기 전용 워크스페이스 권한이 포함됩니다.

예시 요청

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
35
36

curl --location --request POST 'https://rest.iad-01.braze.com/scim/v2/Users' \
--header 'Content-Type: application/json' \
--header 'X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE' \
--header 'Authorization: Bearer YOUR-SCIM–TOKEN-HERE' \
--data raw '{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "userName": "[email protected]",
    "name": {
        "givenName": "Test",
        "familyName": "User"
    },
    "department": "finance",
    "permissions": {
        "companyPermissions": ["manage_company_settings"],
        "roles": [
            {
                "roleName": "Test Role"
            },
            {
                "roleId": "2519dafcdba238ae7"
            }
        ],
        "appGroup": [
            {
                "appGroupName": "Test Workspace",
                "appGroupPermissions": ["basic_access","send_campaigns_canvases"],
                "team": [
                    {
                         "teamName": "Test Team",
                         "teamPermissions": ["basic_access","export_user_data"]
                    }
                ]
            }
        ]
    }
}'

응답

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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "id": "dfa245b7-24195aec-887bb3ad-602b3340",
    "userName": "[email protected]",
    "name": {
        "givenName": "Test",
        "familyName": "User"
    },
    "department": "finance",
    "lastSignInAt": "NA",
    "createdAt": "NA",
    "permissions": {
        "companyPermissions": ["manage_company_settings"],
        "roles": [
            {
                "roleName": "Test Role",
                "roleId": "519dafcdba23dfaae7",
                "appGroup": [
                    {
                        "appGroupId": "241adcd25789fabcded",
                        "appGroupName": "Some Workspace",
                        "appGroupPermissions": ["basic_access", "publish_cards"],
                        "team": [
                            {
                                "teamId": "2519dafcdba238ae7",
                                "teamName": "Some Team",
                                "teamPermissions": ["export_user_data"]
                            }
                        ]
                    }
                ]
            },
            {
                "roleName": "Another Test Role",
                "roleId": "23125dad23dfaae7",
                "appGroup": [
                    {
                        "appGroupId": "241adcd25adfabcded",
                        "appGroupName": "Production Workspace",
                        "appGroupPermissionSets": [
                            {
                                "appGroupPermissionSetName": "A Permission Set",
                                "appGroupPermissionSetId": "dfa385109bc38",
                                "permissions": ["basic_access","publish_cards"]
                            }
                        ]
                    }
                ]
            }
        ],
        "appGroup": [
            {
                "appGroupId": "241adcd25789fabcded",
                "appGroupName": "Test Workspace",
                "appGroupPermissions": ["basic_access","send_campaigns_canvases"],
                "team": [
                    {
                         "teamId": "2519dafcdba238ae7",
                         "teamName": "Test Team",
                         "teamPermissions": ["basic_access","export_user_data"]
                    }
                ]
            },
            {
                "appGroupName": "Other Test Workspace",
                "appGroupPermissionSets": [
                    {
                        "appGroupPermissionSetName":  "Test Permission Set"
                    }
                ]
            }
        ]
    }
}

응답 매개변수

매개변수 데이터 유형 설명
schemas 문자열 배열 사용자 오브젝트에 대한 예상 SCIM 2.0 스키마 이름입니다.
userName 문자열 사용자의 이메일 주소입니다.
name JSON 오브젝트 이 오브젝트에는 사용자의 이름과 성이 포함되어 있습니다.
department 문자열 부서 문자열 설명서에 있는 유효한 부서 문자열입니다.
permissions JSON 오브젝트 권한 오브젝트 설명서에 설명된 권한 오브젝트입니다.
id 문자열 사용자 계정을 검색하고 관리하는 데 사용되는 Braze에서 생성한 ID입니다.
createdAt 문자열 사용자 계정이 생성된 날짜(UTC 기준)입니다. 설정되지 않은 경우 NA를 반환합니다.
lastSignInAt 문자열 마지막으로 성공한 로그인 날짜(UTC 기준)입니다. 사용자가 로그인한 적이 없으면 NA를 반환합니다. 형식: YYYY Mon DD, H:MM AM/PM.

오류 상태

해당 userName 또는 이메일 주소를 가진 사용자가 이미 Braze에 존재하는 경우, 엔드포인트는 다음과 같이 응답합니다:

1
2
3
4
5
6
7
8
9

HTTP/1.1 409 Conflict
Date: Tue, 10 Sep 2019 02:22:30 GMT
Content-Type: text/json;charset=UTF-8

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
  "detail": "User already exists in the database.",
  "status": 409
}
New Stuff!