Créer un nouveau compte utilisateur de tableau de bord

post

/scim/v2/Users

Utilisez ce point de terminaison pour créer un nouveau compte utilisateur de tableau de bord en spécifiant l’e-mail, les prénoms et noms de famille, 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. Pour plus d’informations, consultez la section Provisionnement automatisé des utilisateurs.

Limite de débit

Corps de la demande

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

Paramètres de demande

Paramètre	Requis	Type de données	Description
`schemas`	Requis	Tableau de chaînes de caractères	Nom du schéma SCIM 2.0 attendu pour l’objet Utilisateur.
`userName`	Requis	Chaîne de caractères	L’adresse e-mail de l’utilisateur.
`name`	Requis	Object JSON	Cet objet contient le prénom et le nom de famille de l’utilisateur.
`department`	Requis	Chaîne de caractères	Chaîne de département valide de la documentation de chaîne de département.
`permissions`	Requis	Object JSON	Objet des autorisations comme décrit dans la documentation de l’objet des autorisations.

Exemple de demande

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

Réponse

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

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`	Object JSON	Cet objet contient le prénom et le nom de famille de l’utilisateur.
`department`	Chaîne de caractères	Chaîne de département valide de la documentation de chaîne de département.
`permissions`	Object JSON	Objet des autorisations comme décrit dans la documentation de l’objet des autorisations.
`id`	Chaîne de caractères	ID généré par Braze qui est utilisé pour rechercher et gérer les comptes utilisateurs.
`lastSignInAt`	Chaîne de caractères	Date de la dernière connexion réussie en temps UTC.

États relatifs aux d’erreur

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

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
}

Modifier cette page sur GitHub

CETTE PAGE A-T-ELLE ÉTÉ UTILE?

Modifier cette page sur GitHub

New Stuff!