Skip to content

새 대시보드 사용자 계정 만들기

post

/scim/v2/Users

이 엔드포인트를 사용하여 이메일, 주어진 이름 및 가족 이름, 권한(회사, 워크스페이스 및 팀 수준에서 권한을 설정하기 위해)을 지정하여 새 대시보드 사용자 계정을 만듭니다.

See me in Postman

필수 구성 요소

이 엔드포인트를 사용하려면 SCIM 토큰이 필요합니다. 자세한 내용은 자동 사용자 프로비저닝을 참조하세요.

사용량 제한

요청 본문

1
2
3

Content-Type: application/json
X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
Authorization: Bearer YOUR-REST-API-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

{
    "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"],
        "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 객체 권한 객체 문서에 설명된 대로 권한 객체를 만듭니다.

요청 예시

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

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-API-KEY-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"],
        "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

{
    "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": "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": "2519dafcdba238ae7",
                         "teamName": "Test Team",                  
                         "teamPermissions": ["basic_access","export_user_data"]
                    }
                ]
            } 
        ]
    }
}

응답 매개변수

매개변수 데이터 유형 설명
schemas 문자열 배열 사용자 개체에 대한 예상 SCIM 2.0 스키마 이름입니다.
userName 문자열 사용자의 이메일 주소입니다.
name JSON 객체 이 개체에는 사용자의 이름과 성이 포함되어 있습니다.
department 문자열 부서 문자열 문서에 있는 유효한 부서 문자열입니다.
permissions JSON 객체 권한 객체 문서에 설명된 대로 권한 객체를 만듭니다.
id 문자열 사용자 계정을 검색하고 관리하는 데 사용되는 Braze에서 생성한 ID입니다.
lastSignInAt 문자열 마지막으로 로그온에 성공한 날짜(UTC 시간 기준)입니다.

오류 상태

이 이메일 주소를 가진 사용자가 이미 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
}
Github   GitHub 에서 이 페이지를 편집합니다.
이 페이지가 얼마나 도움이 되었나요?
New Stuff!