Ir para o conteúdo

Esta página foi traduzida automaticamente e pode conter imprecisões. Para relatar um erro de tradução, use o componente de feedback na parte inferior do sumário, à direita da página.

Criar nova conta de usuário do dashboard

post

/scim/v2/Users

Use esse endpoint para criar uma nova conta de usuário do dashboard especificando e-mail, nome e sobrenome, permissões (para definir permissões no nível da empresa, do espaço de trabalho e da equipe).

See me in Postman

Importante

Esse endpoint exige a integração SCIM personalizada. Se você configurou uma integração de provedor de identidade (IdP) (Okta ou Entra ID), não é possível usar esse endpoint; apenas uma ponte SCIM pode ser configurada por empresa.

Pré-requisitos

Para usar esse endpoint, você precisará de um token SCIM. Você usará a origin do seu serviço como o cabeçalho X-Request-Origin. Para saber mais, consulte Provisionamento automatizado de usuários.

Limite de frequência

Esse endpoint tem um limite de frequência de 20.000 solicitações por dia, por empresa. Esse limite de frequência é compartilhado com os endpoints /scim/v2/Users/ PUT, GET e DELETE, conforme documentado em Limites de frequência da API.

Corpo da solicitação

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

Parâmetros de solicitação

Parâmetro	Obrigatório	Tipo de dados	Descrição
`schemas`	Obrigatório	Array de strings	Nome do esquema SCIM 2.0 esperado para o objeto do usuário.
`userName`	Obrigatório	String	O endereço de e-mail do usuário.
`name`	Obrigatório	Objeto JSON	Esse objeto contém o nome e o sobrenome do usuário.
`department`	Opcional	String	String de departamento válida da documentação de string de departamento. Omita ou passe uma string vazia se desconhecido.
`permissions`	Opcional	Objeto JSON	Objeto de permissões, conforme descrito na documentação do objeto de permissões. Quando omitido ou vazio, a Braze atribui permissões padrão de somente leitura no espaço de trabalho padrão configurado em SCIM Provisioning. Após a migração de permissões granulares, isso inclui permissões de somente visualização no espaço de trabalho.

Exemplo de solicitação

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

Resposta

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

Parâmetros de resposta

Parâmetro	Tipo de dados	Descrição
`schemas`	Array de strings	Nome do esquema SCIM 2.0 esperado para o objeto do usuário.
`userName`	String	O endereço de e-mail do usuário.
`name`	Objeto JSON	Esse objeto contém o nome e o sobrenome do usuário.
`department`	String	String de departamento válida da documentação de string de departamento.
`permissions`	Objeto JSON	Objeto de permissões, conforme descrito na documentação do objeto de permissões.
`id`	String	ID gerado pela Braze usado para pesquisar e gerenciar contas de usuário.
`createdAt`	String	Data em que a conta de usuário foi criada, em UTC. Retorna `NA` quando não definido.
`lastSignInAt`	String	Data do último login bem-sucedido, em UTC. Retorna `NA` quando o usuário não fez login. Formato: `YYYY Mon DD, H:MM AM/PM`.

Estados de erro

Se um usuário com esse userName ou endereço de e-mail já existir na Braze, o endpoint responderá com:

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!