Skip to content

Créer un nouveau compte utilisateur de tableau de bord

post

/scim/v2/Users

Utilisez cet endpoint pour créer un nouveau compte utilisateur de tableau de bord en spécifiant l’adresse e-mail, le prénom et le nom de famille, ainsi que les autorisations (pour définir les autorisations au niveau de l’entreprise, de l’espace de travail et de l’équipe).

See me in Postman

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’un jeton SCIM. Vous utiliserez l’origine de votre service comme en-tête X-Request-Origin. Pour plus d’informations, consultez la section Provisionnement automatisé des utilisateurs.

Limite de débit

Cet endpoint a une limite de débit de 20 000 requêtes par jour et par société. Cette limite de débit est partagée avec les endpoints PUT, GET et DELETE /scim/v2/Users/, comme documenté dans Limites de débit de l’API.

Corps de la requête

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"
                    }
                ]
            }
        ]
    }
}

Paramètres de requête

Paramètre Obligatoire Type de données Description
schemas Obligatoire Tableau de chaînes de caractères Nom du schéma SCIM 2.0 attendu pour l’objet utilisateur.
userName Obligatoire Chaîne de caractères L’adresse e-mail de l’utilisateur.
name Obligatoire Objet JSON Cet objet contient le prénom et le nom de famille de l’utilisateur.
department Facultatif Chaîne de caractères Chaîne de caractères valide du département, tirée de la documentation sur les chaînes de caractères du département. Omettez ce paramètre ou transmettez une chaîne vide si la valeur est inconnue.
permissions Facultatif Objet JSON Objet d’autorisations tel que décrit dans la documentation de l’objet d’autorisations. Lorsqu’il est omis ou vide, Braze attribue les autorisations d’espace de travail en lecture seule par défaut sur l’espace de travail par défaut configuré dans SCIM Provisioning. Après la migration des autorisations granulaires, cela inclut les autorisations d’espace de travail en consultation seule.

Exemple de requête

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"]
                    }
                ]
            }
        ]
    }
}'

Réponse

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"
                    }
                ]
            }
        ]
    }
}

Paramètres de réponse

Paramètre Type de données Description
schemas Tableau de chaînes de caractères Nom du schéma SCIM 2.0 attendu pour l’objet utilisateur.
userName Chaîne de caractères L’adresse e-mail de l’utilisateur.
name Objet JSON Cet objet contient le prénom et le nom de famille de l’utilisateur.
department Chaîne de caractères Chaîne de caractères valide du département, tirée de la documentation sur les chaînes de caractères du département.
permissions Objet JSON Objet d’autorisations tel que décrit dans la documentation de l’objet d’autorisations.
id Chaîne de caractères ID généré par Braze, utilisé pour rechercher et gérer les comptes utilisateurs.
createdAt Chaîne de caractères Date de création du compte utilisateur au format UTC. Renvoie NA lorsque la valeur n’est pas définie.
lastSignInAt Chaîne de caractères Date de la dernière connexion réussie au format UTC. Renvoie NA lorsque l’utilisateur ne s’est jamais connecté. Format : YYYY Mon DD, H:MM AM/PM.

États d’erreur

Si un utilisateur possédant ce userName ou cette adresse e-mail existe déjà dans Braze, l’endpoint répondra avec :

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!